impermax-sdk 2.1.30 → 2.1.32

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

@@ -5,6 +5,8 @@ import OffchainLendingPool from './offchainLendingPool';
 export default class OffchainBorrowable extends OffchainPoolToken {
     private readonly lendingPool;
     private readonly poolTokenType;
+    private _accrueInterest;
+    private _calculateBorrowRate;
     constructor(lendingPool: OffchainLendingPool, poolTokenType: PoolTokenType);
     getOffchain: () => import("..").default;
     getLendingPool: () => OffchainLendingPool;
@@ -18,14 +20,12 @@ export default class OffchainBorrowable extends OffchainPoolToken {
     getBorrowIndex(): Promise<number>;
     getAccrualTimestamp(): Promise<number>;
     getTotalBorrows(): Promise<number>;
-    getCurrentTotalBorrows(): Promise<number>;
     getTotalBorrowsUSD(): Promise<number>;
     getBorrowRate(): Promise<number>;
     getBorrowAPR(): Promise<number>;
     getNextBorrowRate(borrowAmount: number): Promise<number>;
     getNextBorrowAPR(borrowAmount: number): Promise<number>;
     getSupply(): Promise<number>;
-    getCurrentSupply(): Promise<number>;
     getSupplyUSD(): Promise<number>;
     getUtilizationRate(): Promise<number>;
     getSupplyRate(): Promise<number>;

package/lib/offchain/lendingPool/offchainBorrowable.js

@@ -16,6 +16,82 @@ const utils_1 = require("../../utils");
 const imxes_1 = require("../../config/contracts/imxes");
 const offchainPoolToken_1 = __importDefault(require("../offchainPoolToken"));
 class OffchainBorrowable extends offchainPoolToken_1.default {
+    // Simulates `accrueInterest` from `BInterestRateModel.sol`
+    _accrueInterest() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const [totalBalance, borrows, index, accrualTimestamp, borrowRate] = yield Promise.all([
+                this.getPoolTokenParamFloat("totalBalance"),
+                this.getPoolTokenParamFloat("totalBorrows"),
+                this.getPoolTokenParamFloat("borrowIndex"),
+                this.getPoolTokenParamFloat("accrualTimestamp"),
+                this.getPoolTokenParamFloat("borrowRate"),
+            ]);
+            const timeElapsed = Date.now() / 1000 - accrualTimestamp;
+            if (timeElapsed === 0)
+                return {
+                    totalBalance,
+                    totalBorrows: borrows,
+                    borrowIndex: index,
+                    timeElapsed,
+                    interest: 0,
+                };
+            const interestFactor = borrowRate * timeElapsed;
+            const interest = interestFactor * borrows;
+            const totalBorrows = borrows + interest;
+            const borrowIndex = index + interestFactor * index;
+            return { totalBalance, totalBorrows, borrowIndex, timeElapsed, interest };
+        });
+    }
+    // Simulates `_calculateBorrowRate` from `BInterestRateModel.sol`, uses `accruedInterestIndices`
+    // to simulate interest accrual first since this function is always called after `accrueInterest`.
+    _calculateBorrowRate() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let borrowRate = 0;
+            const KINK_MULTIPLIER = this.lendingPool.getKinkMultiplier();
+            const KINK_BORROW_RATE_MAX = 792.7448 / 1e9; // 2500% per year 
+            const KINK_BORROW_RATE_MIN = 0.31709792 / 1e9; // 1% per year
+            const [_kinkUtilizationRate, _adjustSpeed, _borrowRate, _kinkBorrowRate, _rateUpdateTimestamp,] = yield Promise.all([
+                this.getPoolTokenParamFloat("kinkUtilizationRate"),
+                this.getPoolTokenParamFloat("adjustSpeed"),
+                this.getPoolTokenParamFloat("borrowRate"),
+                this.getPoolTokenParamFloat("kinkBorrowRate"),
+                // This should be same most of time, cant get it from subgraph since no event
+                this.getPoolTokenParamFloat("accrualTimestamp"),
+            ]);
+            // Calculate new kink borrow rate
+            const timeElapsed = Date.now() / 1000 - _rateUpdateTimestamp;
+            let kinkBorrowRate = 0;
+            if (timeElapsed > 0) {
+                let adjustFactor = 0;
+                if (_borrowRate < _kinkBorrowRate) {
+                    const tmp = (_kinkBorrowRate - _borrowRate) / _kinkBorrowRate * _adjustSpeed * timeElapsed;
+                    adjustFactor = tmp > 1 ? 0 : 1 - tmp;
+                }
+                else {
+                    const tmp = (_borrowRate - _kinkBorrowRate) / _kinkBorrowRate * _adjustSpeed * timeElapsed;
+                    adjustFactor = 1 + tmp;
+                }
+                kinkBorrowRate = _kinkBorrowRate * adjustFactor;
+                if (kinkBorrowRate > KINK_BORROW_RATE_MAX)
+                    kinkBorrowRate = KINK_BORROW_RATE_MAX;
+                if (kinkBorrowRate < KINK_BORROW_RATE_MIN)
+                    kinkBorrowRate = KINK_BORROW_RATE_MIN;
+            }
+            // Simulate accrual
+            const { totalBalance, totalBorrows } = yield this._accrueInterest();
+            ;
+            const _actualBalance = totalBalance + totalBorrows;
+            const _utilizationRate = _actualBalance === 0 ? 0 : totalBorrows / _actualBalance;
+            if (_utilizationRate <= _kinkUtilizationRate) {
+                borrowRate = kinkBorrowRate * _utilizationRate / _kinkUtilizationRate;
+            }
+            else {
+                const overUtil = (_utilizationRate - _kinkUtilizationRate) / (1 - _kinkUtilizationRate);
+                borrowRate = ((KINK_MULTIPLIER - 1) * overUtil + 1) * kinkBorrowRate;
+            }
+            return { borrowRate, kinkBorrowRate };
+        });
+    }
     constructor(lendingPool, poolTokenType) {
         super();
         this.getOffchain = () => this.lendingPool.getOffchain();
@@ -39,7 +115,8 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Kink Borrow Rate
     getKinkBorrowRate() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getPoolTokenParamFloat("kinkBorrowRate");
+            const { kinkBorrowRate } = yield this._calculateBorrowRate();
+            return kinkBorrowRate;
         });
     }
     // Kink Utilization Rate
@@ -64,7 +141,8 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Borrow Index
     getBorrowIndex() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getPoolTokenParamFloat("borrowIndex");
+            const { borrowIndex } = yield this._accrueInterest();
+            return borrowIndex;
         });
     }
     // Accrue Timestamp
@@ -76,20 +154,13 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Total borrows
     getTotalBorrows() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getPoolTokenParamFloat("totalBorrows");
-        });
-    }
-    getCurrentTotalBorrows() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const storedAmount = yield this.getTotalBorrows();
-            const accrualTimestamp = yield this.getAccrualTimestamp();
-            const borrowRate = yield this.getBorrowRate();
-            return storedAmount * (1 + (Date.now() / 1000 - accrualTimestamp) * borrowRate);
+            const { totalBorrows } = yield this._accrueInterest();
+            return totalBorrows;
         });
     }
     getTotalBorrowsUSD() {
         return __awaiter(this, void 0, void 0, function* () {
-            const totalBorrows = yield this.getCurrentTotalBorrows();
+            const totalBorrows = yield this.getTotalBorrows();
             const tokenPrice = yield this.getTokenPriceFast();
             return totalBorrows * tokenPrice;
         });
@@ -97,7 +168,8 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Borrow rate
     getBorrowRate() {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.getPoolTokenParamFloat("borrowRate");
+            const { borrowRate } = yield this._calculateBorrowRate();
+            return borrowRate;
         });
     }
     getBorrowAPR() {
@@ -108,10 +180,10 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     }
     getNextBorrowRate(borrowAmount) {
         return __awaiter(this, void 0, void 0, function* () {
-            const totalBorrows = yield this.getTotalBorrows();
-            const supply = yield this.getSupply();
+            const { totalBalance, totalBorrows } = yield this._accrueInterest();
+            const supply = totalBalance + totalBorrows;
             const UR = (borrowAmount + totalBorrows) / supply;
-            const kinkBR = yield this.getKinkBorrowRate();
+            const { kinkBorrowRate: kinkBR } = yield this._calculateBorrowRate();
             const kinkUR = yield this.getKinkUtilizationRate();
             if (UR < kinkUR)
                 return UR / kinkUR * kinkBR;
@@ -128,22 +200,13 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Supply
     getSupply() {
         return __awaiter(this, void 0, void 0, function* () {
-            const totalBalance = yield this.getTotalBalance();
-            const totalBorrows = yield this.getTotalBorrows();
+            const { totalBalance, totalBorrows } = yield this._accrueInterest();
             return totalBalance + totalBorrows;
         });
     }
-    getCurrentSupply() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const storedAmount = yield this.getSupply();
-            const accrualTimestamp = yield this.getAccrualTimestamp();
-            const supplyRate = yield this.getSupplyRate();
-            return storedAmount * (1 + (Date.now() / 1000 - accrualTimestamp) * supplyRate);
-        });
-    }
     getSupplyUSD() {
         return __awaiter(this, void 0, void 0, function* () {
-            const supply = yield this.getCurrentSupply();
+            const supply = yield this.getSupply();
             const tokenPrice = yield this.getTokenPriceFast();
             return supply * tokenPrice;
         });
@@ -151,11 +214,10 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     // Utilization Rate
     getUtilizationRate() {
         return __awaiter(this, void 0, void 0, function* () {
-            const supply = yield this.getSupply();
-            if (supply == 0)
+            const { totalBalance, totalBorrows } = yield this._accrueInterest();
+            if (totalBorrows == 0)
                 return 0;
-            const totalBalance = yield this.getTotalBorrows();
-            return totalBalance / supply;
+            return totalBorrows / (totalBalance + totalBorrows);
         });
     }
     // Supply Rate
@@ -175,10 +237,10 @@ class OffchainBorrowable extends offchainPoolToken_1.default {
     }
     getNextSupplyRate(supplyAmount) {
         return __awaiter(this, void 0, void 0, function* () {
-            const totalBorrows = yield this.getTotalBorrows();
-            const supply = yield this.getSupply();
+            const { totalBalance, totalBorrows } = yield this._accrueInterest();
+            const supply = totalBalance + totalBorrows;
             const UR = totalBorrows / (supply + supplyAmount);
-            const kinkBR = yield this.getKinkBorrowRate();
+            const { kinkBorrowRate: kinkBR } = yield this._calculateBorrowRate();
             const kinkUR = yield this.getKinkUtilizationRate();
             const reserveFactor = yield this.getReserveFactor();
             if (UR < kinkUR)

package/lib/onchain/interactions/onchainInteractionsPoolToken.d.ts

@@ -21,7 +21,7 @@ export default abstract class OnchainInteractionsPoolToken {
     getPoolTokenAllowance(): Promise<ethers.BigNumber>;
     getUnderlyingAllowance(): Promise<ethers.BigNumber>;
     approvePoolToken(amount: BigNumber, onTransactionHash: Function): Promise<any>;
-    permitPoolToken(amount: BigNumber, callBack: (permit: Permit | null) => void): Promise<void>;
+    permitPoolToken(amount: BigNumber): Promise<Permit>;
     approveUnderlying(amount: BigNumber, onTransactionHash: Function): Promise<any>;
     protected getSendData(permits: Permits): Promise<{
         router: any;

package/lib/onchain/interactions/onchainInteractionsPoolToken.js

@@ -79,11 +79,11 @@ class OnchainInteractionsPoolToken {
             return this.send(poolToken.methods.approve(spender, amount), onTransactionHash);
         });
     }
-    permitPoolToken(amount, callBack) {
+    permitPoolToken(amount) {
         return __awaiter(this, void 0, void 0, function* () {
             const { owner, spender } = this.getOwnerSpender();
             const poolToken = yield this.poolToken.getPoolToken();
-            this.getPermitHelper().getTokenPermit(poolToken, owner, spender, amount, callBack);
+            return this.getPermitHelper().getTokenPermit(poolToken, owner, spender, amount);
         });
     }
     approveUnderlying(amount, onTransactionHash) {

package/lib/onchain/onchainPermitHelper.d.ts

@@ -15,7 +15,7 @@ export default class OnchainPermitHelper {
     private getNftPermitJSONData;
     private getPermit2SingleJSONData;
     private getSignature;
-    getTokenPermit(token: Contract, owner: Address, spender: Address, value: BigNumber, callBack: (permit: Permit | null) => void): Promise<void>;
-    getNftPermit(token: Contract, owner: Address, spender: Address, tokenId: BigNumber, callBack: (permit: Permit | null) => void): Promise<void>;
-    getPermit2Single(token: Contract, owner: Address, spender: Address, value: BigNumber, callBack: (permit: Permit | null) => void): Promise<void>;
+    getTokenPermit(token: Contract, owner: Address, spender: Address, value: BigNumber): Promise<Permit>;
+    getNftPermit(token: Contract, owner: Address, spender: Address, tokenId: BigNumber): Promise<Permit>;
+    getPermit2Single(token: Contract, owner: Address, spender: Address, value: BigNumber): Promise<Permit>;
 }

package/lib/onchain/onchainPermitHelper.js

@@ -48,12 +48,20 @@ const PERMIT2_SINGLE = [
     { name: "spender", type: "address" },
     { name: "sigDeadline", type: "uint256" },
 ];
-const TYPES = {
+const TOKEN_PERMIT_TYPES = {
     EIP712Domain: EIP712_DOMAIN,
-    Permit2Domain: PERMIT2_DOMAIN,
     Permit: PERMIT,
+};
+const BORROW_PERMIT_TYPES = {
+    EIP712Domain: EIP712_DOMAIN,
     BorrowPermit: PERMIT,
-    NftPermit: NFT_PERMIT,
+};
+const NFT_PERMIT_TYPES = {
+    EIP712Domain: EIP712_DOMAIN,
+    Permit: NFT_PERMIT,
+};
+const PERMIT2_TYPES = {
+    Permit2Domain: PERMIT2_DOMAIN,
     PermitDetails: PERMIT2_DETAILS,
     PermitSingle: PERMIT2_SINGLE,
 };
@@ -86,47 +94,49 @@ class OnchainPermitHelper {
         return __awaiter(this, void 0, void 0, function* () {
             const domain = yield this.getDomainPermit1(contract);
             const primaryType = "Permit";
-            return JSON.stringify({ types: TYPES, domain, primaryType, message });
+            return JSON.stringify({ types: TOKEN_PERMIT_TYPES, domain, primaryType, message });
         });
     }
     getBorrowPermitJSONData(contract, message) {
         return __awaiter(this, void 0, void 0, function* () {
             const domain = yield this.getDomainPermit1(contract);
             const primaryType = "BorrowPermit";
-            return JSON.stringify({ types: TYPES, domain, primaryType, message });
+            return JSON.stringify({ types: BORROW_PERMIT_TYPES, domain, primaryType, message });
         });
     }
     getNftPermitJSONData(contract, message) {
         return __awaiter(this, void 0, void 0, function* () {
             const domain = yield this.getDomainPermit1(contract);
-            const primaryType = "NftPermit";
-            return JSON.stringify({ types: TYPES, domain, primaryType, message });
+            const primaryType = "Permit";
+            return JSON.stringify({ types: NFT_PERMIT_TYPES, domain, primaryType, message });
         });
     }
     getPermit2SingleJSONData(message) {
         return __awaiter(this, void 0, void 0, function* () {
             const domain = this.getDomainPermit2();
             const primaryType = "PermitSingle";
-            return JSON.stringify({ types: TYPES, domain, primaryType, message });
+            return JSON.stringify({ types: PERMIT2_TYPES, domain, primaryType, message });
         });
     }
-    getSignature(owner, jsonData, callBack) {
+    getSignature(owner, jsonData) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.onchain.web3.currentProvider.send({
-                method: "eth_signTypedData_v4",
-                params: [owner, jsonData],
-                from: owner
-            }, (err, data) => {
-                if (err) {
-                    console.error(err);
-                    return callBack(null);
-                }
-                console.log("signature", data.result);
-                callBack(data.result);
+            return new Promise((resolve, reject) => {
+                this.onchain.web3.currentProvider.send({
+                    method: "eth_signTypedData_v4",
+                    params: [owner, jsonData],
+                    from: owner
+                }, (err, data) => {
+                    if (err) {
+                        reject(err);
+                    }
+                    else {
+                        resolve(data.result);
+                    }
+                });
             });
         });
     }
-    getTokenPermit(token, owner, spender, value, callBack) {
+    getTokenPermit(token, owner, spender, value) {
         return __awaiter(this, void 0, void 0, function* () {
             const nonce = yield token.methods.nonces(owner).call();
             const jsonData = yield this.getTokenPermitJSONData(token, {
@@ -136,19 +146,14 @@ class OnchainPermitHelper {
                 nonce: ethers_1.BigNumber.from(nonce).toHexString(),
                 deadline: this.deadline,
             });
-            console.log("jsonData", jsonData);
-            this.getSignature(owner, jsonData, (signature) => {
-                if (!signature)
-                    return callBack(null);
-                callBack({
-                    permitType: onchainTypes_1.PermitType.PERMIT1,
-                    permitData: ethers_1.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'uint256'], [token._address, value.toString(), this.deadline]),
-                    signature
-                });
-            });
+            return {
+                permitType: onchainTypes_1.PermitType.PERMIT1,
+                permitData: ethers_1.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'uint256'], [token._address, value.toString(), this.deadline]),
+                signature: yield this.getSignature(owner, jsonData)
+            };
         });
     }
-    getNftPermit(token, owner, spender, tokenId, callBack) {
+    getNftPermit(token, owner, spender, tokenId) {
         return __awaiter(this, void 0, void 0, function* () {
             const nonce = yield token.methods.nonces(tokenId).call();
             const jsonData = yield this.getNftPermitJSONData(token, {
@@ -157,22 +162,18 @@ class OnchainPermitHelper {
                 nonce: ethers_1.BigNumber.from(nonce).toHexString(),
                 deadline: this.deadline,
             });
-            this.getSignature(owner, jsonData, (signature) => {
-                if (!signature)
-                    return callBack(null);
-                callBack({
-                    permitType: onchainTypes_1.PermitType.PERMIT_NFT,
-                    permitData: ethers_1.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'uint256'], [token.address, tokenId.toString(), this.deadline]),
-                    signature
-                });
-            });
+            return {
+                permitType: onchainTypes_1.PermitType.PERMIT_NFT,
+                permitData: ethers_1.ethers.utils.defaultAbiCoder.encode(['address', 'uint256', 'uint256'], [token.address, tokenId.toString(), this.deadline]),
+                signature: yield this.getSignature(owner, jsonData)
+            };
         });
     }
-    getPermit2Single(token, owner, spender, value, callBack) {
+    getPermit2Single(token, owner, spender, value) {
         return __awaiter(this, void 0, void 0, function* () {
             const allowanceData = yield this.permit2.methods.allowance(owner, token.address, spender);
             if (!allowanceData)
-                return callBack(null);
+                throw new Error("Invalid permit2 allowance data");
             const nonce = allowanceData.nonce;
             const permitDetailsType = 'tuple(address tokenAddress, uint160 amount, uint48 expiration, uint48 nonce)';
             const details = {
@@ -186,15 +187,11 @@ class OnchainPermitHelper {
                 spender,
                 sigDeadline: this.deadline,
             });
-            this.getSignature(owner, jsonData, (signature) => {
-                if (!signature)
-                    return callBack(null);
-                callBack({
-                    permitType: onchainTypes_1.PermitType.PERMIT2_SINGLE,
-                    permitData: ethers_1.ethers.utils.defaultAbiCoder.encode([permitDetailsType, 'address', 'uint256'], [token, spender, this.deadline]),
-                    signature
-                });
-            });
+            return {
+                permitType: onchainTypes_1.PermitType.PERMIT2_SINGLE,
+                permitData: ethers_1.ethers.utils.defaultAbiCoder.encode([permitDetailsType, 'address', 'uint256'], [token, spender, this.deadline]),
+                signature: yield this.getSignature(owner, jsonData)
+            };
         });
     }
 }

package/package.json

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