Skip to main content

Pool

@liquidium/client

@liquidium/client / Pool

Interface: Pool

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:4

Current protocol metadata and rate state for a lending pool.

Properties​

asset​

asset: string

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:8

Asset supplied to and borrowed from the pool.

availableLiquidity​

availableLiquidity: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:20

Currently available liquidity in base units.

baseRate​

baseRate: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:44

Base borrow rate, scaled by rateDecimals.

borrowCap?​

optional borrowCap?: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:24

Optional borrow cap in base units.

borrowIndex​

borrowIndex: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:54

Current borrow index.

borrowingRate​

borrowingRate: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:40

Current borrow APR, scaled by rateDecimals.

chain​

chain: string

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:10

Chain associated with the pool asset.

decimals​

decimals: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:12

Number of base-unit decimals for pool amounts.

frozen​

frozen: boolean

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:14

Whether new pool activity is currently frozen.

id​

id: string

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:6

Pool canister principal text.

lastUpdated?​

optional lastUpdated?: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:58

Last pool update timestamp when available.

lendingIndex​

lendingIndex: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:52

Current lending index.

lendingRate​

lendingRate: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:38

Current supply APR, scaled by rateDecimals.

liquidationBonus​

liquidationBonus: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:30

Liquidation bonus, scaled by rateDecimals.

liquidationThreshold​

liquidationThreshold: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:28

Liquidation threshold, scaled by rateDecimals.

maxLtv​

maxLtv: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:26

Maximum loan-to-value ratio, scaled by rateDecimals.

optimalUtilizationRate​

optimalUtilizationRate: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:46

Optimal utilization point, scaled by rateDecimals.

protocolLiquidationFee​

protocolLiquidationFee: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:32

Protocol liquidation fee, scaled by rateDecimals.

rateDecimals​

rateDecimals: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:36

Decimal scale used by rate and risk-ratio fields.

rateSlopeAfter​

rateSlopeAfter: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:50

Rate slope after optimal utilization, scaled by rateDecimals.

rateSlopeBefore​

rateSlopeBefore: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:48

Rate slope before optimal utilization, scaled by rateDecimals.

reserveFactor​

reserveFactor: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:34

Reserve factor, scaled by rateDecimals.

sameAssetBorrowing​

sameAssetBorrowing: boolean

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:56

Whether borrowing the same asset as collateral is allowed.

supplyCap?​

optional supplyCap?: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:22

Optional supply cap in base units.

totalDebt​

totalDebt: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:18

Total borrowed amount in base units.

totalSupply​

totalSupply: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:16

Total supplied amount in base units.

utilizationRate​

utilizationRate: bigint

Defined in: external/liquidium-sdk/packages/client/src/modules/market/types.ts:42

Current pool utilization, scaled by rateDecimals.