@drift-labs/vaults-sdk 0.1.462 → 0.1.464

package/lib/accounts/vaultAccount.d.ts

@@ -2,7 +2,7 @@ import { Program } from '@coral-xyz/anchor';
 import { BulkAccountLoader, BN } from '@drift-labs/sdk';
 import { PublicKey } from '@solana/web3.js';
 import { DriftVaults } from '../types/drift_vaults';
-import { Vault, VaultAccountEvents } from '../types/types';
+import { Vault, VaultAccountEvents, VaultProtocol } from '../types/types';
 import { VaultsProgramAccount } from './vaultsProgramAccount';
 export declare class VaultAccount extends VaultsProgramAccount<Vault, VaultAccountEvents> {
     constructor(program: Program<DriftVaults>, vaultPubkey: PublicKey, accountLoader: BulkAccountLoader, accountSubscriptionType?: 'polling' | 'websocket');
@@ -11,4 +11,9 @@ export declare class VaultAccount extends VaultsProgramAccount<Vault, VaultAccou
         totalShares: BN;
         managementFeeShares: BN;
     };
+    calcSharesAfterManagementAndProtocolFee(vaultEquity: BN, vaultProtocol: VaultProtocol): {
+        totalShares: BN;
+        managementFeeShares: BN;
+        protocolFeeShares: BN;
+    };
 }

package/lib/accounts/vaultAccount.js

@@ -48,5 +48,120 @@ class VaultAccount extends vaultsProgramAccount_1.VaultsProgramAccount {
         const managementFeeShares = newTotalShares.sub(accountData.totalShares);
         return { totalShares: newTotalShares, managementFeeShares };
     }
+    calcSharesAfterManagementAndProtocolFee(vaultEquity, vaultProtocol) {
+        const accountData = this.accountSubscriber.getAccountAndSlot().data;
+        if (!accountData.vaultProtocol) {
+            throw new Error('VaultProtocol does not exist for vault');
+        }
+        const depositorsEquity = accountData.userShares
+            .mul(vaultEquity)
+            .div(accountData.totalShares);
+        const now = new sdk_1.BN(Date.now() / 1000);
+        const sinceLast = now.sub(accountData.lastFeeUpdateTs);
+        if (!accountData.managementFee.eq(sdk_1.ZERO) &&
+            !vaultProtocol.protocolFee.eq(sdk_1.ZERO) &&
+            depositorsEquity.gt(sdk_1.ZERO)) {
+            const totalFee = accountData.managementFee.add(vaultProtocol.protocolFee);
+            const totalFeePayment = depositorsEquity
+                .mul(totalFee)
+                .div(sdk_1.PERCENTAGE_PRECISION)
+                .mul(sinceLast)
+                .div(sdk_1.ONE_YEAR);
+            const managementFeePayment = depositorsEquity
+                .mul(accountData.managementFee)
+                .div(sdk_1.PERCENTAGE_PRECISION)
+                .mul(sinceLast)
+                .div(sdk_1.ONE_YEAR);
+            const protocolFeePayment = sdk_1.BN.min(totalFeePayment, depositorsEquity.sub(new sdk_1.BN(1)))
+                .mul(vaultProtocol.protocolFee)
+                .div(totalFee);
+            const newTotalSharesFactor = depositorsEquity
+                .mul(sdk_1.PERCENTAGE_PRECISION)
+                .div(depositorsEquity.sub(managementFeePayment).sub(protocolFeePayment));
+            const newTotalShares = sdk_1.BN.max(accountData.totalShares
+                .mul(newTotalSharesFactor)
+                .div(sdk_1.PERCENTAGE_PRECISION), accountData.userShares);
+            if ((managementFeePayment.eq(sdk_1.ZERO) && protocolFeePayment.eq(sdk_1.ZERO)) ||
+                accountData.totalShares.eq(newTotalShares)) {
+                return {
+                    totalShares: accountData.totalShares,
+                    managementFeeShares: sdk_1.ZERO,
+                    protocolFeeShares: sdk_1.ZERO,
+                };
+            }
+            const managementFeeShares = newTotalShares.sub(accountData.totalShares);
+            const protocolFeeShares = newTotalShares.sub(accountData.totalShares);
+            return {
+                totalShares: newTotalShares,
+                managementFeeShares,
+                protocolFeeShares,
+            };
+        }
+        else if (accountData.managementFee.eq(sdk_1.ZERO) &&
+            !vaultProtocol.protocolFee.eq(sdk_1.ZERO) &&
+            depositorsEquity.gt(sdk_1.ZERO)) {
+            const protocolFeePayment = depositorsEquity
+                .mul(vaultProtocol.protocolFee)
+                .div(sdk_1.PERCENTAGE_PRECISION)
+                .mul(sinceLast)
+                .div(sdk_1.ONE_YEAR);
+            const newTotalSharesFactor = depositorsEquity
+                .mul(sdk_1.PERCENTAGE_PRECISION)
+                .div(depositorsEquity.sub(protocolFeePayment));
+            const newTotalShares = sdk_1.BN.max(accountData.totalShares
+                .mul(newTotalSharesFactor)
+                .div(sdk_1.PERCENTAGE_PRECISION), accountData.userShares);
+            if (protocolFeePayment.eq(sdk_1.ZERO) ||
+                accountData.totalShares.eq(newTotalShares)) {
+                return {
+                    totalShares: accountData.totalShares,
+                    managementFeeShares: sdk_1.ZERO,
+                    protocolFeeShares: sdk_1.ZERO,
+                };
+            }
+            const protocolFeeShares = newTotalShares.sub(accountData.totalShares);
+            return {
+                totalShares: newTotalShares,
+                managementFeeShares: sdk_1.ZERO,
+                protocolFeeShares,
+            };
+        }
+        else if (!accountData.managementFee.eq(sdk_1.ZERO) &&
+            vaultProtocol.protocolFee.eq(sdk_1.ZERO) &&
+            depositorsEquity.gt(sdk_1.ZERO)) {
+            const managementFeePayment = sdk_1.BN.min(depositorsEquity
+                .mul(accountData.managementFee)
+                .div(sdk_1.PERCENTAGE_PRECISION)
+                .mul(sinceLast)
+                .div(sdk_1.ONE_YEAR), depositorsEquity.sub(sdk_1.ONE));
+            const newTotalSharesFactor = depositorsEquity
+                .mul(sdk_1.PERCENTAGE_PRECISION)
+                .div(depositorsEquity.sub(managementFeePayment));
+            const newTotalShares = sdk_1.BN.max(accountData.totalShares
+                .mul(newTotalSharesFactor)
+                .div(sdk_1.PERCENTAGE_PRECISION), accountData.userShares);
+            if (managementFeePayment.eq(sdk_1.ZERO) ||
+                accountData.totalShares.eq(newTotalShares)) {
+                return {
+                    totalShares: accountData.totalShares,
+                    managementFeeShares: sdk_1.ZERO,
+                    protocolFeeShares: sdk_1.ZERO,
+                };
+            }
+            const managementFeeShares = newTotalShares.sub(accountData.totalShares);
+            return {
+                totalShares: newTotalShares,
+                managementFeeShares,
+                protocolFeeShares: sdk_1.ZERO,
+            };
+        }
+        else {
+            return {
+                totalShares: accountData.totalShares,
+                managementFeeShares: sdk_1.ZERO,
+                protocolFeeShares: sdk_1.ZERO,
+            };
+        }
+    }
 }
 exports.VaultAccount = VaultAccount;

package/lib/addresses.d.ts

@@ -2,3 +2,4 @@ import { PublicKey } from '@solana/web3.js';
 export declare function getVaultAddressSync(programId: PublicKey, encodedName: number[]): PublicKey;
 export declare function getVaultDepositorAddressSync(programId: PublicKey, vault: PublicKey, authority: PublicKey): PublicKey;
 export declare function getTokenVaultAddressSync(programId: PublicKey, vault: PublicKey): PublicKey;
+export declare function getVaultProtocolAddressSync(programId: PublicKey, vault: PublicKey): PublicKey;

package/lib/addresses.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVaultAddressSync = getVaultAddressSync;
 exports.getVaultDepositorAddressSync = getVaultDepositorAddressSync;
 exports.getTokenVaultAddressSync = getTokenVaultAddressSync;
+exports.getVaultProtocolAddressSync = getVaultProtocolAddressSync;
 const web3_js_1 = require("@solana/web3.js");
 const anchor = __importStar(require("@coral-xyz/anchor"));
 function getVaultAddressSync(programId, encodedName) {
@@ -47,3 +48,9 @@ function getTokenVaultAddressSync(programId, vault) {
         vault.toBuffer(),
     ], programId)[0];
 }
+function getVaultProtocolAddressSync(programId, vault) {
+    return web3_js_1.PublicKey.findProgramAddressSync([
+        Buffer.from(anchor.utils.bytes.utf8.encode('vault_protocol')),
+        vault.toBuffer(),
+    ], programId)[0];
+}

package/lib/math/vaultDepositor.d.ts

@@ -1,5 +1,5 @@
 import { BN } from '@drift-labs/sdk';
-import { Vault, VaultDepositor } from '../types/types';
+import { Vault, VaultDepositor, VaultProtocol } from '../types/types';
 /**
  * Calculates the unrealized profitShare for a vaultDepositor
  * @param vaultDepositor
@@ -11,4 +11,13 @@ export declare function calculateApplyProfitShare(vaultDepositor: VaultDepositor
     profitShareAmount: BN;
     profitShareShares: BN;
 };
-export declare function calculateProfitShare(vaultDepositor: VaultDepositor, totalAmount: BN, vault: Vault): BN;
+export declare function calculateProfitShare(vaultDepositor: VaultDepositor, totalAmount: BN, vault: Vault, vaultProtocol?: VaultProtocol): BN;
+/**
+ * Calculates the equity across deposits and realized profit for a vaultDepositor
+ * @param vaultDepositor vault depositor account
+ * @param vaultEquity total vault equity
+ * @param vault vault account
+ * @param vaultProtocol if vault account has "vaultProtocol" then this is needed
+ * @returns
+ */
+export declare function calculateRealizedVaultDepositorEquity(vaultDepositor: VaultDepositor, vaultEquity: BN, vault: Vault, vaultProtocol?: VaultProtocol): BN;

package/lib/math/vaultDepositor.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.calculateApplyProfitShare = calculateApplyProfitShare;
 exports.calculateProfitShare = calculateProfitShare;
+exports.calculateRealizedVaultDepositorEquity = calculateRealizedVaultDepositorEquity;
 const sdk_1 = require("@drift-labs/sdk");
 /**
  * Calculates the unrealized profitShare for a vaultDepositor
@@ -19,13 +20,30 @@ function calculateApplyProfitShare(vaultDepositor, vaultEquity, vault) {
         profitShareShares,
     };
 }
-function calculateProfitShare(vaultDepositor, totalAmount, vault) {
+function calculateProfitShare(vaultDepositor, totalAmount, vault, vaultProtocol) {
     const profit = totalAmount.sub(vaultDepositor.netDeposits.add(vaultDepositor.cumulativeProfitShareAmount));
+    let profitShare = vault.profitShare;
+    if (vaultProtocol) {
+        profitShare += vaultProtocol.protocolProfitShare;
+    }
     if (profit.gt(sdk_1.ZERO)) {
         const profitShareAmount = profit
-            .mul(new sdk_1.BN(vault.profitShare))
+            .mul(new sdk_1.BN(profitShare))
             .div(sdk_1.PERCENTAGE_PRECISION);
         return profitShareAmount;
     }
     return sdk_1.ZERO;
 }
+/**
+ * Calculates the equity across deposits and realized profit for a vaultDepositor
+ * @param vaultDepositor vault depositor account
+ * @param vaultEquity total vault equity
+ * @param vault vault account
+ * @param vaultProtocol if vault account has "vaultProtocol" then this is needed
+ * @returns
+ */
+function calculateRealizedVaultDepositorEquity(vaultDepositor, vaultEquity, vault, vaultProtocol) {
+    const vdAmount = (0, sdk_1.unstakeSharesToAmount)(vaultDepositor.vaultShares, vault.totalShares, vaultEquity);
+    const profitShareAmount = calculateProfitShare(vaultDepositor, vdAmount, vault, vaultProtocol);
+    return vdAmount.sub(profitShareAmount);
+}