@armada/sdk / wallet / PlanTransferRequest
Interface: PlanTransferRequest
Defined in: src/wallet/index.ts:206
Properties
outputs
readonlyoutputs: readonlyobject[]
Defined in: src/wallet/index.ts:207
unshield?
readonlyoptionalunshield?:object
Defined in: src/wallet/index.ts:208
recipient
recipient:
`0x${string}`
amount
amount:
bigint
adaptParams?
optionaladaptParams?:`0x${string}`
adaptContract?
optionaladaptContract?:`0x${string}`
adaptBinding?
optionaladaptBinding?:CctpBinding
Decoded CCTP binding matching adaptParams — surfaced to the signer for destination inspection (§4.2.1).
fee?
readonlyoptionalfee?:SpendFee
Defined in: src/wallet/index.ts:222
The broadcaster fee, per proof (a split spend of k proofs pays it k times). Omit it for no in-proof fee note — a self-submitted spend, or a yield redeem whose fee the adapter pays contract-side. Pick the relayer tier that matches how the spend will be submitted; feeForOperation(quote, op) reads it from a relayer quote and throws if the tier is missing.
tokenAddress?
readonlyoptionaltokenAddress?:`0x${string}`
Defined in: src/wallet/index.ts:228
Token being spent. Defaults to the pool's USDC. Set it to spend a non-USDC shielded balance (e.g. yield vault shares on redeem) — the wallet scans all pool tokens, so any held balance is spendable. Must match the token of the selected input notes.