Lelantos SDK

Appearance

@lelantos-org/sdk / advanced / AssetInfoWithMeta

Interface: AssetInfoWithMeta ​

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:66

An asset whose ERC-20 decimals is known, as parseAmount / formatAmount require. Narrow with hasTokenMeta, or assert with requireTokenMeta.

Extends ​

Properties ​

decimals ​

ts
decimals: number;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:67

ERC-20 decimals, from the same sources as symbol; undefined when neither has them.

Overrides ​

AssetInfo.decimals

depositBps ​

ts
depositBps: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:26

Protocol fee on the shield leg, in basis points, charged on top of the principal. Per-asset, and independent of AssetInfo.withdrawBps, which is deducted rather than added.

Inherited from ​

AssetInfo.depositBps

disabled ​

ts
disabled: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:20

Owner-flipped. Disabled assets block new deposits; existing notes stay spendable.

Inherited from ​

AssetInfo.disabled

id ​

ts
id: AssetId;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:14

MASP registry id — the asset argument on every wallet method.

Inherited from ​

AssetInfo.id

index ​

ts
index: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:42

Pool-managed yield index, RAY-scaled, RAY when the pool reports none. A fixed circuit amount is worth more token units as the index grows, so withdrawal denominations are circuit-unit integers, not human amounts.

Inherited from ​

AssetInfo.index

ladder ​

ts
ladder: Ladder;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:59

Withdrawal denominations for this asset, ascending, derived from its scale and decimals; [] only when the wallet opted out via WalletConfig.denominations.

Inherited from ​

AssetInfo.ladder

rate? ​

ts
optional rate?: YieldRate;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:53

The pair the pool divides by to value a unit, for sizing a payment.

Present only for a yield asset the source has priced. index is floored on chain, so a charge converted through it can fall below what the contract takes. A yielding asset without rate cannot be quoted: scale is off by whatever the venue has earned.

Inherited from ​

AssetInfo.rate

scale ​

ts
scale: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:18

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

Inherited from ​

AssetInfo.scale

symbol? ​

ts
optional symbol?: string;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:34

From chain.tokenMeta or the relayer's list; undefined when neither supplies it.

Inherited from ​

AssetInfo.symbol

token ​

ts
token: EvmAddress;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:16

ERC-20 contract address backing the id.

Inherited from ​

AssetInfo.token

withdrawBps ​

ts
withdrawBps: bigint;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:32

Protocol fee on the unshield leg, in basis points, deducted from the gross leaving the pool, so a withdrawal of publicOut delivers less than publicOut. See withdrawNetFor (@lelantos-org/sdk/protocol).

Inherited from ​

AssetInfo.withdrawBps

yieldEnabled ​

ts
yieldEnabled: boolean;

Defined in: @lelantos-org/sdk/dist/wallet/assets/info.d.ts:44

Whether the pool routes this asset to a yield venue.

Inherited from ​

AssetInfo.yieldEnabled