Class StacksTestnet

A StacksNetwork with the parameters for the Stacks testnet. 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 StacksTestnet();
const network = new StacksTestnet({ url: "https://stacks-node-api.testnet.stacks.co" });
const network = new StacksTestnet({ fetch: createFetchFn() });

createFetchFn, createApiKeyMiddleware

Hierarchy

StacksNetwork
- StacksTestnet

Constructors

constructor

new StacksTestnet(opts?): StacksTestnet
Parameters
- Optional opts: Partial<NetworkConfig>
Returns StacksTestnet
Overrides StacksNetwork.constructor
- Defined in network.ts:191

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.Testnet

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.Testnet

Methods

getAbiApiUrl

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

getAccountApiUrl

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

getAccountExtendedBalancesApiUrl

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

getBlockTimeInfoUrl

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

getBroadcastApiUrl

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

getDataVarUrl

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

getInfoUrl

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

getMapEntryUrl

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

getNameInfo

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

getPoxInfoUrl

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

getReadOnlyFunctionCallApiUrl

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

getRewardHoldersUrl

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

getRewardsTotalUrl

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

getRewardsUrl

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

getStackerInfoUrl

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

getTransactionFeeEstimateApiUrl

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

getTransferFeeEstimateApiUrl

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

isMainnet

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

Returns boolean
Inherited from StacksNetwork.isMainnet
- 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
Inherited from StacksNetwork.fromName
- Defined in network.ts:49

Class StacksTestnet

Example

Related

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional opts: Partial<NetworkConfig>

Returns StacksTestnet

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

`Optional` opts: Partial<NetworkConfig>

`Readonly` coreApiUrl

`Optional` options: any

`Optional` options: any

`Static` fromName