Class StacksNetwork

The base class for Stacks networks. Typically used via its subclasses.

StacksMainnet, StacksTestnet, StacksDevnet, StacksMocknet

Hierarchy

StacksNetwork

Constructors

constructor

new StacksNetwork(networkConfig): StacksNetwork
Parameters
- networkConfig: NetworkConfig
Returns StacksNetwork
- Defined in network.ts:43

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

getAbiApiUrl(address, contract): string
Parameters
- address: string
- contract: string
Returns string
- Defined in network.ts:87

getAccountApiUrl

getAccountApiUrl(address): string
Parameters
- address: string
Returns string
- Defined in network.ts:83

getAccountExtendedBalancesApiUrl

getAccountExtendedBalancesApiUrl(address): string
Parameters
- address: string
Returns string
- Defined in network.ts:85

getBlockTimeInfoUrl

getBlockTimeInfoUrl(): string
Returns string
- Defined in network.ts:98

getBroadcastApiUrl

getBroadcastApiUrl(): string
Returns string
- Defined in network.ts:79

getDataVarUrl

getDataVarUrl(contractAddress, contractName, dataVarName): string
Parameters
- contractAddress: string
- contractName: string
- dataVarName: string
Returns string
- Defined in network.ts:119

getInfoUrl

getInfoUrl(): string
Returns string
- Defined in network.ts:97

getMapEntryUrl

getMapEntryUrl(contractAddress, contractName, mapName): string
Parameters
- contractAddress: string
- contractName: string
- mapName: string
Returns string
- Defined in network.ts:121

getNameInfo

getNameInfo(fullyQualifiedName): Promise<any>
Parameters
- fullyQualifiedName: string
Returns Promise<any>
- Defined in network.ts:123

getPoxInfoUrl

getPoxInfoUrl(): string
Returns string
- Defined in network.ts:99

getReadOnlyFunctionCallApiUrl

getReadOnlyFunctionCallApiUrl(contractAddress, contractName, functionName): string
Parameters
- contractAddress: string
- contractName: string
- functionName: string
Returns string
- Defined in network.ts:89

getRewardHoldersUrl

getRewardHoldersUrl(address, options?): string
Parameters
- address: string
- Optional options: any
Returns string
- Defined in network.ts:109

getRewardsTotalUrl

getRewardsTotalUrl(address): string
Parameters
- address: string
Returns string
- Defined in network.ts:107

getRewardsUrl

getRewardsUrl(address, options?): string
Parameters
- address: string
- Optional options: any
Returns string
- Defined in network.ts:100

getStackerInfoUrl

getStackerInfoUrl(contractAddress, contractName): string
Parameters
- contractAddress: string
- contractName: string
Returns string
- Defined in network.ts:116

getTransactionFeeEstimateApiUrl

getTransactionFeeEstimateApiUrl(): string
Returns string
- Defined in network.ts:81

getTransferFeeEstimateApiUrl

getTransferFeeEstimateApiUrl(): string
Returns string
- Defined in network.ts:80

isMainnet

isMainnet(): boolean
Returns true if the network is configured to 'mainnet', based on the TransactionVersion

Returns boolean
- Defined in network.ts:78

`Static` fromName

fromName(networkName): StacksNetwork
A static network constructor from a network name
Parameters
- networkName: "mainnet" | "testnet" | "devnet" | "mocknet"
Returns StacksNetwork
- Defined in network.ts:49

Class StacksNetwork

Related

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

networkConfig: NetworkConfig

Returns StacksNetwork

Properties

accountEndpoint

bnsLookupUrl

broadcastEndpoint

chainId

contractAbiEndpoint

Readonly coreApiUrl

fetchFn

readOnlyFunctionCallEndpoint

transactionFeeEstimateEndpoint

transferFeeEstimateEndpoint

version

Methods

getAbiApiUrl

Parameters

address: string

contract: string

Returns string

getAccountApiUrl

Parameters

address: string

Returns string

getAccountExtendedBalancesApiUrl

Parameters

address: string

Returns string

getBlockTimeInfoUrl

Returns string

getBroadcastApiUrl

Returns string

getDataVarUrl

Parameters

contractAddress: string

contractName: string

dataVarName: string

Returns string

getInfoUrl

Returns string

getMapEntryUrl

Parameters

contractAddress: string

contractName: string

mapName: string

Returns string

getNameInfo

Parameters

fullyQualifiedName: string

Returns Promise<any>

getPoxInfoUrl

Returns string

getReadOnlyFunctionCallApiUrl

Parameters

contractAddress: string

contractName: string

functionName: string

Returns string

getRewardHoldersUrl

Parameters

address: string

Optional options: any

Returns string

getRewardsTotalUrl

Parameters

address: string

Returns string

getRewardsUrl

Parameters

address: string

`Readonly` coreApiUrl

`Optional` options: any

`Optional` options: any

`Static` fromName