Lelantos SDK

Appearance

@lelantos-org/sdk / protocol / DepositTotalsArgs

Interface: DepositTotalsArgs ​

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:138

The inputs of depositTotal, plus where the relayer note is priced.

Extends ​

  • DepositTotalArgs

Properties ​

depositBps ​

ts
depositBps: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:103

The asset's deposit rate.

Inherited from ​

ts
DepositTotalArgs.depositBps

feeAssetId ​

ts
feeAssetId: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:148

Registry id of the fee asset: publicAssetId when the fee is in the deposited asset.

feeIn ​

ts
feeIn: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:101

Value of the relayer's fee note, in circuit units.

Inherited from ​

ts
DepositTotalArgs.feeIn

feeScale? ​

ts
optional feeScale?: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:144

The fee asset's scale. Required when the pool pulls the note separately, unread otherwise. The pool accepts only a plain asset there, so the note is priced at feeIn * feeScale, never through a yield rate.

publicAssetId ​

ts
publicAssetId: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:146

Registry id of the deposited asset.

publicIn ​

ts
publicIn: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:99

Principal, in circuit units.

Inherited from ​

ts
DepositTotalArgs.publicIn

rate? ​

ts
optional rate?: YieldRate;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:109

Required when yieldEnabled; see YieldRate.

Inherited from ​

ts
DepositTotalArgs.rate

scale ​

ts
scale: bigint;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:105

circuit-units → ERC-20-base-units multiplier.

Inherited from ​

ts
DepositTotalArgs.scale

yieldEnabled? ​

ts
optional yieldEnabled?: boolean;

Defined in: @lelantos-org/sdk/dist/protocol/fees.d.ts:107

Whether the pool routes this asset to a yield venue. Defaults to false.

Inherited from ​

ts
DepositTotalArgs.yieldEnabled