impermax-sdk 2.1.264 → 2.1.266

package/lib/index.d.ts

@@ -48,6 +48,7 @@ import { MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice } from "./util
 import UniswapV3Position from './utils/position/uniswapV3';
 import UniswapV2Position from './utils/position/uniswapV2';
 import Position from './utils/position/interface';
+import { BorrowableEntity } from './utils/borrowableEntity';
 import OffchainLendingPoolV2 from './offchain/lendingPool/offchainLendingPoolV2';
 import OffchainBorrowableV2 from './offchain/lendingPool/offchainBorrowableV2';
 import OffchainCollateralV2 from './offchain/lendingPool/offchainCollateralV2';
@@ -65,4 +66,4 @@ import { OnchainNftlpUniswapV3 } from './onchain/impermaxFactory/lendingPool/nft
 import OnchainNftlp from './onchain/impermaxFactory/lendingPool/nftlp';
 import OnchainAccountNftlp from './onchain/account/lendingPool/nftlp';
 import OffchainAccountBorrowableV3 from './offchain/account/lendingPool/offchainAccountBorrowableV3';
-export { offchain, OffchainMultichain, Offchain, OffchainPoolToken, OffchainLendingPool, OffchainCollateral, OffchainBorrowable, OffchainLendingPoolV2, OffchainCollateralV2, OffchainBorrowableV2, OffchainLendingPoolV3, OffchainCollateralV3, OffchainBorrowableV3, OffchainNftlp, OffchainNftlpUniswapV3, OffchainVault, OffchainLeveragedVault, OffchainLendingVault, OffchainHedgedVault, OffchainConfigManager, OffchainPairConfig, OffchainProposal, OffchainMultichainAccount, OffchainAccount, OffchainAccountPoolToken, OffchainAccountLendingPool, OffchainAccountCollateral, OffchainAccountBorrowable, OffchainAccountLendingPoolV2, OffchainAccountCollateralV2, OffchainAccountBorrowableV2, OffchainAccountLendingPoolV3, OffchainAccountCollateralV3, OffchainAccountBorrowableV3, OffchainAccountNftlp, OffchainAccountNftlpUniswapV3, OffchainLeveragedPosition, OffchainAccountVault, OffchainPriceHelper, OffchainSolidexHelper, PoolTokenData, BorrowableData, CollateralData, BorrowablePastData, TokenData, RewardData, PairData, FarmingPoolData, LendingPoolPastData, LendingPoolData, CollateralPosition, SupplyPosition, BorrowPosition, UserData, TvlData, XimxData, LendingVaultData, VaultPosition, PairConfigData, ProposalData, ProposalMetadata, VaultRisk, VaultType, onchain, Onchain, OnchainImpermaxFactory, OnchainImpermaxFactoryV2, OnchainImpermaxFactoryV3, OnchainPoolToken, OnchainLendingPool, OnchainBorrowable, OnchainCollateral, OnchainLendingPoolV2, OnchainBorrowableV2, OnchainCollateralV2, OnchainLendingPoolV3, OnchainBorrowableV3, OnchainCollateralV3, OnchainNftlp, OnchainNftlpUniswapV3, OnchainLendingVault, OnchainConfigManager, OnchainProposal, OnchainPairConfig, OnchainAccount, OnchainAccountPoolToken, OnchainAccountLendingPool, OnchainAccountBorrowable, OnchainAccountCollateral, OnchainAccountLendingPoolV2, OnchainAccountBorrowableV2, OnchainAccountCollateralV2, OnchainAccountLendingPoolV3, OnchainAccountBorrowableV3, OnchainAccountCollateralV3, OnchainAccountNftlp, OnchainAccountNftlpUniswapV3, OnchainAccountLendingVault, OnchainContractsHelper, OnchainInteractions, OnchainInteractionsPoolToken, OnchainInteractionsLendingPool, OnchainInteractionsCollateral, OnchainInteractionsBorrowable, OnchainInteractionsLendingPoolV2, OnchainInteractionsCollateralV2, OnchainInteractionsBorrowableV2, OnchainInteractionsLendingPoolV3, OnchainInteractionsCollateralV3, OnchainInteractionsBorrowableV3, OnchainInteractionsNftlp, OnchainInteractionsNftlpUniswapV3, OnchainInteractionsLendingVault, OnchainInteractionsConfigManager, Contract, ApprovalType, PermitData, OnchainConfig, Changes, NO_CHANGES, Values, AirdropData, PendingRewardUI, CollateralConfig, BorrowableV2Config, BorrowableV3Config, PairConfig, CLAIM_AGGREGATOR, IMPERMAX_CHEF, IMX, IMPERMAX_FACTORY, getNetworkFactories, getFactoryByAddress, LENDING_VAULT_WATCHER, MERKLE_DISTRIBUTOR_IBEX, MERKLE_DISTRIBUTOR_IBEX_2, MERKLE_DISTRIBUTOR_ETH, ROUTER, SIMPLE_UNISWAP_ORACLE, WETH, MERKLE_URL_ETH, MERKLE_URL_IBEX, MERKLE_URL_IBEX_2, hrAmms, AMM_FACTORY, getAmmByFactory, AMM_SUBGRAPH_URLS, ADD_LIQUIDITY_URLS, AMM_LP_FEE, DEBANK_IDS, ETH_SYMBOL, ETH_NAME, SOLIDEX_FACTORIES, BORROW_FEE_FACTORIES, OLD_KINK_MULTIPLIER_FACTORIES, LIQUIDATION_FEE_FACTORIES, V2_FACTORIES, Farms, hrFarms, FarmIndex, STAKED_LP_FACTORY, getFarmByStakedLPFactory, NOT_SYNCED, DEADLINE, ZERO, APPROVE_AMOUNT, IMPERMAX_SUBGRAPH_URL, IMPERMAX_CHEF_SUBGRAPH_URL, BLOCKS_SUBGRAPH_URL, XIMX_SUBGRAPH_URL, Networks, Factory, Extension, PoolTokenType, Amms, Address, NetworkIndex, FactoryIndex, AddressIndex, NetworkFactoryIndex, LendingPoolIndex, AmmIndex, DistributorDetails, ProposalState, WhitelistState, VaultListOrderBy, VaultListParams, LendingPoolListOrderBy, LendingPoolListParams, SortDirection, LendingPoolVersion, PositionType, AccountPosition, PermitType, Permits, Permit, Borrowable, decimalToBalance, MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice, isV3Factory, UniswapV3Position, UniswapV2Position, Position, };
+export { offchain, OffchainMultichain, Offchain, OffchainPoolToken, OffchainLendingPool, OffchainCollateral, OffchainBorrowable, OffchainLendingPoolV2, OffchainCollateralV2, OffchainBorrowableV2, OffchainLendingPoolV3, OffchainCollateralV3, OffchainBorrowableV3, OffchainNftlp, OffchainNftlpUniswapV3, OffchainVault, OffchainLeveragedVault, OffchainLendingVault, OffchainHedgedVault, OffchainConfigManager, OffchainPairConfig, OffchainProposal, OffchainMultichainAccount, OffchainAccount, OffchainAccountPoolToken, OffchainAccountLendingPool, OffchainAccountCollateral, OffchainAccountBorrowable, OffchainAccountLendingPoolV2, OffchainAccountCollateralV2, OffchainAccountBorrowableV2, OffchainAccountLendingPoolV3, OffchainAccountCollateralV3, OffchainAccountBorrowableV3, OffchainAccountNftlp, OffchainAccountNftlpUniswapV3, OffchainLeveragedPosition, OffchainAccountVault, OffchainPriceHelper, OffchainSolidexHelper, PoolTokenData, BorrowableData, CollateralData, BorrowablePastData, TokenData, RewardData, PairData, FarmingPoolData, LendingPoolPastData, LendingPoolData, CollateralPosition, SupplyPosition, BorrowPosition, UserData, TvlData, XimxData, LendingVaultData, VaultPosition, PairConfigData, ProposalData, ProposalMetadata, VaultRisk, VaultType, onchain, Onchain, OnchainImpermaxFactory, OnchainImpermaxFactoryV2, OnchainImpermaxFactoryV3, OnchainPoolToken, OnchainLendingPool, OnchainBorrowable, OnchainCollateral, OnchainLendingPoolV2, OnchainBorrowableV2, OnchainCollateralV2, OnchainLendingPoolV3, OnchainBorrowableV3, OnchainCollateralV3, OnchainNftlp, OnchainNftlpUniswapV3, OnchainLendingVault, OnchainConfigManager, OnchainProposal, OnchainPairConfig, OnchainAccount, OnchainAccountPoolToken, OnchainAccountLendingPool, OnchainAccountBorrowable, OnchainAccountCollateral, OnchainAccountLendingPoolV2, OnchainAccountBorrowableV2, OnchainAccountCollateralV2, OnchainAccountLendingPoolV3, OnchainAccountBorrowableV3, OnchainAccountCollateralV3, OnchainAccountNftlp, OnchainAccountNftlpUniswapV3, OnchainAccountLendingVault, OnchainContractsHelper, OnchainInteractions, OnchainInteractionsPoolToken, OnchainInteractionsLendingPool, OnchainInteractionsCollateral, OnchainInteractionsBorrowable, OnchainInteractionsLendingPoolV2, OnchainInteractionsCollateralV2, OnchainInteractionsBorrowableV2, OnchainInteractionsLendingPoolV3, OnchainInteractionsCollateralV3, OnchainInteractionsBorrowableV3, OnchainInteractionsNftlp, OnchainInteractionsNftlpUniswapV3, OnchainInteractionsLendingVault, OnchainInteractionsConfigManager, Contract, ApprovalType, PermitData, OnchainConfig, Changes, NO_CHANGES, Values, AirdropData, PendingRewardUI, CollateralConfig, BorrowableV2Config, BorrowableV3Config, PairConfig, CLAIM_AGGREGATOR, IMPERMAX_CHEF, IMX, IMPERMAX_FACTORY, getNetworkFactories, getFactoryByAddress, LENDING_VAULT_WATCHER, MERKLE_DISTRIBUTOR_IBEX, MERKLE_DISTRIBUTOR_IBEX_2, MERKLE_DISTRIBUTOR_ETH, ROUTER, SIMPLE_UNISWAP_ORACLE, WETH, MERKLE_URL_ETH, MERKLE_URL_IBEX, MERKLE_URL_IBEX_2, hrAmms, AMM_FACTORY, getAmmByFactory, AMM_SUBGRAPH_URLS, ADD_LIQUIDITY_URLS, AMM_LP_FEE, DEBANK_IDS, ETH_SYMBOL, ETH_NAME, SOLIDEX_FACTORIES, BORROW_FEE_FACTORIES, OLD_KINK_MULTIPLIER_FACTORIES, LIQUIDATION_FEE_FACTORIES, V2_FACTORIES, Farms, hrFarms, FarmIndex, STAKED_LP_FACTORY, getFarmByStakedLPFactory, NOT_SYNCED, DEADLINE, ZERO, APPROVE_AMOUNT, IMPERMAX_SUBGRAPH_URL, IMPERMAX_CHEF_SUBGRAPH_URL, BLOCKS_SUBGRAPH_URL, XIMX_SUBGRAPH_URL, Networks, Factory, Extension, PoolTokenType, Amms, Address, NetworkIndex, FactoryIndex, AddressIndex, NetworkFactoryIndex, LendingPoolIndex, AmmIndex, DistributorDetails, ProposalState, WhitelistState, VaultListOrderBy, VaultListParams, LendingPoolListOrderBy, LendingPoolListParams, SortDirection, LendingPoolVersion, PositionType, AccountPosition, PermitType, Permits, Permit, Borrowable, decimalToBalance, MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice, isV3Factory, UniswapV3Position, UniswapV2Position, Position, BorrowableEntity, };

package/lib/index.js

@@ -29,7 +29,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OnchainBorrowable = exports.OnchainLendingPool = exports.OnchainPoolToken = exports.OnchainImpermaxFactoryV3 = exports.OnchainImpermaxFactoryV2 = exports.OnchainImpermaxFactory = exports.Onchain = exports.onchain = exports.VaultType = exports.VaultRisk = exports.OffchainSolidexHelper = exports.OffchainPriceHelper = exports.OffchainAccountVault = exports.OffchainLeveragedPosition = exports.OffchainAccountNftlpUniswapV3 = exports.OffchainAccountNftlp = exports.OffchainAccountBorrowableV3 = exports.OffchainAccountCollateralV3 = exports.OffchainAccountLendingPoolV3 = exports.OffchainAccountBorrowableV2 = exports.OffchainAccountCollateralV2 = exports.OffchainAccountLendingPoolV2 = exports.OffchainAccountBorrowable = exports.OffchainAccountCollateral = exports.OffchainAccountLendingPool = exports.OffchainAccountPoolToken = exports.OffchainAccount = exports.OffchainMultichainAccount = exports.OffchainProposal = exports.OffchainPairConfig = exports.OffchainConfigManager = exports.OffchainHedgedVault = exports.OffchainLendingVault = exports.OffchainLeveragedVault = exports.OffchainVault = exports.OffchainNftlpUniswapV3 = exports.OffchainNftlp = exports.OffchainBorrowableV3 = exports.OffchainCollateralV3 = exports.OffchainLendingPoolV3 = exports.OffchainBorrowableV2 = exports.OffchainCollateralV2 = exports.OffchainLendingPoolV2 = exports.OffchainBorrowable = exports.OffchainCollateral = exports.OffchainLendingPool = exports.OffchainPoolToken = exports.Offchain = exports.OffchainMultichain = exports.offchain = void 0;
 exports.getNetworkFactories = exports.IMPERMAX_FACTORY = exports.IMX = exports.IMPERMAX_CHEF = exports.CLAIM_AGGREGATOR = exports.NO_CHANGES = exports.ApprovalType = exports.OnchainInteractionsConfigManager = exports.OnchainInteractionsLendingVault = exports.OnchainInteractionsNftlpUniswapV3 = exports.OnchainInteractionsNftlp = exports.OnchainInteractionsBorrowableV3 = exports.OnchainInteractionsCollateralV3 = exports.OnchainInteractionsLendingPoolV3 = exports.OnchainInteractionsBorrowableV2 = exports.OnchainInteractionsCollateralV2 = exports.OnchainInteractionsLendingPoolV2 = exports.OnchainInteractionsBorrowable = exports.OnchainInteractionsCollateral = exports.OnchainInteractionsLendingPool = exports.OnchainInteractionsPoolToken = exports.OnchainInteractions = exports.OnchainContractsHelper = exports.OnchainAccountLendingVault = exports.OnchainAccountNftlpUniswapV3 = exports.OnchainAccountNftlp = exports.OnchainAccountCollateralV3 = exports.OnchainAccountBorrowableV3 = exports.OnchainAccountLendingPoolV3 = exports.OnchainAccountCollateralV2 = exports.OnchainAccountBorrowableV2 = exports.OnchainAccountLendingPoolV2 = exports.OnchainAccountCollateral = exports.OnchainAccountBorrowable = exports.OnchainAccountLendingPool = exports.OnchainAccountPoolToken = exports.OnchainAccount = exports.OnchainPairConfig = exports.OnchainProposal = exports.OnchainConfigManager = exports.OnchainLendingVault = exports.OnchainNftlpUniswapV3 = exports.OnchainNftlp = exports.OnchainCollateralV3 = exports.OnchainBorrowableV3 = exports.OnchainLendingPoolV3 = exports.OnchainCollateralV2 = exports.OnchainBorrowableV2 = exports.OnchainLendingPoolV2 = exports.OnchainCollateral = void 0;
 exports.PermitType = exports.PositionType = exports.LendingPoolVersion = exports.SortDirection = exports.LendingPoolListOrderBy = exports.VaultListOrderBy = exports.WhitelistState = exports.ProposalState = exports.Amms = exports.PoolTokenType = exports.Extension = exports.Factory = exports.Networks = exports.XIMX_SUBGRAPH_URL = exports.BLOCKS_SUBGRAPH_URL = exports.IMPERMAX_CHEF_SUBGRAPH_URL = exports.IMPERMAX_SUBGRAPH_URL = exports.APPROVE_AMOUNT = exports.ZERO = exports.DEADLINE = exports.NOT_SYNCED = exports.getFarmByStakedLPFactory = exports.STAKED_LP_FACTORY = exports.hrFarms = exports.Farms = exports.V2_FACTORIES = exports.LIQUIDATION_FEE_FACTORIES = exports.OLD_KINK_MULTIPLIER_FACTORIES = exports.BORROW_FEE_FACTORIES = exports.SOLIDEX_FACTORIES = exports.ETH_NAME = exports.ETH_SYMBOL = exports.DEBANK_IDS = exports.AMM_LP_FEE = exports.ADD_LIQUIDITY_URLS = exports.AMM_SUBGRAPH_URLS = exports.getAmmByFactory = exports.AMM_FACTORY = exports.hrAmms = exports.MERKLE_URL_IBEX_2 = exports.MERKLE_URL_IBEX = exports.MERKLE_URL_ETH = exports.WETH = exports.SIMPLE_UNISWAP_ORACLE = exports.ROUTER = exports.MERKLE_DISTRIBUTOR_ETH = exports.MERKLE_DISTRIBUTOR_IBEX_2 = exports.MERKLE_DISTRIBUTOR_IBEX = exports.LENDING_VAULT_WATCHER = exports.getFactoryByAddress = void 0;
-exports.UniswapV2Position = exports.UniswapV3Position = exports.isV3Factory = exports.uniV3TickToPrice = exports.formatPriceSqrtX96 = exports.MIN_TICK = exports.MAX_TICK = exports.decimalToBalance = exports.Borrowable = void 0;
+exports.BorrowableEntity = exports.UniswapV2Position = exports.UniswapV3Position = exports.isV3Factory = exports.uniV3TickToPrice = exports.formatPriceSqrtX96 = exports.MIN_TICK = exports.MAX_TICK = exports.decimalToBalance = exports.Borrowable = void 0;
 const offchain_1 = __importStar(require("./offchain"));
 exports.Offchain = offchain_1.default;
 Object.defineProperty(exports, "OffchainAccount", { enumerable: true, get: function () { return offchain_1.OffchainAccount; } });
@@ -223,6 +223,8 @@ const uniswapV3_1 = __importDefault(require("./utils/position/uniswapV3"));
 exports.UniswapV3Position = uniswapV3_1.default;
 const uniswapV2_1 = __importDefault(require("./utils/position/uniswapV2"));
 exports.UniswapV2Position = uniswapV2_1.default;
+const borrowableEntity_1 = require("./utils/borrowableEntity");
+Object.defineProperty(exports, "BorrowableEntity", { enumerable: true, get: function () { return borrowableEntity_1.BorrowableEntity; } });
 const offchainLendingPoolV2_1 = __importDefault(require("./offchain/lendingPool/offchainLendingPoolV2"));
 exports.OffchainLendingPoolV2 = offchainLendingPoolV2_1.default;
 const offchainBorrowableV2_1 = __importDefault(require("./offchain/lendingPool/offchainBorrowableV2"));

package/lib/offchain/lendingPool/offchainBorrowable.d.ts

@@ -2,9 +2,11 @@ import { BorrowablePastData, PoolTokenData } from "../offchainTypes";
 import { Address, Borrowable } from "../../config/types";
 import OffchainPoolToken from "../offchainPoolToken";
 import OffchainLendingPool from "./offchainLendingPool";
+import { BorrowableEntity } from "../../utils/borrowableEntity";
 export default class OffchainBorrowable extends OffchainPoolToken {
     protected readonly lendingPool: OffchainLendingPool;
     protected readonly borrowable: Borrowable;
+    createBorrowableObject(lockStateChange?: boolean): Promise<BorrowableEntity>;
     private _accrueInterest;
     private _calculateBorrowRate;
     constructor(lendingPool: OffchainLendingPool, borrowable: Borrowable);
@@ -25,28 +27,11 @@ export default class OffchainBorrowable extends OffchainPoolToken {
     getBorrowRate(useStored?: boolean): Promise<number>;
     getBorrowAPR(): Promise<number>;
     getNextBorrowRate(borrowAmount: number): Promise<number>;
-    getNextBorrowAPR(borrowAmount: number): Promise<number>;
     getSupply(): Promise<number>;
     getSupplyUSD(): Promise<number>;
     getUtilizationRate(): Promise<number>;
     getSupplyRate(useStored?: boolean): Promise<number>;
     getSupplyAPR(): Promise<number>;
-    getNextSupplyRate(supplyAmount: number): Promise<number>;
-    getNextSupplyAPR(supplyAmount: number): Promise<number>;
-    getFarmingRewardsRate(): Promise<Array<{
-        rewardToken: string;
-        rewardRate: number;
-    }>>;
-    getFarmingRewards(): Promise<Array<{
-        APR: number;
-        symbol: string;
-    }>>;
-    getNextFarmingRewards(borrowAmount: number): Promise<Array<{
-        APR: number;
-        symbol: string;
-    }>>;
-    getFarmingAPR(): Promise<number>;
-    getNextFarmingAPR(borrowAmount: number): Promise<number>;
     getPoolTokenDataPast24h(): Promise<BorrowablePastData | undefined>;
     getPoolTokenDataPast7d(): Promise<BorrowablePastData | undefined>;
     private getAverageBorrowAPR;

package/lib/offchain/lendingPool/offchainBorrowable.js

@@ -4,9 +4,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../utils");
-const imxes_1 = require("../../config/contracts/imxes");
 const offchainPoolToken_1 = __importDefault(require("../offchainPoolToken"));
+const borrowableEntity_1 = require("../../utils/borrowableEntity");
 class OffchainBorrowable extends offchainPoolToken_1.default {
+    async createBorrowableObject(lockStateChange = false) {
+        const { kinkBorrowRate } = await this._calculateBorrowRate();
+        return new borrowableEntity_1.BorrowableEntity({
+            totalSupply: await this.getSupply(),
+            totalBorrows: await this.getTotalBorrows(),
+            kinkBorrowRate,
+            kinkUtilizationRate: await this.getKinkUtilizationRate(),
+            kinkMultiplier: await this.lendingPool.getKinkMultiplier(),
+            reserveFactor: await this.getReserveFactor(),
+            lockStateChange,
+        });
+    }
     // Simulates `accrueInterest` from `BInterestRateModel.sol`
     async _accrueInterest() {
         const [totalBalance, borrows, index, accrualTimestamp, borrowRate] = await Promise.all([
@@ -164,10 +176,6 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
         const kinkMultiplier = this.lendingPool.getKinkMultiplier();
         return (((UR - kinkUR) / (1 - kinkUR)) * (kinkMultiplier - 1) + 1) * kinkBR;
     }
-    async getNextBorrowAPR(borrowAmount) {
-        const borrowRate = await this.getNextBorrowRate(borrowAmount);
-        return (0, utils_1.toAPR)(borrowRate);
-    }
     // Supply
     async getSupply() {
         const { totalBalance, totalBorrows } = await this._accrueInterest();
@@ -196,111 +204,6 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
         const supplyRate = await this.getSupplyRate();
         return (0, utils_1.toAPR)(supplyRate);
     }
-    async getNextSupplyRate(supplyAmount) {
-        const { totalBalance, totalBorrows } = await this._accrueInterest();
-        const supply = totalBalance + totalBorrows;
-        const UR = totalBorrows / (supply + supplyAmount);
-        const { kinkBorrowRate: kinkBR } = await this._calculateBorrowRate();
-        const kinkUR = await this.getKinkUtilizationRate();
-        const reserveFactor = await this.getReserveFactor();
-        if (UR < kinkUR)
-            return (UR / kinkUR) * kinkBR * UR * (1 - reserveFactor);
-        const kinkMultiplier = this.lendingPool.getKinkMultiplier();
-        return ((((UR - kinkUR) / (1 - kinkUR)) * (kinkMultiplier - 1) + 1) *
-            kinkBR *
-            UR *
-            (1 - reserveFactor));
-    }
-    async getNextSupplyAPR(supplyAmount) {
-        const supplyRate = await this.getNextSupplyRate(supplyAmount);
-        return (0, utils_1.toAPR)(supplyRate);
-    }
-    // Reward Speed
-    async getFarmingRewardsRate() {
-        const poolTokenData = (await this.getPoolTokenData());
-        const rewards = poolTokenData.rewards;
-        if (rewards && rewards.length > 0)
-            return rewards;
-        const FINISH_DELAY = 3600 * 24;
-        const farmingPoolData = poolTokenData.farmingPool;
-        if (farmingPoolData === null)
-            return [];
-        const segmentLength = parseInt(farmingPoolData.segmentLength);
-        const epochAmount = parseFloat(farmingPoolData.epochAmount);
-        const epochBegin = parseInt(farmingPoolData.epochBegin);
-        const epochEnd = epochBegin + segmentLength;
-        const timestamp = new Date().getTime() / 1000;
-        if (timestamp - FINISH_DELAY > epochEnd) {
-            // How to manage better this case? Maybe check shares on distributor
-            return [];
-        }
-        return [
-            {
-                rewardToken: imxes_1.IMX[this.getOffchain().network],
-                rewardRate: epochAmount / segmentLength,
-            },
-        ];
-    }
-    // Farming
-    async getFarmingRewards() {
-        return this.getNextFarmingRewards(0);
-    }
-    async getNextFarmingRewards(borrowAmount) {
-        const farmingRewards = await this.getFarmingRewardsRate();
-        const currentBorrowedUSD = await this.getTotalBorrowsUSD();
-        const tokenPrice = await this.getTokenPriceFast();
-        const additionalBorrowsUSD = borrowAmount * tokenPrice;
-        const totalBorrowedUSD = currentBorrowedUSD + additionalBorrowsUSD;
-        if (totalBorrowedUSD === 0)
-            return [];
-        const rewards = [];
-        for (const reward of farmingRewards) {
-            const rewardPrice = await this.getOffchain()
-                .getPriceHelper()
-                .getDebankTokenPrice(this.getOffchain().network, reward.rewardToken);
-            rewards.push({
-                APR: (0, utils_1.toAPR)((rewardPrice * reward.rewardRate) / totalBorrowedUSD),
-                symbol: reward.rewardToken == "0x98878b06940ae243284ca214f92bb71a2b032b8a"
-                    ? "WMOVR"
-                    : reward.rewardToken == "0x0d500b1d8e8ef31e21c99d1db9a6444d3adf1270"
-                        ? "WMATIC"
-                        : reward.rewardToken ==
-                            "0x6659a9c5cd313974343e30b4fdffd95bd4b4dcd2"
-                            ? "IMX"
-                            : reward.rewardToken ==
-                                "0x7b35ce522cb72e4077baeb96cb923a5529764a00"
-                                ? "IMX"
-                                : reward.rewardToken ==
-                                    "0x60bb3d364b765c497c8ce50ae0ae3f0882c5bd05"
-                                    ? "IMX"
-                                    : reward.rewardToken ==
-                                        "0x9c67ee39e3c4954396b9142010653f17257dd39c"
-                                        ? "IMX"
-                                        : reward.rewardToken ==
-                                            "0xea6887e4a9cda1b77e70129e5fba830cdb5cddef"
-                                            ? "IMX"
-                                            : reward.rewardToken ==
-                                                "0x900f1Ec5819FA087d368877cD03B265Bf1802667"
-                                                ? "IMX"
-                                                : reward.rewardToken ==
-                                                    "0xea38f1ccf77bf43f352636241b05dd8f6f5f52b2"
-                                                    ? "IMX"
-                                                    : "IBEX",
-            });
-        }
-        return rewards;
-    }
-    async getFarmingAPR() {
-        return this.getNextFarmingAPR(0);
-    }
-    async getNextFarmingAPR(borrowAmount) {
-        const rewards = await this.getNextFarmingRewards(borrowAmount);
-        let APR = 0;
-        for (const reward of rewards) {
-            APR += reward.APR;
-        }
-        return APR;
-    }
     // Past Data
     async getPoolTokenDataPast24h() {
         const lendingPoolDataPast = await this.lendingPool.getLendingPoolDataPast24h();

package/lib/onchain/impermaxFactory/lendingPool/onchainBorrowable.d.ts

@@ -3,6 +3,7 @@ import { Address, Borrowable } from '../../../config/types';
 import OnchainLendingPool from './index';
 import OnchainPoolToken from '../../onchainPoolToken';
 import OffchainBorrowable from '../../../offchain/lendingPool/offchainBorrowable';
+import { BorrowableEntity } from "../../../utils/borrowableEntity";
 export default abstract class OnchainBorrowable extends OnchainPoolToken {
     protected readonly lendingPool: OnchainLendingPool;
     protected readonly borrowable: Borrowable;
@@ -18,5 +19,6 @@ export default abstract class OnchainBorrowable extends OnchainPoolToken {
     protected abstract initializePoolToken(): Promise<Contract>;
     protected initializeToken(): Promise<Contract>;
     isETH(): Promise<boolean>;
+    createBorrowableObject(lockStateChange?: boolean): Promise<BorrowableEntity>;
     getAvailableToBorrow(): Promise<number>;
 }

package/lib/onchain/impermaxFactory/lendingPool/onchainBorrowable.js

@@ -35,6 +35,9 @@ class OnchainBorrowable extends onchainPoolToken_1.default {
         const underlying = (await this.getToken())._address;
         return (underlying.toLowerCase() === weths_1.WETH[this.getLendingPool().getImpermaxFactory().getOnchain().network].toLowerCase());
     }
+    async createBorrowableObject(lockStateChange = false) {
+        return (await this.getOffchainBorrowable()).createBorrowableObject(lockStateChange);
+    }
     async getAvailableToBorrow() {
         return await this.getTotalBalance();
     }

package/lib/utils/{borrowable → borrowableEntity}/index.d.ts

@@ -1,21 +1,25 @@
-export interface BorrowableParams {
+export interface BorrowableEntityParams {
     totalSupply: number;
     totalBorrows: number;
-    kinkRate: number;
+    kinkBorrowRate: number;
     kinkUtilizationRate: number;
     kinkMultiplier: number;
     reserveFactor: number;
+    lockStateChange?: boolean;
 }
-export declare class Borrowable {
+export declare class BorrowableEntity {
+    lockStateChange: boolean;
+    state: number;
     totalSupply: number;
     initialTotalSupply: number;
     totalBorrows: number;
     initialTotalBorrows: number;
-    kinkRate: number;
+    kinkBorrowRate: number;
     kinkUtilizationRate: number;
     kinkMultiplier: number;
     reserveFactor: number;
-    constructor(params: BorrowableParams);
+    constructor(params: BorrowableEntityParams);
+    protected checkLock(): void;
     /**
      * PUBLIC GETTERS
      */

package/lib/utils/{borrowable → borrowableEntity}/index.js

@@ -1,17 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Borrowable = void 0;
+exports.BorrowableEntity = void 0;
 const index_1 = require("../index");
-class Borrowable {
+class BorrowableEntity {
     constructor(params) {
         this.totalSupply = params.totalSupply;
         this.initialTotalSupply = params.totalSupply;
         this.totalBorrows = params.totalBorrows;
         this.initialTotalBorrows = params.totalBorrows;
-        this.kinkRate = params.kinkRate;
+        this.kinkBorrowRate = params.kinkBorrowRate;
         this.kinkUtilizationRate = params.kinkUtilizationRate;
         this.kinkMultiplier = params.kinkMultiplier;
         this.reserveFactor = params.reserveFactor;
+        this.lockStateChange = params.lockStateChange ?? true;
+        this.state = 0;
+    }
+    checkLock() {
+        if (this.lockStateChange)
+            throw Error("Can't change state of original position object");
+        else
+            this.state++;
     }
     /**
      * PUBLIC GETTERS
@@ -26,6 +34,7 @@ class Borrowable {
             return 0;
         return this.totalBorrows / this.totalSupply;
     }
+    // TODO implement debt ceiling
     getInitialAvailableToBorrow() {
         return this.initialTotalSupply - this.initialTotalBorrows;
     }
@@ -41,11 +50,11 @@ class Borrowable {
     getBorrowRate() {
         const utilizationRate = this.getUtilizationRate();
         if (utilizationRate <= this.kinkUtilizationRate) {
-            return this.kinkRate * utilizationRate / this.kinkUtilizationRate;
+            return this.kinkBorrowRate * utilizationRate / this.kinkUtilizationRate;
         }
         else {
             const overUtil = (utilizationRate - this.kinkUtilizationRate) / (1 - this.kinkUtilizationRate);
-            return this.kinkRate * ((this.kinkMultiplier - 1) * overUtil + 1);
+            return this.kinkBorrowRate * ((this.kinkMultiplier - 1) * overUtil + 1);
         }
     }
     getSupplyRate() {
@@ -61,9 +70,11 @@ class Borrowable {
      * PUBLIC SETTERS
      */
     supply(amount) {
+        this.checkLock();
         this.totalSupply = this.initialTotalSupply + amount;
     }
     withdraw(amount) {
+        this.checkLock();
         if (amount > this.getInitialAvailableToWithdraw()) {
             throw new Error("Trying to withdraw more than available liquidity");
         }
@@ -72,6 +83,7 @@ class Borrowable {
         }
     }
     borrow(amount) {
+        this.checkLock();
         if (amount > this.getInitialAvailableToBorrow()) {
             throw new Error("Trying to borrow more than available liquidity");
         }
@@ -80,7 +92,8 @@ class Borrowable {
         }
     }
     repay(amount) {
+        this.checkLock();
         this.totalBorrows = Math.max(this.initialTotalBorrows - amount, 0);
     }
 }
-exports.Borrowable = Borrowable;
+exports.BorrowableEntity = BorrowableEntity;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "impermax-sdk",
-  "version": "2.1.264",
+  "version": "2.1.266",
   "description": "",
   "main": "./lib/index.js",
   "module": "./lib/index.js",