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

accountEndpoint: string = '/v2/accounts'
bnsLookupUrl: string = 'https://stacks-node-api.mainnet.stacks.co'
broadcastEndpoint: string = '/v2/transactions'
chainId: ChainID = ChainID.Mainnet
contractAbiEndpoint: string = '/v2/contracts/interface'
coreApiUrl: string
fetchFn: FetchFn
readOnlyFunctionCallEndpoint: string = '/v2/contracts/call-read'
transactionFeeEstimateEndpoint: string = '/v2/fees/transaction'
transferFeeEstimateEndpoint: string = '/v2/fees/transfer'
version: TransactionVersion = TransactionVersion.Mainnet

Methods

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

    • address: string
    • contract: string

    Returns string

  • getAccountApiUrl(address: string): string
  • getBlockTimeInfoUrl(): string
  • getBroadcastApiUrl(): string
  • getInfoUrl(): string
  • getNameInfo(fullyQualifiedName: string): Promise<any>
  • Parameters

    • fullyQualifiedName: string

    Returns Promise<any>

  • getPoxInfoUrl(): string
  • getReadOnlyFunctionCallApiUrl(contractAddress: string, contractName: string, functionName: string): string
  • getRewardHoldersUrl(address: string, options?: any): string
  • getRewardsTotalUrl(address: string): string
  • getRewardsUrl(address: string, options?: any): string
  • Parameters

    • address: string
    • Optional options: any

    Returns string

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

    • contractAddress: string
    • contractName: string

    Returns string

  • getTransactionFeeEstimateApiUrl(): string
  • getTransferFeeEstimateApiUrl(): string
  • isMainnet(): boolean

Generated using TypeDoc