useExchangeAccounts
hook provides functionality for managing exchange accounts and performing exchange-related operations. It allows users to retrieve their exchange accounts, view transaction history, and execute transfers between exchange accounts.
This hook integrates with the Dynamic SDK to handle exchange operations across different blockchain networks and exchange platforms.
Parameter | Type | Description |
---|---|---|
exchange | ExchangeKeyEnum | The exchange platform identifier (e.g., Coinbase, Binance, etc.) |
transferRequest | CreateExchangeTransferRequest | The transfer request object containing transfer details |
Field | Type | Description |
---|---|---|
to | string | The recipient address (e.g., ‘0xRecipientAddr’) |
amount | number | The amount to transfer (e.g., 0.25) |
currency | string | The currency code (e.g., ‘ETH’, ‘USDC’) |
network | string | The blockchain network (e.g., ‘ethereum’) |
description | string | Optional description of the transfer |
mfaCode | string | Optional MFA verification code |
Field | Type | Description |
---|---|---|
Returns | Promise<ExchangeTransferResponse> | A promise that resolves to the transfer response containing transfer status and details |
Field | Type | Description |
---|---|---|
id | string | Unique transfer identifier (e.g., ‘tx-1’) |
exchangeAccountId | string | ID of the exchange account used for transfer |
status | string | Transfer status (e.g., ‘pending’, ‘completed’, ‘failed’) |
amount | number | The transferred amount |
currency | string | The currency that was transferred |
createdAt | Date | Timestamp when the transfer was created |
Parameter | Type | Description |
---|---|---|
exchange | ExchangeKeyEnum | The exchange platform identifier |
accountId | string | undefined | Optional account ID to filter transactions for a specific account |
Field | Type | Description |
---|---|---|
Returns | Promise<ExchangeTransaction[]> | A promise that resolves to an array of exchange transactions |
Field | Type | Description |
---|---|---|
transactionId | string | Unique transaction identifier (e.g., ‘tx-123’) |
transactionHash | string | Blockchain transaction hash (e.g., ‘0xabc’) |
status | string | Transaction status (e.g., ‘pending’, ‘completed’, ‘failed’) |
amount | number | Transaction amount |
currency | string | Currency involved in the transaction |
createdAt | Date | Timestamp when the transaction was created |
Parameter | Type | Description |
---|---|---|
exchange | ExchangeKeyEnum | The exchange platform identifier |
Field | Type | Description |
---|---|---|
Returns | Promise<Account[]> | A promise that resolves to an array of user accounts with balance information |
Field | Type | Description |
---|---|---|
id | string | Unique account identifier (e.g., ‘acc-1’, ‘acc-2’) |
exchange | ExchangeKeyEnum | The exchange platform this account belongs to |
balances | Array<Balance> | Array of balance objects for different currencies |
Field | Type | Description |
---|---|---|
currency | string | Currency code (e.g., ‘USDC’, ‘BTC’, ‘ETH’) |
balance | number | Available balance amount |
DynamicError
with specific error codes when operations fail:
UnprocessableEntityErrorCode.InvalidTransferCurrency
: Thrown when no account is found for the specified currency during transfer operations.useInternalDynamicContext
for accessing wallet and network information