Class StacksNodeApi

constructor

• new StacksNodeApi(__namedParameters?): StacksNodeApi

• Parameters

  • __namedParameters: {
        fetch?: FetchFn;
        network?: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet";
        url?: string;
    } = {}

    • Optional fetch?: FetchFn

      An optional custom fetch function to override default behaviors

    • Optional network?: StacksNetwork | "mainnet" | "testnet" | "devnet" | "mocknet"

      Stacks network object (defaults to STACKS_MAINNET)

    • Optional url?: string

      The base API/node URL for the network fetch calls

  Returns StacksNodeApi

fetch

network

url

broadcastTransaction

• broadcastTransaction(transaction, attachment?): Promise<TxBroadcastResult>

• Broadcast a serialized transaction to a Stacks node (which will validate and forward to the network).

  Parameters

  • transaction: StacksTransaction

    The transaction to broadcast

  • Optional attachment: string | Uint8Array

    Optional attachment to include with the transaction

  Returns Promise<TxBroadcastResult>

  a Promise that resolves to a TxBroadcastResult object

estimateTransaction

• estimateTransaction(payload, estimatedLength?): Promise<[FeeEstimation, FeeEstimation, FeeEstimation]>

• Estimate the total transaction fee in microstacks for a Stacks transaction

  Parameters

  • payload: string

    The transaction to estimate fees for

  • Optional estimatedLength: number

    Optional argument that provides the endpoint with an estimation of the final length (in bytes) of the transaction, including any post-conditions and signatures

  Returns Promise<[FeeEstimation, FeeEstimation, FeeEstimation]>

  A promise that resolves to an array of FeeEstimate

getAbi

• getAbi(contract): Promise<ClarityAbi>

• Fetch a contract's ABI

  Parameters

  • contract: `${string}.${string}`

  Returns Promise<ClarityAbi>

  A promise that resolves to a ClarityAbi if the operation succeeds

getAccountInfo

• getAccountInfo(address): Promise<any>

• Get account status

  Parameters

  • address: string

  Returns Promise<any>

getDataVar

• getDataVar(contract, dataVarName): Promise<{
      raw: string;
      value: ClarityValue;
  }>

• Gets the value of a data-var if it exists in the given contract

  Parameters

  • contract: `${string}.${string}`

  • dataVarName: string

  Returns Promise<{
      raw: string;
      value: ClarityValue;
  }>

getExtendedAccountBalances

• getExtendedAccountBalances(address): Promise<ExtendedAccountBalances>

• Get extended account balances

  Parameters

  • address: string

  Returns Promise<ExtendedAccountBalances>

getExtendedBtcRewardHolders

• getExtendedBtcRewardHolders(address, options?): Promise<BaseErrorResponse | BurnchainRewardSlotHolderListResponse>

• Get BTC reward holders for the an address

  Parameters

  • address: string

    BTC or STX address

  • Optional options: PaginationOptions

  Returns Promise<BaseErrorResponse | BurnchainRewardSlotHolderListResponse>

getExtendedBtcRewards

• getExtendedBtcRewards(address, options?): Promise<BaseErrorResponse | BurnchainRewardListResponse>

• Get paginated BTC stacking rewards total for an address

  Parameters

  • address: string

    BTC or STX address

  • Optional options: PaginationOptions

  Returns Promise<BaseErrorResponse | BurnchainRewardListResponse>

getExtendedBtcRewardsTotal

• getExtendedBtcRewardsTotal(address): Promise<BaseErrorResponse | BurnchainRewardsTotal>

• Get the total BTC stacking rewards total for an address

  Parameters

  • address: string

    BTC or STX address

  Returns Promise<BaseErrorResponse | BurnchainRewardsTotal>

getInfo

• getInfo(): Promise<V2CoreInfoResponse>

• Get stacks node info

  Returns Promise<V2CoreInfoResponse>

getNonce

• getNonce(address): Promise<bigint>

• Lookup the nonce for an address from a core node

  Parameters

  • address: string

    The Stacks address to look up the next nonce for

  Returns Promise<bigint>

  A promise that resolves to a bigint of the next nonce

getPoxInfo

• getPoxInfo(): Promise<V2PoxInfoResponse>

• Get stacks node pox info

  Returns Promise<V2PoxInfoResponse>

getTargetBlockTime

• getTargetBlockTime(): Promise<number>

• Get stacks node target block time

  Returns Promise<number>

isMainnet

• isMainnet(): boolean

• Returns true if the network is configured to 'mainnet', based on the TransactionVersion

  Returns boolean