fetchNonce

Looks up the next nonce for an address from a Stacks node.


Usage

import { fetchNonce } from '@stacks/transactions';

const nonce = await fetchNonce({
  address: 'ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM',
  network: 'testnet',
});

console.log(nonce); // e.g. 42n

Notes

  • Returns a bigint representing the next nonce for the address.

  • The builder functions (makeSTXTokenTransfer, makeContractCall, etc.) call this automatically when nonce is not provided.

  • Tries the Hiro API's /extended/v1/address/{address}/nonces endpoint first, then falls back to the core node's /v2/accounts/{address} endpoint.

Reference Linkarrow-up-right


Signature


Returns

Promise<bigint>

A promise that resolves to the next nonce for the address.


Parameters

opts.address (required)

  • Type: string

The Stacks address to look up the next nonce for.

opts.network (optional)

  • Type: StacksNetworkName | StacksNetwork

The network to query. Defaults to 'mainnet'.

opts.client (optional)

  • Type: NetworkClient

Custom client configuration for the API call.

Last updated

Was this helpful?