Class Deposits

Receive crypto directly into the workspace via permanent per-network addresses, and read the settled deposit history (scope: balances:read).

Index

Constructors

Methods

addresses chains createAddress getAddress list

Constructors

constructor

new Deposits(c: Requester): Deposits
Parameters
- c: Requester
Returns Deposits
- Defined in src/resources/deposits.ts:52

Methods

addresses

addresses(query?: PageQuery & { chain?: string }): Promise<Page<DepositAddress>>
List your minted deposit addresses (scope: balances:read). Keyset-paginated.
Parameters
- query: PageQuery & { chain?: string } = {}
  Optional chain filter + pagination (limit/before/order).
Returns Promise<Page<DepositAddress>>
The raw { items, nextCursor } page of DepositAddress.

Throws
On failure (e.g. 401/403 auth).
- Defined in src/resources/deposits.ts:81

chains

chains(): Promise<Page<DepositChain>>
List the networks you can deposit on and the coins each accepts.

Returns Promise<Page<DepositChain>>
The raw { items, nextCursor } (nextCursor always null) of DepositChain.

Throws
On failure (e.g. 401/403 missing balances:read).
- Defined in src/resources/deposits.ts:59

createAddress

createAddress(params: { chain: string }): Promise<DepositAddress>
Mint (or return the existing) permanent deposit address for a network. Idempotent — reusable and stable per network.
Parameters
- params: { chain: string }
  Options.
  - chain: string
    Network code from Deposits.chains, e.g. "ETH". Required.
Returns Promise<DepositAddress>
The DepositAddress for that network.

Throws
On failure (e.g. 422 unsupported chain, 401/403 auth).
- Defined in src/resources/deposits.ts:71

getAddress

getAddress(chain: string): Promise<DepositAddress>
Get your deposit address for a single network.
Parameters
- chain: string
  Network code, e.g. "ETH".
Returns Promise<DepositAddress>
The DepositAddress.

Throws
On failure (e.g. 404 no address minted for the chain).
- Defined in src/resources/deposits.ts:91

list

list(
query?: PageQuery & { chain?: string; from?: number; to?: number },
): Promise<Page<Deposit>>
List settled deposit history — inbound credits to the workspace (scope: balances:read). Keyset-paginated.
Parameters
- query: PageQuery & { chain?: string; from?: number; to?: number } = {}
  Filters + pagination.
  - Optionalchain?: string
    Restrict to one network. Optional.
  - Optionalfrom?: number
    Inclusive start of the window, epoch milliseconds. Optional.
  - Optionalto?: number
    Inclusive end of the window, epoch milliseconds. Optional.
Returns Promise<Page<Deposit>>
The raw { items, nextCursor } page of Deposit.

Throws
On failure (e.g. 401/403 auth).
- Defined in src/resources/deposits.ts:104