Class StacksMainnet

A StacksNetwork with the parameters for the Stacks mainnet. Pass a url option to override the default Hiro hosted Stacks node API. Pass a fetchFn option to customize the default networking functions.

Example

const network = new StacksMainnet();
const network = new StacksMainnet({ url: "https://api.mainnet.hiro.so" });
const network = new StacksMainnet({ fetch: createFetchFn() });

Related

createFetchFn, createApiKeyMiddleware

Hierarchy

Constructors

constructor

Properties

accountEndpoint bnsLookupUrl broadcastEndpoint chainId contractAbiEndpoint coreApiUrl fetchFn readOnlyFunctionCallEndpoint transactionFeeEstimateEndpoint transferFeeEstimateEndpoint version

Methods

getAbiApiUrl getAccountApiUrl getAccountExtendedBalancesApiUrl getBlockTimeInfoUrl getBroadcastApiUrl getDataVarUrl getInfoUrl getMapEntryUrl getNameInfo getPoxInfoUrl getReadOnlyFunctionCallApiUrl getRewardHoldersUrl getRewardsTotalUrl getRewardsUrl getStackerInfoUrl getTransactionFeeEstimateApiUrl getTransferFeeEstimateApiUrl isMainnet fromName

Constructors

constructor

Properties

accountEndpoint

accountEndpoint: string = '/v2/accounts'

bnsLookupUrl

bnsLookupUrl: string = 'https://api.mainnet.hiro.so'

broadcastEndpoint

broadcastEndpoint: string = '/v2/transactions'

chainId

chainId: ChainID = ChainID.Mainnet

contractAbiEndpoint

contractAbiEndpoint: string = '/v2/contracts/interface'

Readonly coreApiUrl

coreApiUrl: string

fetchFn

fetchFn: FetchFn

readOnlyFunctionCallEndpoint

readOnlyFunctionCallEndpoint: string = '/v2/contracts/call-read'

transactionFeeEstimateEndpoint

transactionFeeEstimateEndpoint: string = '/v2/fees/transaction'

transferFeeEstimateEndpoint

transferFeeEstimateEndpoint: string = '/v2/fees/transfer'

version

version: TransactionVersion = TransactionVersion.Mainnet

Methods

getAbiApiUrl

  • Parameters

    • address: string
    • contract: string

    Returns string

getAccountApiUrl

  • Parameters

    • address: string

    Returns string

getAccountExtendedBalancesApiUrl

getBlockTimeInfoUrl

getBroadcastApiUrl

getDataVarUrl

  • Parameters

    • contractAddress: string
    • contractName: string
    • dataVarName: string

    Returns string

getInfoUrl

getMapEntryUrl

  • Parameters

    • contractAddress: string
    • contractName: string
    • mapName: string

    Returns string

getNameInfo

  • Parameters

    • fullyQualifiedName: string

    Returns Promise<any>

getPoxInfoUrl

getReadOnlyFunctionCallApiUrl

  • Parameters

    • contractAddress: string
    • contractName: string
    • functionName: string

    Returns string

getRewardHoldersUrl

  • Parameters

    • address: string
    • Optional options: any

    Returns string

getRewardsTotalUrl

getRewardsUrl

  • Parameters

    • address: string
    • Optional options: any

    Returns string

getStackerInfoUrl

  • Parameters

    • contractAddress: string
    • contractName: string

    Returns string

getTransactionFeeEstimateApiUrl

getTransferFeeEstimateApiUrl

isMainnet

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

    Returns boolean

Static fromName

  • A static network constructor from a network name

    Parameters

    • networkName: "mainnet" | "testnet" | "devnet" | "mocknet"

    Returns StacksNetwork

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc