@voltr/vault-sdk 1.0.15 → 1.0.16

package/dist/client.d.ts

@@ -1082,6 +1082,22 @@ export declare class VoltrClient extends AccountUtils {
         highestAssetPerLp: number;
         lastUpdatedTs: number;
     }>;
+    /**
+     * Fetches the breakdown of the LP supply for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the breakdown of the LP supply
+     *
+     * @example
+     * ```typescript
+     * const lpSupplyBreakdown = await client.getVaultLpSupplyBreakdown(vaultPubkey);
+     * ```
+     */
+    getVaultLpSupplyBreakdown(vault: PublicKey): Promise<{
+        circulating: BN;
+        unharvestedFees: BN;
+        unrealisedFees: BN;
+        total: BN;
+    }>;
     /**
      * Processes a withdrawal receipt into a standardized withdrawal info object
      * @private
@@ -1125,7 +1141,10 @@ export declare class VoltrClient extends AccountUtils {
         withdrawableFromTs: number;
     }[]>;
     calculateLockedProfit(lastUpdatedLockedProfit: BN, lockedProfitDegradationDuration: BN, currentTime: BN): BN;
-    private getProjectedLpSupply;
+    /**
+     * Helper to calculate only the pending (unrealised) LP fees based on time elapsed.
+     */
+    private calculateUnrealisedLpFees;
     calculateAssetsForWithdrawHelper(vaultTotalValue: BN, vaultLastUpdatedLockedProfit: BN, vaultLockedProfitDegradationDuration: BN, vaultAccumulatedLpAdminFees: BN, vaultAccumulatedLpManagerFees: BN, vaultAccumulatedLpProtocolFees: BN, vaultRedemptionFeeBps: number, vaultManagementFeeBps: number, vaultLastManagementFeeUpdateTs: BN, lpSupply: BN, lpAmount: BN): BN;
     /**
      * Calculates the amount of assets that would be received for a given LP token amount

package/dist/client.js

@@ -1275,6 +1275,36 @@ class VoltrClient extends AccountUtils {
             lastUpdatedTs: vaultAccount.highWaterMark.lastUpdatedTs.toNumber(),
         };
     }
+    /**
+     * Fetches the breakdown of the LP supply for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the breakdown of the LP supply
+     *
+     * @example
+     * ```typescript
+     * const lpSupplyBreakdown = await client.getVaultLpSupplyBreakdown(vaultPubkey);
+     * ```
+     */
+    async getVaultLpSupplyBreakdown(vault) {
+        const [vaultAccount, lpMintInfo] = await Promise.all([
+            this.fetchVaultAccount(vault),
+            (0, spl_token_1.getMint)(this.conn, this.findVaultLpMint(vault), this.provider.opts.commitment),
+        ]);
+        const circulating = new bn_js_1.default(lpMintInfo.supply.toString());
+        const unharvestedFees = vaultAccount.feeState.accumulatedLpAdminFees
+            .add(vaultAccount.feeState.accumulatedLpManagerFees)
+            .add(vaultAccount.feeState.accumulatedLpProtocolFees);
+        const currentTotalLp = circulating.add(unharvestedFees);
+        const unrealisedFees = this.calculateUnrealisedLpFees(currentTotalLp, vaultAccount.asset.totalValue, vaultAccount.feeUpdate.lastManagementFeeUpdateTs, new bn_js_1.default(vaultAccount.feeConfiguration.managerManagementFee +
+            vaultAccount.feeConfiguration.adminManagementFee));
+        const total = currentTotalLp.add(unrealisedFees);
+        return {
+            circulating,
+            unharvestedFees,
+            unrealisedFees,
+            total,
+        };
+    }
     /**
      * Processes a withdrawal receipt into a standardized withdrawal info object
      * @private
@@ -1347,29 +1377,35 @@ class VoltrClient extends AccountUtils {
         else
             return lockedProfit;
     }
-    getProjectedLpSupply(currentTotalLp, assetTotalValue, lastManagementFeeUpdateTs, managementFeeBps) {
+    /**
+     * Helper to calculate only the pending (unrealised) LP fees based on time elapsed.
+     */
+    calculateUnrealisedLpFees(currentTotalLp, assetTotalValue, lastManagementFeeUpdateTs, managementFeeBps) {
         if (lastManagementFeeUpdateTs.eq(new bn_js_1.default(0)) ||
             assetTotalValue.eq(new bn_js_1.default(0)) ||
             managementFeeBps.eq(new bn_js_1.default(0))) {
-            return currentTotalLp;
+            return new bn_js_1.default(0);
         }
         const nowBn = new bn_js_1.default(Math.floor(Date.now() / 1000));
         const timeElapsed = bn_js_1.default.max(new bn_js_1.default(0), nowBn.sub(lastManagementFeeUpdateTs));
         if (timeElapsed.eq(new bn_js_1.default(0))) {
-            return currentTotalLp;
+            return new bn_js_1.default(0);
         }
         const feeAmountInAsset = assetTotalValue
             .mul(timeElapsed)
-            .mul(new bn_js_1.default(managementFeeBps))
+            .mul(managementFeeBps)
             .div(constants_1.MAX_FEE_BPS_BN)
             .div(constants_1.ONE_YEAR_BN);
         const lpNumerator = feeAmountInAsset.mul(currentTotalLp);
         const lpDenominator = assetTotalValue.sub(feeAmountInAsset);
+        if (lpDenominator.lte(new bn_js_1.default(0))) {
+            return new bn_js_1.default(0);
+        }
         const pendingLpToMint = lpNumerator
             .add(lpDenominator)
             .sub(new bn_js_1.default(1))
             .div(lpDenominator);
-        return currentTotalLp.add(pendingLpToMint);
+        return pendingLpToMint;
     }
     calculateAssetsForWithdrawHelper(vaultTotalValue, vaultLastUpdatedLockedProfit, vaultLockedProfitDegradationDuration, vaultAccumulatedLpAdminFees, vaultAccumulatedLpManagerFees, vaultAccumulatedLpProtocolFees, vaultRedemptionFeeBps, vaultManagementFeeBps, vaultLastManagementFeeUpdateTs, lpSupply, lpAmount) {
         if (lpSupply <= new bn_js_1.default(0))
@@ -1382,7 +1418,8 @@ class VoltrClient extends AccountUtils {
             .add(vaultAccumulatedLpManagerFees)
             .add(vaultAccumulatedLpProtocolFees);
         const lpSupplyInclAccumulatedFees = lpSupply.add(unharvestedFeesLp);
-        const lpSupplyInclFees = this.getProjectedLpSupply(lpSupplyInclAccumulatedFees, vaultTotalValue, vaultLastManagementFeeUpdateTs, new bn_js_1.default(vaultManagementFeeBps));
+        const unrealisedLpFees = this.calculateUnrealisedLpFees(lpSupplyInclAccumulatedFees, vaultTotalValue, vaultLastManagementFeeUpdateTs, new bn_js_1.default(vaultManagementFeeBps));
+        const lpSupplyInclFees = unrealisedLpFees.add(lpSupplyInclAccumulatedFees);
         // asset_to_redeem_pre_fee = amount * (total_asset_pre_withdraw / total_lp_supply_pre_withdraw)
         // asset_to_redeem_post_fee = asset_to_redeem_pre_fee * (10000 - redemption_fee_bps) / 10000
         const assetToRedeemNumerator = lpAmount
@@ -1459,8 +1496,9 @@ class VoltrClient extends AccountUtils {
                 .add(vault.feeState.accumulatedLpManagerFees)
                 .add(vault.feeState.accumulatedLpProtocolFees);
             const lpSupplyInclAccumulatedFees = lpSupply.add(unharvestedFeesLp);
-            const lpSupplyInclFees = this.getProjectedLpSupply(lpSupplyInclAccumulatedFees, totalValue, vault.feeUpdate.lastManagementFeeUpdateTs, new bn_js_1.default(vault.feeConfiguration.managerManagementFee +
+            const unrealisedLpFees = this.calculateUnrealisedLpFees(lpSupplyInclAccumulatedFees, totalValue, vault.feeUpdate.lastManagementFeeUpdateTs, new bn_js_1.default(vault.feeConfiguration.managerManagementFee +
                 vault.feeConfiguration.adminManagementFee));
+            const lpSupplyInclFees = unrealisedLpFees.add(lpSupplyInclAccumulatedFees);
             // lp_to_burn_pre_fee = redeem_amount * (total_lp_supply_pre_withdraw / total_asset_pre_withdraw)
             // lp_to_burn_post_fee = lp_to_burn_pre_fee  * (10000 / (10000 - redemption_fee_bps))
             const lpToBurnNumerator = assetAmount
@@ -1501,8 +1539,9 @@ class VoltrClient extends AccountUtils {
             .add(vault.feeState.accumulatedLpManagerFees)
             .add(vault.feeState.accumulatedLpProtocolFees);
         const lpSupplyInclAccumulatedFees = lpSupply.add(unharvestedFeesLp);
-        const lpSupplyInclFees = this.getProjectedLpSupply(lpSupplyInclAccumulatedFees, totalValue, vault.feeUpdate.lastManagementFeeUpdateTs, new bn_js_1.default(vault.feeConfiguration.managerManagementFee +
+        const unrealisedLpFees = this.calculateUnrealisedLpFees(lpSupplyInclAccumulatedFees, totalValue, vault.feeUpdate.lastManagementFeeUpdateTs, new bn_js_1.default(vault.feeConfiguration.managerManagementFee +
             vault.feeConfiguration.adminManagementFee));
+        const lpSupplyInclFees = unrealisedLpFees.add(lpSupplyInclAccumulatedFees);
         // If the pool is empty, mint LP tokens 1:1 with deposit
         if (lpSupplyInclFees.eq(new bn_js_1.default(0))) {
             const assetMint = await (0, spl_token_1.getMint)(this.conn, vault.asset.mint, this.provider.opts.commitment);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voltr/vault-sdk",
-  "version": "1.0.15",
+  "version": "1.0.16",
   "description": "SDK for interacting with Voltr Protocol",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",