@voltr/vault-sdk 1.0.0 → 1.0.2

package/README.md

@@ -46,8 +46,8 @@ const vaultParams = {
     managerPerformanceFee: 1000, // 10%
     adminManagementFee: 50, // 0.5%
     adminPerformanceFee: 1000, // 10%
-    redemptionFeePercentageBps: 10, // 0.1%
-    issuanceFeePercentageBps: 10, // 0.1%
+    redemptionFee: 10, // 0.1%
+    issuanceFee: 10, // 0.1%
     withdrawalWaitingPeriod: new BN(3600), // 1 hour
   },
   name: "My Vault",
@@ -113,8 +113,8 @@ const initDirectWithdrawIx =
 
 ```typescript
 // Deposit assets
-const depositIx = await client.createDepositIx(new BN("1000000000"), {
-  userAuthority: userPubkey,
+const depositIx = await client.createDepositVaultIx(new BN("1000000000"), {
+  userTransferAuthority: userPubkey,
   vault: vaultPubkey,
   vaultAssetMint: mintPubkey,
   assetTokenProgram: tokenProgramPubkey,
@@ -129,7 +129,7 @@ const requestWithdrawIx = await client.createRequestWithdrawVaultIx(
   },
   {
     payer: payerPubkey,
-    userAuthority: userPubkey,
+    userTransferAuthority: userPubkey,
     vault: vaultPubkey,
   }
 );
@@ -137,14 +137,14 @@ const requestWithdrawIx = await client.createRequestWithdrawVaultIx(
 // Cancel withdraw request
 const cancelRequestWithdrawIx = await client.createCancelRequestWithdrawVaultIx(
   {
-    userAuthority: userPubkey,
+    userTransferAuthority: userPubkey,
     vault: vaultPubkey,
   }
 );
 
 // Withdraw from vault
-const withdrawIx = await client.createWithdrawIx({
-  userAuthority: userPubkey,
+const withdrawIx = await client.createWithdrawVaultIx({
+  userTransferAuthority: userPubkey,
   vault: vaultPubkey,
   vaultAssetMint: mintPubkey,
   assetTokenProgram: tokenProgramPubkey,
@@ -176,6 +176,66 @@ console.log(`Total Value: ${values.totalValue}`);
 console.log("Strategy Positions:", values.strategies);
 ```
 
+### Asset Calculation Utilities
+
+```typescript
+// Calculate the amount of assets that would be received for a given LP token amount
+const assetsToReceive = await client.calculateAssetsForWithdraw(
+  vaultPubkey,
+  new BN("1000000000")
+);
+console.log(`Assets to receive: ${assetsToReceive.toString()}`);
+
+// Calculate the amount of LP tokens needed to withdraw a specific asset amount
+const lpTokensRequired = await client.calculateLpForWithdraw(
+  vaultPubkey,
+  new BN("1000000000")
+);
+console.log(`LP tokens required: ${lpTokensRequired.toString()}`);
+
+// Calculate the amount of LP tokens that would be received for a deposit
+const lpTokensToReceive = await client.calculateLpForDeposit(
+  vaultPubkey,
+  new BN("1000000000")
+);
+console.log(`LP tokens to receive: ${lpTokensToReceive.toString()}`);
+```
+
+### Querying Pending Withdrawals
+
+```typescript
+// Get all pending withdrawals for a vault
+const pendingWithdrawals = await client.getAllPendingWithdrawalsForVault(
+  vaultPubkey
+);
+
+// Process the pending withdrawals
+pendingWithdrawals.forEach((withdrawal, index) => {
+  console.log(`Withdrawal ${index + 1}:`);
+  console.log(`  Asset amount: ${withdrawal.amountAssetToWithdraw}`);
+
+  // Check if withdrawal is available yet
+  const withdrawableTimestamp = withdrawal.withdrawableFromTs.toNumber();
+  const currentTime = Math.floor(Date.now() / 1000);
+  const isWithdrawable = currentTime >= withdrawableTimestamp;
+
+  console.log(
+    `  Withdrawable from: ${new Date(
+      withdrawableTimestamp * 1000
+    ).toLocaleString()}`
+  );
+  console.log(`  Status: ${isWithdrawable ? "Available now" : "Pending"}`);
+  if (!isWithdrawable) {
+    const timeRemaining = Math.max(0, withdrawableTimestamp - currentTime);
+    console.log(
+      `  Time remaining: ${Math.floor(timeRemaining / 3600)}h ${Math.floor(
+        (timeRemaining % 3600) / 60
+      )}m`
+    );
+  }
+});
+```
+
 ## API Reference
 
 ### VoltrClient Methods
@@ -183,6 +243,7 @@ console.log("Strategy Positions:", values.strategies);
 #### Vault Management
 
 - `createInitializeVaultIx(vaultParams, params)`
+- `createUpdateVaultIx(vaultConfig, params)`
 - `createRequestWithdrawVaultIx(requestWithdrawArgs, params)`
 - `createCancelRequestWithdrawVaultIx(params)`
 - `createWithdrawVaultIx(params)`

package/dist/client.d.ts

@@ -223,7 +223,7 @@ export declare class VoltrClient extends AccountUtils {
      *
      * @param {BN} amount - Amount of tokens to deposit
      * @param {Object} params - Deposit parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user's transfer authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user's transfer authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @param {PublicKey} params.vaultAssetMint - Public key of the vault asset mint
      * @param {PublicKey} params.assetTokenProgram - Public key of the asset token program
@@ -235,7 +235,7 @@ export declare class VoltrClient extends AccountUtils {
      * const ix = await client.createDepositVaultIx(
      *   new BN('1000000000'),
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *     vaultAssetMint: mintPubkey,
      *     assetTokenProgram: tokenProgramPubkey
@@ -243,8 +243,8 @@ export declare class VoltrClient extends AccountUtils {
      * );
      * ```
      */
-    createDepositVaultIx(amount: BN, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
-        userAuthority: PublicKey;
+    createDepositVaultIx(amount: BN, { userTransferAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
+        userTransferAuthority: PublicKey;
         vault: PublicKey;
         vaultAssetMint: PublicKey;
         assetTokenProgram: PublicKey;
@@ -258,7 +258,7 @@ export declare class VoltrClient extends AccountUtils {
      * @param {boolean} requestWithdrawArgs.isWithdrawAll - Whether to withdraw all assets
      * @param {Object} params - Request withdraw parameters
      * @param {PublicKey} params.payer - Public key of the payer
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @returns {Promise<TransactionInstruction>} Transaction instruction for withdrawal
      *
@@ -273,21 +273,21 @@ export declare class VoltrClient extends AccountUtils {
      *   },
      *   {
      *     payer: payerPubkey,
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *   }
      * );
      */
-    createRequestWithdrawVaultIx({ amount, isAmountInLp, isWithdrawAll }: RequestWithdrawVaultArgs, { payer, userAuthority, vault, }: {
+    createRequestWithdrawVaultIx({ amount, isAmountInLp, isWithdrawAll }: RequestWithdrawVaultArgs, { payer, userTransferAuthority, vault, }: {
         payer: PublicKey;
-        userAuthority: PublicKey;
+        userTransferAuthority: PublicKey;
         vault: PublicKey;
     }): Promise<TransactionInstruction>;
     /**
      * Creates a cancel withdraw instruction for a vault
      *
      * @param {Object} params - Cancel withdraw request parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @returns {Promise<TransactionInstruction>} Transaction instruction for withdrawal
      *
@@ -296,20 +296,20 @@ export declare class VoltrClient extends AccountUtils {
      * @example
      * const ix = await client.createCancelRequestWithdrawVaultIx(
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *   }
      * );
      */
-    createCancelRequestWithdrawVaultIx({ userAuthority, vault, }: {
-        userAuthority: PublicKey;
+    createCancelRequestWithdrawVaultIx({ userTransferAuthority, vault, }: {
+        userTransferAuthority: PublicKey;
         vault: PublicKey;
     }): Promise<TransactionInstruction>;
     /**
      * Creates a withdraw instruction for a vault
      *
      * @param {Object} params - Withdraw parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @param {PublicKey} params.vaultAssetMint - Public key of the vault asset mint
      * @param {PublicKey} params.assetTokenProgram - Public key of the asset token program
@@ -320,15 +320,15 @@ export declare class VoltrClient extends AccountUtils {
      * @example
      * const ix = await client.createWithdrawVaultIx(
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *     vaultAssetMint: mintPubkey,
      *     assetTokenProgram: tokenProgramPubkey
      *   }
      * );
      */
-    createWithdrawVaultIx({ userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
-        userAuthority: PublicKey;
+    createWithdrawVaultIx({ userTransferAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
+        userTransferAuthority: PublicKey;
         vault: PublicKey;
         vaultAssetMint: PublicKey;
         assetTokenProgram: PublicKey;
@@ -659,6 +659,25 @@ export declare class VoltrClient extends AccountUtils {
         padding0: number[];
         reserved: number[];
     }>[]>;
+    /**
+     * Fetches all request withdraw vault receipt accounts of a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to an array of request withdraw vault receipt accounts
+     *
+     * @example
+     * ```typescript
+     * const requestWithdrawVaultReceiptAccounts = await client.fetchAllRequestWithdrawVaultReceiptsOfVault(vaultPubkey);
+     * ```
+     */
+    fetchAllRequestWithdrawVaultReceiptsOfVault(vault: PublicKey): Promise<import("@coral-xyz/anchor").ProgramAccount<{
+        vault: PublicKey;
+        user: PublicKey;
+        amountLpEscrowed: BN;
+        amountAssetToWithdrawDecimalBits: BN;
+        withdrawableFromTs: BN;
+        bump: number;
+        version: number;
+    }>[]>;
     /**
      * Fetches all adaptor add receipt accounts of a vault
      * @param vault - Public key of the vault
@@ -787,6 +806,20 @@ export declare class VoltrClient extends AccountUtils {
         lastUpdatedEpoch: BN;
         reserved: number[];
     }>;
+    /**
+     * Fetches all pending withdrawals for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to an array of pending withdrawals
+     *
+     * @example
+     * ```typescript
+     * const pendingWithdrawals = await client.getAllPendingWithdrawalsForVault(vaultPubkey);
+     * ```
+     */
+    getAllPendingWithdrawalsForVault(vault: PublicKey): Promise<{
+        amountAssetToWithdraw: number;
+        withdrawableFromTs: number;
+    }[]>;
     calculateLockedProfit(lastUpdatedLockedProfit: BN, lockedProfitDegradationDuration: BN, currentTime: BN): BN;
     /**
      * Calculates the amount of assets that would be received for a given LP token amount

package/dist/client.js

@@ -44,6 +44,7 @@ const spl_token_1 = require("@solana/spl-token");
 const constants_1 = require("./constants");
 // Import IDL files
 const vaultIdl = __importStar(require("./idl/voltr_vault.json"));
+const decimals_1 = require("./decimals");
 class CustomWallet {
     constructor(payer) {
         this.payer = payer;
@@ -360,7 +361,7 @@ class VoltrClient extends AccountUtils {
      *
      * @param {BN} amount - Amount of tokens to deposit
      * @param {Object} params - Deposit parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user's transfer authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user's transfer authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @param {PublicKey} params.vaultAssetMint - Public key of the vault asset mint
      * @param {PublicKey} params.assetTokenProgram - Public key of the asset token program
@@ -372,7 +373,7 @@ class VoltrClient extends AccountUtils {
      * const ix = await client.createDepositVaultIx(
      *   new BN('1000000000'),
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *     vaultAssetMint: mintPubkey,
      *     assetTokenProgram: tokenProgramPubkey
@@ -380,11 +381,11 @@ class VoltrClient extends AccountUtils {
      * );
      * ```
      */
-    async createDepositVaultIx(amount, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
+    async createDepositVaultIx(amount, { userTransferAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
         return await this.vaultProgram.methods
             .depositVault(amount)
             .accounts({
-            userTransferAuthority: userAuthority,
+            userTransferAuthority,
             vault,
             vaultAssetMint,
             assetTokenProgram,
@@ -400,7 +401,7 @@ class VoltrClient extends AccountUtils {
      * @param {boolean} requestWithdrawArgs.isWithdrawAll - Whether to withdraw all assets
      * @param {Object} params - Request withdraw parameters
      * @param {PublicKey} params.payer - Public key of the payer
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @returns {Promise<TransactionInstruction>} Transaction instruction for withdrawal
      *
@@ -415,17 +416,17 @@ class VoltrClient extends AccountUtils {
      *   },
      *   {
      *     payer: payerPubkey,
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *   }
      * );
      */
-    async createRequestWithdrawVaultIx({ amount, isAmountInLp, isWithdrawAll }, { payer, userAuthority, vault, }) {
+    async createRequestWithdrawVaultIx({ amount, isAmountInLp, isWithdrawAll }, { payer, userTransferAuthority, vault, }) {
         return await this.vaultProgram.methods
             .requestWithdrawVault(amount, isAmountInLp, isWithdrawAll)
             .accounts({
             payer,
-            userTransferAuthority: userAuthority,
+            userTransferAuthority,
             vault,
         })
             .instruction();
@@ -434,7 +435,7 @@ class VoltrClient extends AccountUtils {
      * Creates a cancel withdraw instruction for a vault
      *
      * @param {Object} params - Cancel withdraw request parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @returns {Promise<TransactionInstruction>} Transaction instruction for withdrawal
      *
@@ -443,16 +444,16 @@ class VoltrClient extends AccountUtils {
      * @example
      * const ix = await client.createCancelRequestWithdrawVaultIx(
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *   }
      * );
      */
-    async createCancelRequestWithdrawVaultIx({ userAuthority, vault, }) {
+    async createCancelRequestWithdrawVaultIx({ userTransferAuthority, vault, }) {
         return await this.vaultProgram.methods
             .cancelRequestWithdrawVault()
             .accounts({
-            userTransferAuthority: userAuthority,
+            userTransferAuthority,
             vault,
         })
             .instruction();
@@ -461,7 +462,7 @@ class VoltrClient extends AccountUtils {
      * Creates a withdraw instruction for a vault
      *
      * @param {Object} params - Withdraw parameters
-     * @param {PublicKey} params.userAuthority - Public key of the user authority
+     * @param {PublicKey} params.userTransferAuthority - Public key of the user authority
      * @param {PublicKey} params.vault - Public key of the vault
      * @param {PublicKey} params.vaultAssetMint - Public key of the vault asset mint
      * @param {PublicKey} params.assetTokenProgram - Public key of the asset token program
@@ -472,18 +473,18 @@ class VoltrClient extends AccountUtils {
      * @example
      * const ix = await client.createWithdrawVaultIx(
      *   {
-     *     userAuthority: userPubkey,
+     *     userTransferAuthority: userPubkey,
      *     vault: vaultPubkey,
      *     vaultAssetMint: mintPubkey,
      *     assetTokenProgram: tokenProgramPubkey
      *   }
      * );
      */
-    async createWithdrawVaultIx({ userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
+    async createWithdrawVaultIx({ userTransferAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
         return await this.vaultProgram.methods
             .withdrawVault()
             .accounts({
-            userTransferAuthority: userAuthority,
+            userTransferAuthority,
             vault,
             vaultAssetMint,
             assetTokenProgram,
@@ -824,6 +825,26 @@ class VoltrClient extends AccountUtils {
             },
         ]);
     }
+    /**
+     * Fetches all request withdraw vault receipt accounts of a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to an array of request withdraw vault receipt accounts
+     *
+     * @example
+     * ```typescript
+     * const requestWithdrawVaultReceiptAccounts = await client.fetchAllRequestWithdrawVaultReceiptsOfVault(vaultPubkey);
+     * ```
+     */
+    async fetchAllRequestWithdrawVaultReceiptsOfVault(vault) {
+        return await this.vaultProgram.account.requestWithdrawVaultReceipt.all([
+            {
+                memcmp: {
+                    offset: 8, // 8 for discriminator
+                    bytes: vault.toBase58(),
+                },
+            },
+        ]);
+    }
     /**
      * Fetches all adaptor add receipt accounts of a vault
      * @param vault - Public key of the vault
@@ -893,6 +914,27 @@ class VoltrClient extends AccountUtils {
         return await this.vaultProgram.account.adaptorAddReceipt.fetch(adaptorAddReceipt, "confirmed");
     }
     // --------------------------------------- Helpers
+    /**
+     * Fetches all pending withdrawals for a vault
+     * @param vault - Public key of the vault
+     * @returns Promise resolving to an array of pending withdrawals
+     *
+     * @example
+     * ```typescript
+     * const pendingWithdrawals = await client.getAllPendingWithdrawalsForVault(vaultPubkey);
+     * ```
+     */
+    async getAllPendingWithdrawalsForVault(vault) {
+        const requestWithdrawVaultReceipts = await this.fetchAllRequestWithdrawVaultReceiptsOfVault(vault);
+        return requestWithdrawVaultReceipts.map((receipt) => {
+            const amountAssetToWithdrawDecimal = (0, decimals_1.convertDecimalBitsToDecimal)(receipt.account.amountAssetToWithdrawDecimalBits);
+            const amountAssetToWithdraw = amountAssetToWithdrawDecimal.toNumber();
+            return {
+                amountAssetToWithdraw,
+                withdrawableFromTs: receipt.account.withdrawableFromTs.toNumber(),
+            };
+        });
+    }
     calculateLockedProfit(lastUpdatedLockedProfit, lockedProfitDegradationDuration, currentTime) {
         if (lockedProfitDegradationDuration.eq(new bn_js_1.default(0)))
             return new bn_js_1.default(0);

package/dist/decimals.d.ts

@@ -0,0 +1,3 @@
+import BN from "bn.js";
+import { Decimal } from "decimal.js";
+export declare function convertDecimalBitsToDecimal(value: BN): Decimal;

package/dist/decimals.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertDecimalBitsToDecimal = convertDecimalBitsToDecimal;
+const decimal_js_1 = require("decimal.js");
+const DECIMAL_FRACTIONAL_BYTES = 6;
+const DECIMAL_DIVISOR = new decimal_js_1.Decimal(2).pow(8 * DECIMAL_FRACTIONAL_BYTES);
+function convertDecimalBitsToDecimal(value) {
+    let decimalValue = new decimal_js_1.Decimal(value.toString());
+    return decimalValue.div(DECIMAL_DIVISOR);
+}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./client";
 export * from "./types";
 export * from "./constants";
+export * from "./decimals";

package/dist/index.js

@@ -17,3 +17,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./client"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./constants"), exports);
+__exportStar(require("./decimals"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voltr/vault-sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "SDK for interacting with Voltr Protocol",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -29,7 +29,8 @@
     "@coral-xyz/anchor": "^0.30.1",
     "@solana/spl-token": "^0.4.9",
     "@solana/web3.js": "^1.98.0",
-    "bn.js": "^5.2.1"
+    "bn.js": "^5.2.1",
+    "decimal.js": "^10.5.0"
   },
   "devDependencies": {
     "@types/bn.js": "^5.1.6",