Interface FaucetsApiInterface

FaucetsApi - interface

Export

Interface

FaucetsApiInterface

Hierarchy

  • FaucetsApiInterface

Implemented by

Methods

runFaucetBtc runFaucetBtcRaw runFaucetStx runFaucetStxRaw

Methods

runFaucetBtc

  • Add 1 BTC token to the specified testnet BTC address. The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block. Note: This is a testnet only endpoint. This endpoint will not work on the mainnet. Add testnet BTC tokens to address

    Parameters

    Returns Promise<RunFaucetResponse>

runFaucetBtcRaw

  • Add 1 BTC token to the specified testnet BTC address. The endpoint returns the transaction ID, which you can use to view the transaction in a testnet Bitcoin block explorer. The tokens are delivered once the transaction has been included in a block. Note: This is a testnet only endpoint. This endpoint will not work on the mainnet.

    Summary

    Add testnet BTC tokens to address

    Throws

    Memberof

    FaucetsApiInterface

    Parameters

    Returns Promise<ApiResponse<RunFaucetResponse>>

runFaucetStx

  • Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with ST. If the stacking parameter is set to true, the faucet will add the required number of tokens for individual stacking to the specified testnet address. The endpoint returns the transaction ID, which you can use to view the transaction in the Stacks Explorer. The tokens are delivered once the transaction has been included in an anchor block. A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing failed faucet transactions to a testnet address, you can get help in Discord. Note: This is a testnet only endpoint. This endpoint will not work on the mainnet. Get STX testnet tokens

    Parameters

    Returns Promise<RunFaucetResponse>

runFaucetStxRaw

  • Add 500 STX tokens to the specified testnet address. Testnet STX addresses begin with ST. If the stacking parameter is set to true, the faucet will add the required number of tokens for individual stacking to the specified testnet address. The endpoint returns the transaction ID, which you can use to view the transaction in the Stacks Explorer. The tokens are delivered once the transaction has been included in an anchor block. A common reason for failed faucet transactions is that the faucet has run out of tokens. If you are experiencing failed faucet transactions to a testnet address, you can get help in Discord. Note: This is a testnet only endpoint. This endpoint will not work on the mainnet.

    Summary

    Get STX testnet tokens

    Throws

    Memberof

    FaucetsApiInterface

    Parameters

    Returns Promise<ApiResponse<RunFaucetResponse>>

Settings

Member Visibility

Theme

Generated using TypeDoc