@drift-labs/sdk 2.95.0-beta.11 → 2.95.0-beta.12

package/VERSION

@@ -1 +1 @@
-2.95.0-beta.11
+2.95.0-beta.12

package/lib/math/insurance.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="bn.js" />
-import { BN } from '../index';
+import { BN, SpotMarketAccount } from '../index';
+export declare function nextRevenuePoolSettleApr(spotMarket: SpotMarketAccount, vaultBalance: BN, // vault token amount
+amount?: BN): number;
 export declare function stakeAmountToShares(amount: BN, totalIfShares: BN, insuranceFundVaultBalance: BN): BN;
 export declare function unstakeSharesToAmount(nShares: BN, totalIfShares: BN, insuranceFundVaultBalance: BN): BN;
 export declare function unstakeSharesToAmountWithOpenRequest(nShares: BN, withdrawRequestShares: BN, withdrawRequestAmount: BN, totalIfShares: BN, insuranceFundVaultBalance: BN): BN;

package/lib/math/insurance.js

@@ -1,8 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unstakeSharesToAmountWithOpenRequest = exports.unstakeSharesToAmount = exports.stakeAmountToShares = void 0;
+exports.unstakeSharesToAmountWithOpenRequest = exports.unstakeSharesToAmount = exports.stakeAmountToShares = exports.nextRevenuePoolSettleApr = void 0;
 const numericConstants_1 = require("../constants/numericConstants");
 const index_1 = require("../index");
+const spotBalance_1 = require("../math/spotBalance");
+function nextRevenuePoolSettleApr(spotMarket, vaultBalance, // vault token amount
+amount // delta token amount
+) {
+    const MAX_APR = new index_1.BN(10).mul(numericConstants_1.PERCENTAGE_PRECISION); // 1000% APR
+    // Conmputing the APR:
+    const revenuePoolBN = (0, spotBalance_1.getTokenAmount)(spotMarket.revenuePool.scaledBalance, spotMarket, index_1.SpotBalanceType.DEPOSIT);
+    const payoutRatio = 0.1;
+    const ratioForStakers = spotMarket.insuranceFund.totalFactor > 0 &&
+        spotMarket.insuranceFund.userFactor > 0 &&
+        spotMarket.insuranceFund.revenueSettlePeriod.gt(numericConstants_1.ZERO)
+        ? spotMarket.insuranceFund.userFactor /
+            spotMarket.insuranceFund.totalFactor
+        : 0;
+    // Settle periods from on-chain data:
+    const revSettlePeriod = spotMarket.insuranceFund.revenueSettlePeriod.toNumber() * 1000;
+    const settlesPerYear = 31536000000 / revSettlePeriod;
+    const projectedAnnualRev = revenuePoolBN
+        .muln(settlesPerYear)
+        .muln(payoutRatio);
+    const uncappedApr = vaultBalance.add(amount).eq(numericConstants_1.ZERO)
+        ? 0
+        : projectedAnnualRev.muln(1000).div(vaultBalance.add(amount)).toNumber() *
+            100 *
+            1000;
+    const cappedApr = Math.min(uncappedApr, MAX_APR.toNumber());
+    const nextApr = cappedApr * ratioForStakers;
+    return nextApr;
+}
+exports.nextRevenuePoolSettleApr = nextRevenuePoolSettleApr;
 function stakeAmountToShares(amount, totalIfShares, insuranceFundVaultBalance) {
     let nShares;
     if (insuranceFundVaultBalance.gt(numericConstants_1.ZERO)) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@drift-labs/sdk",
-	"version": "2.95.0-beta.11",
+	"version": "2.95.0-beta.12",
 	"main": "lib/index.js",
 	"types": "lib/index.d.ts",
 	"author": "crispheaney",

package/src/math/insurance.ts

@@ -1,5 +1,51 @@
-import { ZERO } from '../constants/numericConstants';
-import { BN } from '../index';
+import { PERCENTAGE_PRECISION, ZERO } from '../constants/numericConstants';
+import { BN, SpotMarketAccount, SpotBalanceType } from '../index';
+import { getTokenAmount } from '../math/spotBalance';
+
+export function nextRevenuePoolSettleApr(
+	spotMarket: SpotMarketAccount,
+	vaultBalance: BN, // vault token amount
+	amount?: BN // delta token amount
+): number {
+	const MAX_APR = new BN(10).mul(PERCENTAGE_PRECISION); // 1000% APR
+
+	// Conmputing the APR:
+	const revenuePoolBN = getTokenAmount(
+		spotMarket.revenuePool.scaledBalance,
+		spotMarket,
+		SpotBalanceType.DEPOSIT
+	);
+
+	const payoutRatio = 0.1;
+	const ratioForStakers =
+		spotMarket.insuranceFund.totalFactor > 0 &&
+		spotMarket.insuranceFund.userFactor > 0 &&
+		spotMarket.insuranceFund.revenueSettlePeriod.gt(ZERO)
+			? spotMarket.insuranceFund.userFactor /
+			  spotMarket.insuranceFund.totalFactor
+			: 0;
+
+	// Settle periods from on-chain data:
+	const revSettlePeriod =
+		spotMarket.insuranceFund.revenueSettlePeriod.toNumber() * 1000;
+
+	const settlesPerYear = 31536000000 / revSettlePeriod;
+
+	const projectedAnnualRev = revenuePoolBN
+		.muln(settlesPerYear)
+		.muln(payoutRatio);
+
+	const uncappedApr = vaultBalance.add(amount).eq(ZERO)
+		? 0
+		: projectedAnnualRev.muln(1000).div(vaultBalance.add(amount)).toNumber() *
+		  100 *
+		  1000;
+	const cappedApr = Math.min(uncappedApr, MAX_APR.toNumber());
+
+	const nextApr = cappedApr * ratioForStakers;
+
+	return nextApr;
+}
 
 export function stakeAmountToShares(
 	amount: BN,