Function AddressesApiFp

Returns {
    createAddress(walletId, createAddressRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Address>)>;
    createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>;
    getAddress(walletId, addressId, options?): Promise<((axios?, basePath?) => AxiosPromise<Address>)>;
    getAddressBalance(walletId, addressId, assetId, options?): Promise<((axios?, basePath?) => AxiosPromise<Balance>)>;
    getPayloadSignature(walletId, addressId, payloadSignatureId, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>;
    listAddressBalances(walletId, addressId, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>;
    listAddresses(walletId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<AddressList>)>;
    listPayloadSignatures(walletId, addressId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignatureList>)>;
    requestFaucetFunds(walletId, addressId, assetId?, options?): Promise<((axios?, basePath?) => AxiosPromise<FaucetTransaction>)>;
}

• createAddress:function

  • createAddress(walletId, createAddressRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<Address>)>

  • Create a new address scoped to the wallet.

    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<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Create a new address

    Throws

• createPayloadSignature:function

  • createPayloadSignature(walletId, addressId, createPayloadSignatureRequest?, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>

  • Create a new payload signature with an address.

    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<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>

    Summary

    Create a new payload signature.

    Throws

• getAddress:function

  • getAddress(walletId, addressId, options?): Promise<((axios?, basePath?) => AxiosPromise<Address>)>

  • Get address

    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<((axios?, basePath?) => AxiosPromise<Address>)>

    Summary

    Get address by onchain address

    Throws

• getAddressBalance:function

  • getAddressBalance(walletId, addressId, assetId, options?): Promise<((axios?, basePath?) => AxiosPromise<Balance>)>

  • Get address balance

    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<((axios?, basePath?) => AxiosPromise<Balance>)>

    Summary

    Get address balance for asset

    Throws

• getPayloadSignature:function

  • getPayloadSignature(walletId, addressId, payloadSignatureId, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>

  • Get payload signature.

    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<((axios?, basePath?) => AxiosPromise<PayloadSignature>)>

    Summary

    Get payload signature.

    Throws

• listAddressBalances:function

  • listAddressBalances(walletId, addressId, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

  • Get address balances

    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<((axios?, basePath?) => AxiosPromise<AddressBalanceList>)>

    Summary

    Get all balances for address

    Throws

• listAddresses:function

  • listAddresses(walletId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<AddressList>)>

  • List addresses in the wallet.

    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<((axios?, basePath?) => AxiosPromise<AddressList>)>

    Summary

    List addresses in a wallet.

    Throws

• listPayloadSignatures:function

  • listPayloadSignatures(walletId, addressId, limit?, page?, options?): Promise<((axios?, basePath?) => AxiosPromise<PayloadSignatureList>)>

  • List payload signatures for an address.

    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<((axios?, basePath?) => AxiosPromise<PayloadSignatureList>)>

    Summary

    List payload signatures for an address.

    Throws

• requestFaucetFunds:function

  • requestFaucetFunds(walletId, addressId, assetId?, options?): Promise<((axios?, basePath?) => AxiosPromise<FaucetTransaction>)>

  • Request faucet funds to be sent to onchain address.

    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<((axios?, basePath?) => AxiosPromise<FaucetTransaction>)>

    Summary

    Request faucet funds for onchain address.

    Deprecated

    Throws