All services on this page use the authenticated transport and accept the account scope field.
Methods marked stream return () => void and take onEvent (+ optional onOpen / onClose / onError).
client.deposit
| Method | Input → Result | Notes |
|---|---|---|
createAddress(input, options?) | chain + account? → DepositAddress | null | Creates or returns the existing address. |
listAddresses(input?, options?) | chain?, account? → DepositAddress[] |
client.transfers
Ledger transfer history — every balance movement, regardless of cause.
| Method | Input → Result | Notes |
|---|---|---|
list(input, options?) | limit?, direction, time range, transfer-code and ledger filters, pageToken? → { transfers, nextPageToken } | |
subscribe(input) | accountId → stream of transfers |
client.internalTransfers
| Method | Input → Result | Notes |
|---|---|---|
create(input, options?) | destination (root / subaccount / smart account), asset, decimal amount → CreateInternalTransferResult | Idempotent — repeat requests return the existing transfer. |
Resolve destinations with client.accounts.resolve(...) or the address book's listTransferDestinations().
client.tradingWithdraws
Durable, signed withdrawal intents out of the Trading venue.
| Method | Input → Result | Notes |
|---|---|---|
createToFunding(input, options?) | asset, decimal amount, destination + signature → CreateTradingWithdrawResult | Stays on Polyester. |
createToExternalChain(input, options?) | asset, gross decimal amount, destination network + address + signature → CreateTradingWithdrawResult | Leaves via the Zipper. |
Each intent embeds a ~5-minute deadline, a nonce, and an idempotency key. Signing options:
walletSigner— the SDK builds and signs the EIP-712 payload with the user's wallet.payloadSignature— you precomputed the signature (API-key / custody infrastructure).
Related
- Supported chains, assets, routes, fees, and minimums:
client.zipperandcatalog.zipper— see Market data services and Catalog & precision. - Tracking a deposit/withdrawal across chains:
client.lifecycle— Deposits & withdrawals. - Guard-signer co-signing for protected actions: Account services.
- On-chain user operations from the smart account:
@polyester/sdk/smart-account— Client configuration.