Function ExternalAddressesApiAxiosParamCreator

Returns {
    broadcastExternalTransaction: ((networkId, addressId, broadcastExternalTransactionRequest, options?) => Promise<RequestArgs>);
    broadcastExternalTransfer: ((networkId, addressId, transferId, broadcastExternalTransferRequest, options?) => Promise<RequestArgs>);
    createExternalTransfer: ((networkId, addressId, createExternalTransferRequest, options?) => Promise<RequestArgs>);
    getExternalAddressBalance: ((networkId, addressId, assetId, options?) => Promise<RequestArgs>);
    getExternalTransfer: ((networkId, addressId, transferId, options?) => Promise<RequestArgs>);
    getFaucetTransaction: ((networkId, addressId, txHash, options?) => Promise<RequestArgs>);
    listExternalAddressBalances: ((networkId, addressId, page?, options?) => Promise<RequestArgs>);
    requestExternalFaucetFunds: ((networkId, addressId, assetId?, skipWait?, options?) => Promise<RequestArgs>);
}

• broadcastExternalTransaction: ((networkId, addressId, broadcastExternalTransactionRequest, options?) => Promise<RequestArgs>)

  Broadcast an arbitrary transaction to the node constructed and signed by an external address.

  Summary

  Broadcast an arbitrary transaction.

  Throws

  • • (networkId, addressId, broadcastExternalTransactionRequest, options?): Promise<RequestArgs>

    • Parameters

      • networkId: string

        The ID of the network the external address belongs to.
      • addressId: string

        The onchain address of the transaction sender.
      • broadcastExternalTransactionRequest: BroadcastExternalTransactionRequest
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• broadcastExternalTransfer: ((networkId, addressId, transferId, broadcastExternalTransferRequest, options?) => Promise<RequestArgs>)

  Broadcast an external address's transfer with a signed payload

  Summary

  Broadcast an external address' transfer

  Throws

  • • (networkId, addressId, transferId, broadcastExternalTransferRequest, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• createExternalTransfer: ((networkId, addressId, createExternalTransferRequest, options?) => Promise<RequestArgs>)

  Create a new transfer between addresses.

  Summary

  Create a new transfer

  Throws

  • • (networkId, addressId, createExternalTransferRequest, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getExternalAddressBalance: ((networkId, addressId, assetId, options?) => Promise<RequestArgs>)

  Get the balance of an asset in an external address

  Summary

  Get the balance of an asset in an external address

  Throws

  • • (networkId, addressId, assetId, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getExternalTransfer: ((networkId, addressId, transferId, options?) => Promise<RequestArgs>)

  Get an external address' transfer by ID

  Summary

  Get a external address' transfer

  Throws

  • • (networkId, addressId, transferId, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getFaucetTransaction: ((networkId, addressId, txHash, options?) => Promise<RequestArgs>)

  Get the status of a faucet transaction

  Summary

  Get the status of a faucet transaction

  Throws

  • • (networkId, addressId, txHash, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• listExternalAddressBalances: ((networkId, addressId, page?, options?) => Promise<RequestArgs>)

  List all of the balances of an external address

  Summary

  Get the balances of an external address

  Throws

  • • (networkId, addressId, page?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• requestExternalFaucetFunds: ((networkId, addressId, assetId?, skipWait?, options?) => Promise<RequestArgs>)

  Request faucet funds to be sent to external address.

  Summary

  Request faucet funds for external address.

  Throws

  • • (networkId, addressId, assetId?, skipWait?, options?): Promise<RequestArgs>

    • 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<RequestArgs>