Class ExternalAddressesApi

ExternalAddressesApi - object-oriented interface

Export

ExternalAddressesApi

Hierarchy (view full)

Implements

Constructors

constructor

Properties

axios basePath configuration

Methods

broadcastExternalTransaction broadcastExternalTransfer createExternalTransfer getExternalAddressBalance getExternalTransfer getFaucetTransaction listExternalAddressBalances requestExternalFaucetFunds

Constructors

constructor

Properties

Protected axios

axios: AxiosInstance = globalAxios

Protected basePath

basePath: string = BASE_PATH

Protected configuration

configuration: undefined | Configuration

Methods

broadcastExternalTransaction

broadcastExternalTransfer

  • broadcastExternalTransfer(networkId, addressId, transferId, broadcastExternalTransferRequest, options?): Promise<AxiosResponse<Transfer, any>>

  • Broadcast an external address's transfer with a signed payload

    Parameters

    • networkId: string

      The ID of the network the address belongs to

    • addressId: string

      The ID of the address the transfer belongs to

    • transferId: string

      The ID of the transfer to broadcast

    • broadcastExternalTransferRequest: BroadcastExternalTransferRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Broadcast an external address' transfer

    Throws

    Memberof

    ExternalAddressesApi

createExternalTransfer

  • createExternalTransfer(networkId, addressId, createExternalTransferRequest, options?): Promise<AxiosResponse<Transfer, any>>

  • Create a new transfer between addresses.

    Parameters

    • networkId: string

      The ID of the network the address is on

    • addressId: string

      The ID of the address to transfer from

    • createExternalTransferRequest: CreateExternalTransferRequest
    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Create a new transfer

    Throws

    Memberof

    ExternalAddressesApi

getExternalAddressBalance

  • getExternalAddressBalance(networkId, addressId, assetId, options?): Promise<AxiosResponse<Balance, any>>

  • 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 Promise<AxiosResponse<Balance, any>>

    Summary

    Get the balance of an asset in an external address

    Throws

    Memberof

    ExternalAddressesApi

getExternalTransfer

  • getExternalTransfer(networkId, addressId, transferId, options?): Promise<AxiosResponse<Transfer, any>>

  • Get an external address' transfer by ID

    Parameters

    • networkId: string

      The ID of the network the address is on

    • addressId: string

      The ID of the address the transfer belongs to

    • transferId: string

      The ID of the transfer to fetch

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<Transfer, any>>

    Summary

    Get a external address' transfer

    Throws

    Memberof

    ExternalAddressesApi

getFaucetTransaction

  • getFaucetTransaction(networkId, addressId, txHash, options?): Promise<AxiosResponse<FaucetTransaction, any>>

  • Get the status of a faucet transaction

    Parameters

    • networkId: string

      The ID of the blockchain network

    • addressId: string

      The ID of the address to fetch the faucet transaction for

    • txHash: string

      The hash of the faucet transaction

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FaucetTransaction, any>>

    Summary

    Get the status of a faucet transaction

    Throws

    Memberof

    ExternalAddressesApi

listExternalAddressBalances

  • listExternalAddressBalances(networkId, addressId, page?, options?): Promise<AxiosResponse<AddressBalanceList, any>>

  • 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&#39;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 Promise<AxiosResponse<AddressBalanceList, any>>

    Summary

    Get the balances of an external address

    Throws

    Memberof

    ExternalAddressesApi

requestExternalFaucetFunds

  • requestExternalFaucetFunds(networkId, addressId, assetId?, skipWait?, options?): Promise<AxiosResponse<FaucetTransaction, any>>

  • Request faucet funds to be sent to external address.

    Parameters

    • networkId: string

      The ID of the wallet the address belongs to.

    • addressId: string

      The onchain address of the address that is being fetched.

    • Optional assetId: string

      The ID of the asset to transfer from the faucet.

    • Optional skipWait: boolean

      Whether to skip waiting for the transaction to be mined. This will become the default behavior in the future.

    • Optional options: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<AxiosResponse<FaucetTransaction, any>>

    Summary

    Request faucet funds for external address.

    Throws

    Memberof

    ExternalAddressesApi

Settings

Member Visibility

Theme

On This Page

constructoraxiosbasePathconfigurationbroadcastExternalTransactionbroadcastExternalTransfercreateExternalTransfergetExternalAddressBalancegetExternalTransfergetFaucetTransactionlistExternalAddressBalancesrequestExternalFaucetFunds