@lelantos-org/sdk / protocol / YieldStateInfo
Interface: YieldStateInfo
Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:129
What a yield asset is currently worth, and under what terms.
Decimal strings throughout; every one of these exceeds u53.
Properties
gross
gross: string;Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:133
Venue position plus the pool's idle balance, in token base units.
halted
halted: boolean;Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:147
The venue is not being supplied. Existing backing is unaffected: the asset degrades to zero-yield custody, still fully backed.
index
index: string;Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:142
gross * RAY / (supply * scale), for display.
Floored on chain, so it must not be used to size a payment; convert with gross and supply, as the pool does.
supply
supply: string;Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:135
Units outstanding: note holders plus the treasury's unswept fee.
venue
venue: string;Defined in: @lelantos-org/sdk/dist/protocol/responses.d.ts:131
Venue holding the position. Bound once at registration and immutable.