Lelantos SDK

Appearance

@lelantos-org/sdk / protocol / DepositPulls

Interface: DepositPulls<A, T> ​

Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:73

A deposit's pulls, per asset as the pool requests them and per token.

Type Parameters ​

Type ParameterDefault type
A extends DepositPullAssetDepositPullAsset
T extends TokenAmount | undefinedTokenAmount

Properties ​

byAsset ​

ts
byAsset: DepositPullEntry<A, T>[];

Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:90

The pulls as the pool requests them, the Permit2 batch permit's entries: the deposited asset's first (the relayer note included when it rides along), then the fee asset's exactly when separateFee is set.

byToken ​

ts
byToken: DepositPullEntry<A, T>[];

Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:95

byAsset summed per distinct token, the deposited token first: what each public balance and Permit2 allowance must cover.

feeSharesToken ​

ts
feeSharesToken: boolean;

Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:84

The fee is drawn from the deposited token's balance and allowance: it rides in the principal's pull, or is another id over the same ERC-20.

separateFee ​

ts
separateFee: A | undefined;

Defined in: @lelantos-org/sdk/dist/protocol/deposit-pulls.d.ts:79

The asset paying the relayer when the pool pulls its fee on its own, or undefined when the fee rides in the principal's pull: paid in the deposited asset, or zero (isSameFeeAsset).