impermax-sdk 2.1.241 → 2.1.246

package/lib/index.d.ts

@@ -47,4 +47,5 @@ import OffchainAccountNftlpUniswapV3 from './offchain/account/lendingPool/nftlp/
 import { MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice } from "./utils/nftlpMath/uniswapV3General";
 import UniswapV3Position from './utils/position/uniswapV3';
 import UniswapV2Position from './utils/position/uniswapV2';
-export { offchain, OffchainMultichain, Offchain, OffchainLendingPool, OffchainPoolToken, OffchainCollateral, OffchainBorrowable, OffchainVault, OffchainLeveragedVault, OffchainLendingVault, OffchainHedgedVault, OffchainConfigManager, OffchainPairConfig, OffchainProposal, OffchainMultichainAccount, OffchainAccount, OffchainAccountLendingPool, OffchainAccountPoolToken, OffchainAccountCollateral, OffchainAccountBorrowable, 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, OnchainLendingPool, OnchainPoolToken, OnchainBorrowable, OnchainCollateral, OnchainLendingVault, OnchainConfigManager, OnchainProposal, OnchainPairConfig, OnchainAccount, OnchainAccountLendingPool, OnchainAccountLendingPoolV2, OnchainAccountLendingPoolV3, OnchainAccountNftlpUniswapV3, OnchainAccountPoolToken, OnchainAccountBorrowable, OnchainAccountCollateral, OnchainAccountLendingVault, OnchainContractsHelper, OnchainImpermaxFactory, OnchainInteractions, OnchainInteractionsLendingPool, OnchainInteractionsPoolToken, OnchainInteractionsCollateral, OnchainInteractionsBorrowable, 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, OnchainInteractionsLendingPoolV3, OnchainInteractionsNftlpUniswapV3, decimalToBalance, OffchainAccountLendingPoolV3, OffchainAccountNftlpUniswapV3, MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice, isV3Factory, UniswapV3Position, UniswapV2Position, OffchainAccountCollateralV2 };
+import Position from './utils/position/interface';
+export { offchain, OffchainMultichain, Offchain, OffchainLendingPool, OffchainPoolToken, OffchainCollateral, OffchainBorrowable, OffchainVault, OffchainLeveragedVault, OffchainLendingVault, OffchainHedgedVault, OffchainConfigManager, OffchainPairConfig, OffchainProposal, OffchainMultichainAccount, OffchainAccount, OffchainAccountLendingPool, OffchainAccountPoolToken, OffchainAccountCollateral, OffchainAccountBorrowable, 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, OnchainLendingPool, OnchainPoolToken, OnchainBorrowable, OnchainCollateral, OnchainLendingVault, OnchainConfigManager, OnchainProposal, OnchainPairConfig, OnchainAccount, OnchainAccountLendingPool, OnchainAccountLendingPoolV2, OnchainAccountLendingPoolV3, OnchainAccountNftlpUniswapV3, OnchainAccountPoolToken, OnchainAccountBorrowable, OnchainAccountCollateral, OnchainAccountLendingVault, OnchainContractsHelper, OnchainImpermaxFactory, OnchainInteractions, OnchainInteractionsLendingPool, OnchainInteractionsPoolToken, OnchainInteractionsCollateral, OnchainInteractionsBorrowable, 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, OnchainInteractionsLendingPoolV3, OnchainInteractionsNftlpUniswapV3, decimalToBalance, OffchainAccountLendingPoolV3, OffchainAccountNftlpUniswapV3, MAX_TICK, MIN_TICK, formatPriceSqrtX96, uniV3TickToPrice, isV3Factory, UniswapV3Position, UniswapV2Position, Position, OffchainAccountCollateralV2 };

package/lib/offchain/account/lendingPool/offchainAccountLendingPool.d.ts

@@ -17,6 +17,7 @@ export default abstract class OffchainAccountLendingPool {
     protected abstract getNewBorrowableObject(borrowable: Borrowable): OffchainAccountBorrowable;
     constructor(account: OffchainAccount, lendingPool: OffchainLendingPool);
     abstract getLendingPoolPosition(): Promise<LendingPoolPosition | undefined>;
+    abstract getLeveragedAPR(tokenId?: number): Promise<number>;
     getAccount: () => OffchainAccount;
     getLendingPool: () => OffchainLendingPool;
     getBorrowable: (borrowable: Borrowable) => OffchainAccountBorrowable;

package/lib/offchain/account/lendingPool/offchainAccountLendingPoolV2.d.ts

@@ -37,6 +37,7 @@ export default class OffchainAccountLendingPoolV2 extends OffchainAccountLending
             borrowable1: import("../../offchainTypes").BorrowPosition | undefined;
         };
     } | undefined>;
+    getLeveragedAPR(): Promise<number>;
     getLeveragedPositions(): Promise<Array<OffchainLeveragedPosition>>;
     getLeveragedPositionsTotalBalanceUSD(): Promise<number>;
     getLeveragedPositionsNetAPR(): Promise<number>;

package/lib/offchain/account/lendingPool/offchainAccountLendingPoolV2.js

@@ -57,6 +57,17 @@ class OffchainAccountLendingPoolV2 extends offchainAccountLendingPool_1.default
             },
         };
     }
+    /*--------------------------------------------------------------------------*
+     *                                Position APR                              *
+     *--------------------------------------------------------------------------*/
+    // NOTE: Should this be moved directly to position object?
+    async getLeveragedAPR() {
+        const baseAPR = await this.getLendingPool().getTotalAPR();
+        const leverage = (await this.getCollateral().getPositionObject()).getLeverage();
+        const borrowApr0 = await this.getLendingPool().getBorrowableA().getBorrowAPR();
+        const borrowApr1 = await this.getLendingPool().getBorrowableB().getBorrowAPR();
+        return baseAPR * leverage - (borrowApr0 + borrowApr1) / 2 * (leverage - 1);
+    }
     async getLeveragedPositions() {
         return [];
     }

package/lib/offchain/account/lendingPool/offchainAccountLendingPoolV3.d.ts

@@ -35,6 +35,7 @@ export default class OffchainAccountLendingPoolV3 extends OffchainAccountLending
         positions: Record<string, NftlpPosition> | undefined;
     } | undefined>;
     getTokenIds(): Promise<(string | undefined)[]>;
+    getLeveragedAPR(tokenId: number): Promise<number>;
     getLeveragedPositions(): Promise<Array<OffchainLeveragedPosition>>;
     getLeveragedPositionsTotalBalanceUSD(): Promise<number>;
     getLeveragedPositionsNetAPR(): Promise<number>;

package/lib/offchain/account/lendingPool/offchainAccountLendingPoolV3.js

@@ -64,6 +64,14 @@ class OffchainAccountLendingPoolV3 extends offchainAccountLendingPool_1.default
         const positions = userData[factory]?.positions?.[pairAddress] || [];
         return positions.map(pos => pos.tokenId);
     }
+    /*--------------------------------------------------------------------------*
+     *                                Position APR                              *
+     *--------------------------------------------------------------------------*/
+    // TODO: CL APR
+    // NOTE: Should this be moved directly to position object?
+    async getLeveragedAPR(tokenId) {
+        return 0;
+    }
     async getLeveragedPositions() {
         return [];
     }

package/lib/offchain/lendingPool/offchainLendingPool.js

@@ -69,6 +69,8 @@ class OffchainLendingPool {
             this.getBorrowableA().getTokenPriceAccurate(),
             this.getBorrowableB().getTokenPriceAccurate()
         ]);
+        console.log("Offchain priceA: %s", priceA);
+        console.log("Offchain priceB: %s", priceB);
         return priceA / priceB;
     }
     async getMarketPrice() {

package/lib/utils/position/interface.d.ts

@@ -1,7 +1,7 @@
 /**
  * Common interface to represent collateral positions across different dexes.
  */
-export interface Position {
+export default interface Position {
     readonly lockStateChange: boolean;
     state: number;
     readonly initialDebtX: number;

package/lib/utils/position/uniswapV2/index.d.ts

@@ -1,4 +1,4 @@
-import type { Position } from "../interface";
+import Position from "../interface";
 export interface UniswapV2PositionParams {
     liquidity: number;
     debtX: number;

package/lib/utils/position/uniswapV3/index.d.ts

@@ -1,4 +1,4 @@
-import type { Position } from "../interface";
+import Position from "../interface";
 /**
  * TODO: Cache for initialRealX, intialCollateralValue, etc...
  */

package/package.json

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