@lelantos-org/sdk / protocol / DepositPullsArgs
Interface: DepositPullsArgs<A, T>
Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:48
What depositPulls reads.
Type Parameters
| Type Parameter | Default type |
|---|---|
A extends DepositPullAsset | DepositPullAsset |
T extends TokenAmount | undefined | TokenAmount |
Properties
ceiling?
optional ceiling?: boolean;Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:70
Size the deposited asset's pull as the ceiling to authorise (depositCeiling: yield headroom) rather than the quote, as deposit signs and checks allowances. Applied before pulls of one token are summed. Defaults to false.
deposited
deposited: A;Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:50
The asset being shielded.
feeAsset
feeAsset: A;Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:52
The asset paying the relayer; deposited where none was chosen.
principal
principal: T;Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:57
The principal plus its protocol fee, in base units of deposited: the principal of depositTotals.
relayer
relayer: T;Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:63
The relayer's charge, in base units of feeAsset: the relayer of depositTotals. undefined while unknown; the ids alone then decide whether the fee is pulled separately.