@voltr/vault-sdk 1.0.4 → 1.0.6

package/README.md

@@ -265,6 +265,7 @@ pendingWithdrawals.forEach((withdrawal, index) => {
 - `fetchVaultAccount(vault)`
 - `fetchStrategyInitReceiptAccount(strategyInitReceipt)`
 - `fetchAdaptorAddReceiptAccount(adaptorAddReceipt)`
+- `fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceipt)`
 - `fetchAllStrategyInitReceiptAccounts()`
 - `fetchAllStrategyInitReceiptAccountsOfVault(vault)`
 - `fetchAllAdaptorAddReceiptAccountsOfVault(vault)`
@@ -272,7 +273,10 @@ pendingWithdrawals.forEach((withdrawal, index) => {
 - `getPositionAndTotalValuesForVault(vault)`
 - `getAccumulatedAdminFeesForVault(vault)`
 - `getAccumulatedManagerFeesForVault(vault)`
+- `getPendingWithdrawalForUser(vault, user)`
 - `getAllPendingWithdrawalsForVault(vault)`
+- `getCurrentAssetPerLpForVault(vault)`
+- `getHighWaterMarkForVault(vault)`
 
 #### PDA Finding
 

package/dist/client.d.ts

@@ -726,13 +726,6 @@ export declare class VoltrClient extends AccountUtils {
         lastUpdatedEpoch: BN;
         reserved: number[];
     }>[]>;
-    getPositionAndTotalValuesForVault(vault: PublicKey): Promise<{
-        totalValue: number;
-        strategies: {
-            strategyId: string;
-            amount: number;
-        }[];
-    }>;
     /**
      * Fetches a vault account's data
      * @param vault - Public key of the vault
@@ -833,6 +826,42 @@ export declare class VoltrClient extends AccountUtils {
         lastUpdatedEpoch: BN;
         reserved: number[];
     }>;
+    /**
+     * Fetches a request withdraw vault receipt account's data
+     * @param requestWithdrawVaultReceipt - Public key of the request withdraw vault receipt account
+     * @returns Promise resolving to the request withdraw vault receipt account data
+     *
+     * @example
+     * ```typescript
+     * const requestWithdrawVaultReceiptAccount = await client.fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceiptPubkey);
+     * ```
+     */
+    fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceipt: PublicKey): Promise<{
+        vault: PublicKey;
+        user: PublicKey;
+        amountLpEscrowed: BN;
+        amountAssetToWithdrawDecimalBits: BN;
+        withdrawableFromTs: BN;
+        bump: number;
+        version: number;
+    }>;
+    /**
+     * Fetches the position and total values for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the position and total values
+     *
+     * @example
+     * ```typescript
+     * const positionAndTotalValues = await client.getPositionAndTotalValuesForVault(vaultPubkey);
+     * ```
+     */
+    getPositionAndTotalValuesForVault(vault: PublicKey): Promise<{
+        totalValue: number;
+        strategies: {
+            strategyId: string;
+            amount: number;
+        }[];
+    }>;
     /**
      * Fetches the accumulated admin fees for a vault
      * @param vault - Public key of the vault
@@ -855,6 +884,55 @@ export declare class VoltrClient extends AccountUtils {
      * ```
      */
     getAccumulatedManagerFeesForVault(vault: PublicKey): Promise<BN>;
+    /**
+     * Fetches the current asset per LP for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the current asset per LP
+     *
+     * @example
+     * ```typescript
+     * const currentAssetPerLp = await client.getCurrentAssetPerLpForVault(vaultPubkey);
+     * ```
+     */
+    getCurrentAssetPerLpForVault(vault: PublicKey): Promise<number>;
+    /**
+     * Fetches the high water mark for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the high water mark
+     *
+     * @example
+     * ```typescript
+     * const highWaterMark = await client.getHighWaterMarkForVault(vaultPubkey);
+     * ```
+     */
+    getHighWaterMarkForVault(vault: PublicKey): Promise<{
+        highestAssetPerLp: number;
+        lastUpdatedTs: number;
+    }>;
+    /**
+     * Processes a withdrawal receipt into a standardized withdrawal info object
+     * @private
+     */
+    private processWithdrawalReceipt;
+    /**
+     * Fetches the pending withdrawal for a user
+     * @param vault - Public key of the vault
+     * @param user - Public key of the user
+     * @returns Promise resolving to the pending withdrawal
+     *
+     * @example
+     * ```typescript
+     * const pendingWithdrawal = await client.getPendingWithdrawalForUser(vaultPubkey, userPubkey);
+     * ```
+     */
+    getPendingWithdrawalForUser(vault: PublicKey, user: PublicKey): Promise<{
+        user: PublicKey;
+        amountAssetToWithdrawEffective: number;
+        amountAssetToWithdrawAtRequest: number;
+        amountAssetToWithdrawAtPresent: number;
+        amountLpEscrowed: number;
+        withdrawableFromTs: number;
+    }>;
     /**
      * Fetches all pending withdrawals for a vault
      * @param vault - Public key of the vault
@@ -866,6 +944,7 @@ export declare class VoltrClient extends AccountUtils {
      * ```
      */
     getAllPendingWithdrawalsForVault(vault: PublicKey): Promise<{
+        user: PublicKey;
         amountAssetToWithdrawEffective: number;
         amountAssetToWithdrawAtRequest: number;
         amountAssetToWithdrawAtPresent: number;

package/dist/client.js

@@ -904,19 +904,6 @@ class VoltrClient extends AccountUtils {
             },
         ]);
     }
-    async getPositionAndTotalValuesForVault(vault) {
-        const vaultAccount = await this.fetchVaultAccount(vault);
-        const totalAssetValue = vaultAccount.asset.totalValue;
-        const strategyInitReceiptAccounts = await this.fetchAllStrategyInitReceiptAccountsOfVault(vault);
-        const strategyInfo = strategyInitReceiptAccounts.map((vaultStrategyAccount) => ({
-            strategyId: vaultStrategyAccount.account.strategy.toBase58(),
-            amount: vaultStrategyAccount.account.positionValue.toNumber(),
-        }));
-        return {
-            totalValue: totalAssetValue.toNumber(),
-            strategies: strategyInfo,
-        };
-    }
     // --------------------------------------- Account Fetching
     /**
      * Fetches a vault account's data
@@ -952,7 +939,43 @@ class VoltrClient extends AccountUtils {
     async fetchAdaptorAddReceiptAccount(adaptorAddReceipt) {
         return await this.vaultProgram.account.adaptorAddReceipt.fetch(adaptorAddReceipt, "confirmed");
     }
+    /**
+     * Fetches a request withdraw vault receipt account's data
+     * @param requestWithdrawVaultReceipt - Public key of the request withdraw vault receipt account
+     * @returns Promise resolving to the request withdraw vault receipt account data
+     *
+     * @example
+     * ```typescript
+     * const requestWithdrawVaultReceiptAccount = await client.fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceiptPubkey);
+     * ```
+     */
+    async fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceipt) {
+        return await this.vaultProgram.account.requestWithdrawVaultReceipt.fetch(requestWithdrawVaultReceipt, "confirmed");
+    }
     // --------------------------------------- Helpers
+    /**
+     * Fetches the position and total values for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the position and total values
+     *
+     * @example
+     * ```typescript
+     * const positionAndTotalValues = await client.getPositionAndTotalValuesForVault(vaultPubkey);
+     * ```
+     */
+    async getPositionAndTotalValuesForVault(vault) {
+        const vaultAccount = await this.fetchVaultAccount(vault);
+        const totalAssetValue = vaultAccount.asset.totalValue;
+        const strategyInitReceiptAccounts = await this.fetchAllStrategyInitReceiptAccountsOfVault(vault);
+        const strategyInfo = strategyInitReceiptAccounts.map((vaultStrategyAccount) => ({
+            strategyId: vaultStrategyAccount.account.strategy.toBase58(),
+            amount: vaultStrategyAccount.account.positionValue.toNumber(),
+        }));
+        return {
+            totalValue: totalAssetValue.toNumber(),
+            strategies: strategyInfo,
+        };
+    }
     /**
      * Fetches the accumulated admin fees for a vault
      * @param vault - Public key of the vault
@@ -981,6 +1004,85 @@ class VoltrClient extends AccountUtils {
         const vaultAccount = await this.fetchVaultAccount(vault);
         return vaultAccount.feeState.accumulatedLpManagerFees;
     }
+    /**
+     * Fetches the current asset per LP for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the current asset per LP
+     *
+     * @example
+     * ```typescript
+     * const currentAssetPerLp = await client.getCurrentAssetPerLpForVault(vaultPubkey);
+     * ```
+     */
+    async getCurrentAssetPerLpForVault(vault) {
+        const vaultLpMint = this.findVaultLpMint(vault);
+        const vaultAccount = await this.fetchVaultAccount(vault);
+        const lpSupply = await (0, spl_token_1.getMint)(this.conn, vaultLpMint).then((lp) => new bn_js_1.default(lp.supply.toString()));
+        const unharvestedFeesLp = vaultAccount.feeState.accumulatedLpAdminFees
+            .add(vaultAccount.feeState.accumulatedLpManagerFees)
+            .add(vaultAccount.feeState.accumulatedLpProtocolFees);
+        const totalLpSupply = unharvestedFeesLp.add(lpSupply);
+        const currentAssetPerLp = vaultAccount.asset.totalValue.toNumber() / totalLpSupply.toNumber();
+        return currentAssetPerLp;
+    }
+    /**
+     * Fetches the high water mark for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to the high water mark
+     *
+     * @example
+     * ```typescript
+     * const highWaterMark = await client.getHighWaterMarkForVault(vaultPubkey);
+     * ```
+     */
+    async getHighWaterMarkForVault(vault) {
+        const vaultAccount = await this.fetchVaultAccount(vault);
+        const highWaterMarkValue = (0, decimals_1.convertDecimalBitsToDecimal)(vaultAccount.highWaterMark.highestAssetPerLpDecimalBits);
+        return {
+            highestAssetPerLp: highWaterMarkValue.toNumber(),
+            lastUpdatedTs: vaultAccount.highWaterMark.lastUpdatedTs.toNumber(),
+        };
+    }
+    /**
+     * Processes a withdrawal receipt into a standardized withdrawal info object
+     * @private
+     */
+    async processWithdrawalReceipt(receipt, vaultAccount, lpSupply) {
+        const amountAssetToWithdrawDecimal = (0, decimals_1.convertDecimalBitsToDecimal)(receipt.account.amountAssetToWithdrawDecimalBits);
+        const amountAssetToWithdrawAtRequest = amountAssetToWithdrawDecimal.toNumber();
+        const amountLpEscrowed = receipt.account.amountLpEscrowed;
+        const amountAssetToWithdrawAtPresent = this.calculateAssetsForWithdrawHelper(vaultAccount.asset.totalValue, vaultAccount.lockedProfitState.lastUpdatedLockedProfit, vaultAccount.vaultConfiguration.lockedProfitDegradationDuration, vaultAccount.feeState.accumulatedLpAdminFees, vaultAccount.feeState.accumulatedLpManagerFees, vaultAccount.feeState.accumulatedLpProtocolFees, vaultAccount.feeConfiguration.redemptionFee, lpSupply, amountLpEscrowed).toNumber();
+        // Cap the withdrawal amount to the initial request amount
+        const amountAssetToWithdrawEffective = Math.min(amountAssetToWithdrawAtPresent, amountAssetToWithdrawAtRequest);
+        return {
+            user: receipt.account.user,
+            amountAssetToWithdrawEffective,
+            amountAssetToWithdrawAtRequest,
+            amountAssetToWithdrawAtPresent,
+            amountLpEscrowed: amountLpEscrowed.toNumber(),
+            withdrawableFromTs: receipt.account.withdrawableFromTs.toNumber(),
+        };
+    }
+    /**
+     * Fetches the pending withdrawal for a user
+     * @param vault - Public key of the vault
+     * @param user - Public key of the user
+     * @returns Promise resolving to the pending withdrawal
+     *
+     * @example
+     * ```typescript
+     * const pendingWithdrawal = await client.getPendingWithdrawalForUser(vaultPubkey, userPubkey);
+     * ```
+     */
+    async getPendingWithdrawalForUser(vault, user) {
+        const [vaultAccount, lp] = await Promise.all([
+            this.fetchVaultAccount(vault),
+            (0, spl_token_1.getMint)(this.conn, this.findVaultLpMint(vault)),
+        ]);
+        const requestWithdrawVaultReceiptAddress = this.findRequestWithdrawVaultReceipt(vault, user);
+        const receipt = await this.fetchRequestWithdrawVaultReceiptAccount(requestWithdrawVaultReceiptAddress);
+        return this.processWithdrawalReceipt({ account: receipt }, vaultAccount, new bn_js_1.default(lp.supply.toString()));
+    }
     /**
      * Fetches all pending withdrawals for a vault
      * @param vault - Public key of the vault
@@ -992,28 +1094,13 @@ class VoltrClient extends AccountUtils {
      * ```
      */
     async getAllPendingWithdrawalsForVault(vault) {
-        const requestWithdrawVaultReceipts = await this.fetchAllRequestWithdrawVaultReceiptsOfVault(vault);
-        const vaultAccount = await this.fetchVaultAccount(vault);
-        const lpMint = this.findVaultLpMint(vault);
-        const lp = await (0, spl_token_1.getMint)(this.conn, lpMint);
-        return requestWithdrawVaultReceipts.map((receipt) => {
-            const amountAssetToWithdrawDecimal = (0, decimals_1.convertDecimalBitsToDecimal)(receipt.account.amountAssetToWithdrawDecimalBits);
-            const amountAssetToWithdrawAtRequest = amountAssetToWithdrawDecimal.toNumber();
-            const amountLpEscrowed = receipt.account.amountLpEscrowed;
-            const amountAssetToWithdrawAtPresent = this.calculateAssetsForWithdrawHelper(vaultAccount.asset.totalValue, vaultAccount.lockedProfitState.lastUpdatedLockedProfit, vaultAccount.vaultConfiguration.lockedProfitDegradationDuration, vaultAccount.feeState.accumulatedLpAdminFees, vaultAccount.feeState.accumulatedLpManagerFees, vaultAccount.feeState.accumulatedLpProtocolFees, vaultAccount.feeConfiguration.redemptionFee, new bn_js_1.default(lp.supply.toString()), amountLpEscrowed).toNumber();
-            // Get the capped amount of asset to withdraw
-            // If the latest amount of asset to withdraw is greater than the initial amount of asset to withdraw,
-            // then return the initial amount of asset to withdraw
-            // Otherwise, return the latest amount of asset to withdraw
-            const amountAssetToWithdrawEffective = Math.min(amountAssetToWithdrawAtPresent, amountAssetToWithdrawAtRequest);
-            return {
-                amountAssetToWithdrawEffective,
-                amountAssetToWithdrawAtRequest,
-                amountAssetToWithdrawAtPresent,
-                amountLpEscrowed: amountLpEscrowed.toNumber(),
-                withdrawableFromTs: receipt.account.withdrawableFromTs.toNumber(),
-            };
-        });
+        const [requestWithdrawVaultReceipts, vaultAccount, lp] = await Promise.all([
+            this.fetchAllRequestWithdrawVaultReceiptsOfVault(vault),
+            this.fetchVaultAccount(vault),
+            (0, spl_token_1.getMint)(this.conn, this.findVaultLpMint(vault)),
+        ]);
+        const lpSupply = new bn_js_1.default(lp.supply.toString());
+        return Promise.all(requestWithdrawVaultReceipts.map((receipt) => this.processWithdrawalReceipt(receipt, vaultAccount, lpSupply)));
     }
     calculateLockedProfit(lastUpdatedLockedProfit, lockedProfitDegradationDuration, currentTime) {
         if (lockedProfitDegradationDuration.eq(new bn_js_1.default(0)))

package/package.json

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