@lelantos-org/sdk / index / TransferOptions

Interface: TransferOptions

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:172

Extends

• SpendOptions

Properties

amount

amount: Amount;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:175

Value of the recipient's note.

---

asset

asset: AssetRef;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:173

---

autoConsolidate?

optional autoConsolidate?: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:92

On INSUFFICIENT_COVER, merge notes with a self-spend and retry once. Default false.

Inherited from

SpendOptions.autoConsolidate

---

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

SpendOptions.deadline

---

feeAsset?

optional feeAsset?: AssetRef;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:81

Asset paying the relayer. Default: the asset being spent. Another asset needs its own input note and change slot, and must be quoted by the relayer (FEE_ASSET_NOT_QUOTED).

Inherited from

SpendOptions.feeAsset

---

maxFee?

optional maxFee?: Amount;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:88

The most the relayer may be paid for this spend, in the fee asset. A dearer quote rejects with FEE_ABOVE_LIMIT before proving. Default: no limit beyond WalletConfig.acceptRelayerFee. A consolidation autoConsolidate runs first pays its own fee, which only acceptRelayerFee bounds.

Inherited from

SpendOptions.maxFee

---

memo?

optional memo?: string;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:183

Text for the recipient, encrypted with the note: at most 128 bytes as UTF-8, without U+0000.

The wallet keeps no copy and cannot read it back from the chain. A payment proof for the transfer needs the same text, and shows it to whoever verifies the proof.

---

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	SpendPhase
info	PhaseInfo

Returns

void

Inherited from

SpendOptions.onPhase

---

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

SpendOptions.opId

---

recipient

recipient: ShieldedAddressLike;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:176

---

selection?

optional selection?: SelectionOptions;

Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:90

Same rules spendableMax takes, so a predicted maximum and the spend agree.

Inherited from

SpendOptions.selection

---

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.

Inherited from

SpendOptions.signal