Function AddressesApiAxiosParamCreator

Returns {
    createAddress: ((walletId, createAddressRequest?, options?) => Promise<RequestArgs>);
    createPayloadSignature: ((walletId, addressId, createPayloadSignatureRequest?, options?) => Promise<RequestArgs>);
    getAddress: ((walletId, addressId, options?) => Promise<RequestArgs>);
    getAddressBalance: ((walletId, addressId, assetId, options?) => Promise<RequestArgs>);
    getPayloadSignature: ((walletId, addressId, payloadSignatureId, options?) => Promise<RequestArgs>);
    listAddressBalances: ((walletId, addressId, page?, options?) => Promise<RequestArgs>);
    listAddresses: ((walletId, limit?, page?, options?) => Promise<RequestArgs>);
    listPayloadSignatures: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>);
    requestFaucetFunds: ((walletId, addressId, assetId?, options?) => Promise<RequestArgs>);
}

• createAddress: ((walletId, createAddressRequest?, options?) => Promise<RequestArgs>)

  Create a new address scoped to the wallet.

  Summary

  Create a new address

  Throws

  • • (walletId, createAddressRequest?, options?): Promise<RequestArgs>

    • Parameters

      • walletId: string

        The ID of the wallet to create the address in.
      • Optional createAddressRequest: CreateAddressRequest
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createPayloadSignature: ((walletId, addressId, createPayloadSignatureRequest?, options?) => Promise<RequestArgs>)

  Create a new payload signature with an address.

  Summary

  Create a new payload signature.

  Throws

  • • (walletId, addressId, createPayloadSignatureRequest?, options?): Promise<RequestArgs>

    • Parameters

      • walletId: string

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

        The onchain address of the address to sign the payload with.
      • Optional createPayloadSignatureRequest: CreatePayloadSignatureRequest
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getAddress: ((walletId, addressId, options?) => Promise<RequestArgs>)

  Get address

  Summary

  Get address by onchain address

  Throws

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

    • Parameters

      • walletId: string

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

        The onchain address of the address that is being fetched.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getAddressBalance: ((walletId, addressId, assetId, options?) => Promise<RequestArgs>)

  Get address balance

  Summary

  Get address balance for asset

  Throws

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

    • Parameters

      • walletId: string

        The ID of the wallet to fetch the balance for
      • addressId: string

        The onchain address of the address that is being fetched.
      • assetId: string

        The symbol of the asset to fetch the balance for
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPayloadSignature: ((walletId, addressId, payloadSignatureId, options?) => Promise<RequestArgs>)

  Get payload signature.

  Summary

  Get payload signature.

  Throws

  • • (walletId, addressId, payloadSignatureId, options?): Promise<RequestArgs>

    • Parameters

      • walletId: string

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

        The onchain address of the address that signed the payload.
      • payloadSignatureId: string

        The ID of the payload signature to fetch.
      • Optional options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• listAddressBalances: ((walletId, addressId, page?, options?) => Promise<RequestArgs>)

  Get address balances

  Summary

  Get all balances for address

  Throws

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

    • Parameters

      • walletId: string

        The ID of the wallet to fetch the balances for
      • addressId: string

        The onchain address of the address that is being fetched.
      • 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>

• listAddresses: ((walletId, limit?, page?, options?) => Promise<RequestArgs>)

  List addresses in the wallet.

  Summary

  List addresses in a wallet.

  Throws

  • • (walletId, limit?, page?, options?): Promise<RequestArgs>

    • Parameters

      • walletId: string

        The ID of the wallet whose addresses to fetch
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
      • 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>

• listPayloadSignatures: ((walletId, addressId, limit?, page?, options?) => Promise<RequestArgs>)

  List payload signatures for an address.

  Summary

  List payload signatures for an address.

  Throws

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

    • Parameters

      • walletId: string

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

        The onchain address of the address whose payload signatures to fetch.
      • Optional limit: number

        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
      • 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>

• requestFaucetFunds: ((walletId, addressId, assetId?, options?) => Promise<RequestArgs>)

  Request faucet funds to be sent to onchain address.

  Summary

  Request faucet funds for onchain address.

  Deprecated

  Throws

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

    • Parameters

      • walletId: 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 options: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>