@lelantos-org/sdk / index / DepositOptions
Interface: DepositOptions
Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:109
Extends
Properties
amount
amount: Amount;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:115
The principal that becomes the shielded note (publicIn). The protocol fee is charged on top and the relayer's fee is pulled alongside; quoteDeposit states both.
asset
asset: AssetRef;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:110
deadline?
optional deadline?: bigint;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:64
Unix seconds.
- deposit: the Permit2 signature and escrow deadline (default now + 1 h);
- swap: bound into the intent; the wrapper refunds after it (default now + 15 min);
- transfer / withdraw: a client-side cut-off checked before submitting (
DEADLINE_PASSED).
Inherited from
feeAsset?
optional feeAsset?: AssetRef;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:120
Asset paying the relayer's fee note. Default asset. Refused (INVALID_ARGUMENT) with native, and for a yield asset other than asset; see depositFeeAssetRefusal.
native?
optional native?: boolean;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:124
Send the native coin through NativeAdapter; asset must be the wrapped coin.
onPhase?
optional onPhase?: (phase, info) => void;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:57
Progress. A throwing callback is logged and swallowed.
Parameters
| Parameter | Type |
|---|---|
phase | DepositPhase |
info | PhaseInfo |
Returns
void
Inherited from
opId?
optional opId?: string;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:69
Correlation id for this call, 1–64 chars of [A-Za-z0-9_:.-]. Default: minted by the SDK. Local only: it appears in results, phases, errors and logs, and is never sent to a service.
Inherited from
recipient?
optional recipient?: ShieldedAddressLike;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:122
Shielded owner of the new note. Default: this wallet.
signal?
optional signal?: AbortSignal;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:55
Checked between every step; the operation then rejects with signal.reason as-is. An abort after a spend was handed to the relayer does not unsend it: the SDK waits for the answer or reports SPEND_OUTCOME_UNKNOWN.