Lelantos SDK

Appearance

@lelantos-org/sdk / index / TransferOptions

Interface: TransferOptions ​

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

Shielded transfer. Throws InsufficientCoverError if no 1- or 2-note cover exists, unless autoConsolidate: true.

Properties ​

amount ​

ts
amount: AmountLike;

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

asset? ​

ts
optional asset?: AssetRef;

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

Id, token address or symbol. Default asset 1.

autoConsolidate? ​

ts
optional autoConsolidate?: boolean;

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

feeAsset? ​

ts
optional feeAsset?: AssetRef;

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

Asset to pay the relayer's shielded fee in. Defaults to the asset being moved.

A different asset costs two extra slots — an input note of that asset and an output for its change — so it needs a circuit shape wide enough to hold them: nOut >= 4, which the default 4×4 satisfies and a narrower pool on TRANSACT_3X3 does not. The relayer must also accept it: /chains publishes the list, and one it does not quote is rejected before any proving starts.

onPhase? ​

ts
optional onPhase?: OnPhase<SpendPhase>;

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

selectOpts? ​

ts
optional selectOpts?: SelectOpts;

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

to ​

ts
to: ShieldedAddressLike;

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

Recipient shielded address.