Skip to content

@armada/sdk / wallet / MaxUnshieldRequest

Interface: MaxUnshieldRequest ​

Defined in: src/wallet/index.ts:238

Properties ​

fee? ​

readonly optional fee?: SpendFee

Defined in: src/wallet/index.ts:240

The broadcaster fee for this unshield's one proof (the tier matching its submission path); omit for none.


tokenAddress? ​

readonly optional tokenAddress?: `0x${string}`

Defined in: src/wallet/index.ts:242

Token to unshield. Defaults to the pool's USDC.


unshield? ​

readonly optional unshield?: Omit<{ recipient: `0x${string}`; amount: bigint; adaptParams?: `0x${string}`; adaptContract?: `0x${string}`; adaptBinding?: CctpBinding; }, "amount">

Defined in: src/wallet/index.ts:244

Where the unshield goes (its adapter / CCTP binding), without the amount. Omit for a plain unshield.