Documentation
    Preparing search index...

    Type Alias Pool

    Comprehensive pool information for lending operations

    type Pool = {
        availableBorrow: string;
        borrowCapCeiling: string;
        borrowedAmount: string;
        borrowIncentiveApyInfo: {
            apy: string;
            boostedApr: string;
            rewardCoin: string[];
            stakingYieldApy: string;
            treasuryApy: string;
            vaultApr: string;
            voloApy: string;
        };
        borrowRateFactors: {
            fields: {
                baseRate: string;
                jumpRateMultiplier: string;
                multiplier: string;
                optimalUtilization: string;
                reserveFactor: string;
            };
        };
        coinType: string;
        contract: { pool: string; reserveId: string; rewardFundId?: string };
        currentBorrowIndex: string;
        currentBorrowRate: string;
        currentSupplyIndex: string;
        currentSupplyRate: string;
        id: number;
        isIsolated: boolean;
        lastUpdateTimestamp: string;
        leftBorrowAmount: string;
        leftSupply: string;
        liquidationFactor: { bonus: string; ratio: string; threshold: string };
        ltv: string;
        minimumAmount: string;
        oracle: {
            decimal: number;
            oracleId: number;
            price: string;
            valid: boolean;
            value: string;
        };
        oracleId: number;
        suiCoinType: string;
        supplyCapCeiling: string;
        supplyIncentiveApyInfo: {
            apy: string;
            boostedApr: string;
            rewardCoin: string[];
            stakingYieldApy: string;
            treasuryApy: string;
            vaultApr: string;
            voloApy: string;
        };
        token: {
            coinType: string;
            decimals: number;
            logoURI: string;
            symbol: string;
        };
        totalBorrow: string;
        totalSupply: string;
        totalSupplyAmount: string;
        treasuryBalance: string;
        treasuryFactor: string;
        validBorrowAmount: string;
    }
    Index

    Properties

    availableBorrow borrowCapCeiling borrowedAmount borrowIncentiveApyInfo borrowRateFactors coinType contract currentBorrowIndex currentBorrowRate currentSupplyIndex currentSupplyRate id isIsolated lastUpdateTimestamp leftBorrowAmount leftSupply liquidationFactor ltv minimumAmount oracle oracleId suiCoinType supplyCapCeiling supplyIncentiveApyInfo token totalBorrow totalSupply totalSupplyAmount treasuryBalance treasuryFactor validBorrowAmount

    Properties

    availableBorrow: string

    Available borrow amount

    borrowCapCeiling: string

    Maximum borrow capacity

    borrowedAmount: string

    Currently borrowed amount

    borrowIncentiveApyInfo: {
        apy: string;
        boostedApr: string;
        rewardCoin: string[];
        stakingYieldApy: string;
        treasuryApy: string;
        vaultApr: string;
        voloApy: string;
    }

    Borrow incentive APY information

    Type declaration

    • apy: string

      Total APY

    • boostedApr: string

      Boosted APR

    • rewardCoin: string[]

      Reward coin types

    • stakingYieldApy: string

      Staking yield APY

    • treasuryApy: string

      Treasury APY

    • vaultApr: string

      Vault APR

    • voloApy: string

      Volo APY

    borrowRateFactors: {
        fields: {
            baseRate: string;
            jumpRateMultiplier: string;
            multiplier: string;
            optimalUtilization: string;
            reserveFactor: string;
        };
    }

    Borrow rate calculation factors

    coinType: string

    Coin type for this pool

    contract: { pool: string; reserveId: string; rewardFundId?: string }

    Contract addresses

    Type declaration

    • pool: string

      Pool address

    • reserveId: string

      Reserve ID

    • OptionalrewardFundId?: string

      Optional reward fund ID

    currentBorrowIndex: string

    Current borrow index

    currentBorrowRate: string

    Current borrow rate

    currentSupplyIndex: string

    Current supply index

    currentSupplyRate: string

    Current supply rate

    id: number

    Pool identifier

    isIsolated: boolean

    Whether this is an isolated pool

    lastUpdateTimestamp: string

    Last update timestamp

    leftBorrowAmount: string

    Remaining borrow capacity

    leftSupply: string

    Remaining supply capacity

    liquidationFactor: { bonus: string; ratio: string; threshold: string }

    Liquidation parameters

    Type declaration

    • bonus: string

      Liquidation bonus

    • ratio: string

      Liquidation ratio

    • threshold: string

      Liquidation threshold

    ltv: string

    Loan-to-value ratio

    minimumAmount: string

    Minimum transaction amount

    oracle: {
        decimal: number;
        oracleId: number;
        price: string;
        valid: boolean;
        value: string;
    }

    Oracle price information

    Type declaration

    • decimal: number

      Price decimal places

    • oracleId: number

      Oracle identifier

    • price: string

      Current price

    • valid: boolean

      Whether oracle is valid

    • value: string

      Oracle value

    oracleId: number

    Oracle identifier

    suiCoinType: string

    Sui coin type

    supplyCapCeiling: string

    Maximum supply capacity

    supplyIncentiveApyInfo: {
        apy: string;
        boostedApr: string;
        rewardCoin: string[];
        stakingYieldApy: string;
        treasuryApy: string;
        vaultApr: string;
        voloApy: string;
    }

    Supply incentive APY information

    Type declaration

    • apy: string

      Total APY

    • boostedApr: string

      Boosted APR

    • rewardCoin: string[]

      Reward coin types

    • stakingYieldApy: string

      Staking yield APY

    • treasuryApy: string

      Treasury APY

    • vaultApr: string

      Vault APR

    • voloApy: string

      Volo APY

    token: { coinType: string; decimals: number; logoURI: string; symbol: string }

    Token information

    Type declaration

    • coinType: string

      Coin type

    • decimals: number

      Token decimals

    • logoURI: string

      Token logo URI

    • symbol: string

      Token symbol

    totalBorrow: string

    Total borrow

    totalSupply: string

    Total supply

    totalSupplyAmount: string

    Total supply amount

    treasuryBalance: string

    Treasury balance

    treasuryFactor: string

    Treasury factor

    validBorrowAmount: string

    Valid borrow amount

    Settings

    Member Visibility

    On This Page

    Properties