Type alias ExternalAddressAPIClient

ExternalAddressAPIClient: {
    broadcastExternalTransaction(networkId, addressId, broadcastExternalTransactionRequest, options?): AxiosPromise<BroadcastExternalTransaction200Response>;
    getExternalAddressBalance(networkId, addressId, assetId, options?): AxiosPromise<Balance>;
    getFaucetTransaction(networkId, addressId, transactionHash, options?): AxiosPromise<FaucetTransaction>;
    listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>;
    requestExternalFaucetFunds(networkId, addressId, assetId?, skipWait?, options?): AxiosPromise<FaucetTransaction>;
}

ExternalAddressAPIClient client type definition.

Type declaration

  • broadcastExternalTransaction:function
  • getExternalAddressBalance:function
    • getExternalAddressBalance(networkId, addressId, assetId, options?): AxiosPromise<Balance>

    • Get the balance of an asset in an external address

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the balance for

      • assetId: string

        The ID of the asset to fetch the balance for

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<Balance>

      Throws

      If the request fails.

  • getFaucetTransaction:function
    • getFaucetTransaction(networkId, addressId, transactionHash, options?): AxiosPromise<FaucetTransaction>

    • Get the faucet transaction for an external address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The onchain address of the address that is being fetched.

      • transactionHash: string

        The transaction hash of the faucet transaction.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      The faucet transaction.

      Throws

      If the request fails.

  • listExternalAddressBalances:function
    • listExternalAddressBalances(networkId, addressId, page?, options?): AxiosPromise<AddressBalanceList>

    • List all of the balances of an external address

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The ID of the address to fetch the balance for

      • Optional page: string

        A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<AddressBalanceList>

      Throws

      If the request fails.

  • requestExternalFaucetFunds:function
    • requestExternalFaucetFunds(networkId, addressId, assetId?, skipWait?, options?): AxiosPromise<FaucetTransaction>

    • Request faucet funds to be sent to external address.

      Parameters

      • networkId: string

        The ID of the blockchain network

      • addressId: string

        The onchain address of the address that is being fetched.

      • Optional assetId: string

        The Optional ID of the asset to request funds for. Defaults to native asset.

      • Optional skipWait: boolean

        The Optional flag to skip waiting for the transaction to be mined. Defaults to false.

      • Optional options: RawAxiosRequestConfig

        Override http request option.

      Returns AxiosPromise<FaucetTransaction>

      Throws

      If the request fails.

Settings

Member Visibility

Theme