Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StacksMainnet

A StacksNetwork with default values 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://stacks-node-api.mainnet.stacks.co" });
const network = new StacksMainnet({ fetch: createFetchFn() });
related

createFetchFn, createApiKeyMiddleware

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

accountEndpoint

accountEndpoint: string = '/v2/accounts'

bnsLookupUrl

bnsLookupUrl: string = 'https://stacks-node-api.mainnet.stacks.co'

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

  • getAbiApiUrl(address: string, contract: string): string

  • Parameters

    • address: string
    • contract: string

    Returns string

getAccountApiUrl

  • getAccountApiUrl(address: string): string

getBlockTimeInfoUrl

  • getBlockTimeInfoUrl(): string

getBroadcastApiUrl

  • getBroadcastApiUrl(): string

getInfoUrl

  • getInfoUrl(): string

getNameInfo

  • getNameInfo(fullyQualifiedName: string): Promise<any>

  • Parameters

    • fullyQualifiedName: string

    Returns Promise<any>

getPoxInfoUrl

  • getPoxInfoUrl(): string

getReadOnlyFunctionCallApiUrl

  • getReadOnlyFunctionCallApiUrl(contractAddress: string, contractName: string, functionName: string): string

getRewardHoldersUrl

  • getRewardHoldersUrl(address: string, options?: any): string

getRewardsTotalUrl

  • getRewardsTotalUrl(address: string): string

getRewardsUrl

  • getRewardsUrl(address: string, options?: any): string

  • Parameters

    • address: string
    • Optional options: any

    Returns string

getStackerInfoUrl

  • getStackerInfoUrl(contractAddress: string, contractName: string): string

  • Parameters

    • contractAddress: string
    • contractName: string

    Returns string

getTransactionFeeEstimateApiUrl

  • getTransactionFeeEstimateApiUrl(): string

getTransferFeeEstimateApiUrl

  • getTransferFeeEstimateApiUrl(): string

isMainnet

  • isMainnet(): boolean

Static fromName

Static fromNameOrNetwork

Generated using TypeDoc