Lelantos SDK

Appearance

@lelantos-org/sdk / advanced / AssetEntry

Interface: AssetEntry ​

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:3

Properties ​

depositBps ​

ts
depositBps: bigint;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:16

Protocol fee on the shield leg, in basis points. Per-asset, and independent of AssetEntry.withdrawBps.

disabled ​

ts
disabled: boolean;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:11

Set by the pool owner. A disabled asset blocks new deposits; existing notes and escrows remain spendable.

index ​

ts
index: bigint;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:23

Pool-managed yield index, RAY-scaled. RAY for a plain asset, at which every conversion reduces to plain scale arithmetic.

rate? ​

ts
optional rate?: YieldRate;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:39

The pool's own { gross, supply } ratio, for sizing a payment.

Present only for a yield asset on an adapter that reads it. index is floored on chain, so converting a charge through it can land below what the contract takes, and a Permit2 maxTotal signed off that figure is refused; the pool itself divides by this pair. Absent on a plain asset, where scale alone is exact.

scale ​

ts
scale: bigint;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:6

Multiplier from circuit units to ERC-20 base units.

token ​

ts
token: EvmAddress;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:4

withdrawBps ​

ts
withdrawBps: bigint;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:18

Protocol fee on the unshield leg, in basis points.

yieldEnabled ​

ts
yieldEnabled: boolean;

Defined in: @lelantos-org/sdk/dist/chain/types.d.ts:29

Whether the pool routes this asset's balance to a yield venue. Changes which unit space the withdraw fee is charged in, so it is not derivable from index alone: a freshly enabled asset sits at exactly RAY.