@lelantos-org/sdk / index / SwapOptions
Interface: SwapOptions
Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:201
Extends
Properties
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
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: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
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
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
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
quote
quote: SwapQuote;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:203
From quoteSwap. Its assets, amount, route and minOut are what the proof binds.
recipient?
optional recipient?: ShieldedAddressLike;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:205
Shielded owner of the output note. Default: this wallet.
refundAddress?
optional refundAddress?: EvmAddressLike;Defined in: @lelantos-org/sdk/dist/wallet/types/options.d.ts:210
EVM account a failed swap refunds to, bound into the intent. Default: this wallet's EOA, else the relayer's advertised refund address.
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
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.