@voltr/vault-sdk 0.1.2 → 0.1.4

package/README.md

@@ -6,10 +6,10 @@ A TypeScript SDK for interacting with the Voltr protocol on Solana.
 
 - Complete TypeScript support with type definitions
 - Comprehensive vault management functionality
-- Strategy handling and execution
-- Asset deposit and withdrawal operations
-- PDA (Program Derived Address) utilities
-- Account data fetching and parsing
+- Strategy handling and execution with adaptor support
+- Asset deposit and withdrawal operations with direct withdraw capability
+- Account data fetching and PDA (Program Derived Address) utilities
+- Position and total value tracking
 
 ## Installation
 
@@ -60,28 +60,6 @@ const ix = await client.createInitializeVaultIx(vaultParams, {
 });
 ```
 
-### Deposit Assets
-
-```typescript
-const depositIx = await client.createDepositIx(new BN("1000000000"), {
-  userAuthority: userPubkey,
-  vault: vaultPubkey,
-  vaultAssetMint: mintPubkey,
-  assetTokenProgram: tokenProgramPubkey,
-});
-```
-
-### Withdraw Assets
-
-```typescript
-const withdrawIx = await client.createWithdrawIx(new BN("1000000000"), {
-  userAuthority: userPubkey,
-  vault: vaultPubkey,
-  vaultAssetMint: mintPubkey,
-  assetTokenProgram: tokenProgramPubkey,
-});
-```
-
 ### Strategy Management
 
 ```typescript
@@ -89,6 +67,7 @@ const withdrawIx = await client.createWithdrawIx(new BN("1000000000"), {
 const addAdaptorIx = await client.createAddAdaptorIx({
   vault: vaultPubkey,
   payer: payerPubkey,
+  admin: adminPubkey,
   adaptorProgram: adaptorProgramPubkey,
 });
 
@@ -104,20 +83,58 @@ const initStrategyIx = await client.createInitializeStrategyIx(
     manager: managerPubkey,
     strategy: strategyPubkey,
     adaptorProgram: adaptorProgramPubkey,
+    remainingAccounts: [],
   }
 );
 
-// Deposit into a strategy
-const depositStrategyIx = await client.createDepositStrategyIx(
+// Initialize direct withdraw strategy
+const initDirectWithdrawIx =
+  await client.createInitializeDirectWithdrawStrategyIx(
+    {
+      instructionDiscriminator: null,
+      additionalArgs: null,
+      allowUserArgs: true,
+    },
+    {
+      payer: payerPubkey,
+      admin: adminPubkey,
+      vault: vaultPubkey,
+      strategy: strategyPubkey,
+      adaptorProgram: adaptorProgramPubkey,
+    }
+  );
+```
+
+### Asset Operations
+
+```typescript
+// Deposit assets
+const depositIx = await client.createDepositIx(new BN("1000000000"), {
+  userAuthority: userPubkey,
+  vault: vaultPubkey,
+  vaultAssetMint: mintPubkey,
+  assetTokenProgram: tokenProgramPubkey,
+});
+
+// Withdraw assets
+const withdrawIx = await client.createWithdrawIx(new BN("1000000000"), {
+  userAuthority: userPubkey,
+  vault: vaultPubkey,
+  vaultAssetMint: mintPubkey,
+  assetTokenProgram: tokenProgramPubkey,
+});
+
+// Direct withdraw from strategy
+const directWithdrawIx = await client.createDirectWithdrawStrategyIx(
   {
-    depositAmount: new BN("1000000000"),
-    instructionDiscriminator: null,
-    additionalArgs: null,
+    withdrawAmount: new BN("1000000000"),
+    userArgs: null,
   },
   {
+    user: userPubkey,
     vault: vaultPubkey,
-    vaultAssetMint: mintPubkey,
     strategy: strategyPubkey,
+    vaultAssetMint: mintPubkey,
     assetTokenProgram: tokenProgramPubkey,
     adaptorProgram: adaptorProgramPubkey,
     remainingAccounts: [],
@@ -125,53 +142,56 @@ const depositStrategyIx = await client.createDepositStrategyIx(
 );
 ```
 
-## API Reference
-
-### VoltrClient
-
-The main client class for interacting with the Voltr protocol.
-
-#### Constructor
+### Position and Value Tracking
 
 ```typescript
-constructor(conn: Connection, wallet?: Keypair)
+// Get position and total values for a vault
+const values = await client.getPositionAndTotalValuesForVault(vaultPubkey);
+console.log(`Total Value: ${values.totalValue}`);
+console.log("Strategy Positions:", values.strategies);
 ```
 
-#### Vault Management Methods
+## API Reference
+
+### VoltrClient Methods
+
+#### Vault Management
 
-- `createInitializeVaultIx(vaultParams: VaultParams, params: InitializeParams)`
-- `createDepositIx(amount: BN, params: DepositParams)`
-- `createWithdrawIx(amount: BN, params: WithdrawParams)`
+- `createInitializeVaultIx(vaultParams, params)`
+- `createDepositIx(amount, params)`
+- `createWithdrawIx(amount, params)`
 
-#### Strategy Management Methods
+#### Strategy Management
 
-- `createAddAdaptorIx(params: AddAdaptorParams)`
-- `createInitializeStrategyIx(initArgs: InitializeStrategyArgs, params: InitStrategyParams)`
-- `createDepositStrategyIx(depositArgs: depositStrategyArgs, params: DepositStrategyParams)`
-- `createWithdrawStrategyIx(withdrawArgs: withdrawStrategyArgs, params: WithdrawStrategyParams)`
-- `createRemoveStrategyIx(params: RemoveStrategyParams)`
+- `createAddAdaptorIx(params)`
+- `createInitializeStrategyIx(initArgs, params)`
+- `createDepositStrategyIx(depositArgs, params)`
+- `createWithdrawStrategyIx(withdrawArgs, params)`
+- `createInitializeDirectWithdrawStrategyIx(initArgs, params)`
+- `createDirectWithdrawStrategyIx(withdrawArgs, params)`
+- `createRemoveAdaptorIx(params)`
 
-#### Account Fetching Methods
+#### Account Data
 
-- `fetchVaultAccount(vault: PublicKey)`
+- `fetchVaultAccount(vault)`
 - `fetchAllStrategyInitReceiptAccounts()`
-- `fetchAllStrategyInitReceiptAccountsOfVault(vault: PublicKey)`
-- `fetchAllAdaptorAddReceiptAccountsOfVault(vault: PublicKey)`
-- `getPositionAndTotalValuesForVault(vault: PublicKey)`
+- `fetchAllStrategyInitReceiptAccountsOfVault(vault)`
+- `fetchAllAdaptorAddReceiptAccountsOfVault(vault)`
+- `getPositionAndTotalValuesForVault(vault)`
 
-#### PDA Finding Methods
+#### PDA Finding
 
-- `findVaultLpMint(vault: PublicKey)`
-- `findVaultAssetIdleAuth(vault: PublicKey)`
-- `findVaultLpFeeAuth(vault: PublicKey)`
-- `findVaultAddresses(vault: PublicKey)`
-- `findVaultStrategyAuth(vault: PublicKey, strategy: PublicKey)`
-- `findStrategyInitReceipt(vault: PublicKey, strategy: PublicKey)`
+- `findVaultLpMint(vault)`
+- `findVaultAssetIdleAuth(vault)`
+- `findVaultAddresses(vault)`
+- `findVaultStrategyAuth(vault, strategy)`
+- `findStrategyInitReceipt(vault, strategy)`
+- `findDirectWithdrawInitReceipt(vault, strategy)`
 
-#### Calculation Methods
+#### Calculations
 
-- `calculateAssetsForWithdraw(vaultPk: PublicKey, lpAmount: BN)`
-- `calculateLpTokensForDeposit(depositAmount: BN, vaultPk: PublicKey)`
+- `calculateAssetsForWithdraw(vaultPk, lpAmount)`
+- `calculateLpTokensForDeposit(depositAmount, vaultPk)`
 
 ## License
 

package/dist/client.d.ts

@@ -1,6 +1,6 @@
 import { Program, AnchorProvider, Idl, BN } from "@coral-xyz/anchor";
 import { Connection, Keypair, PublicKey, TransactionInstruction } from "@solana/web3.js";
-import { VaultParams, VoltrVault, InitializeStrategyArgs, DepositStrategyArgs, WithdrawStrategyArgs, InitializeDirectWithdrawStrategyArgs, DirectWithdrawStrategyArgs } from "./types";
+import { VaultParams, VaultConfig, VoltrVault, InitializeStrategyArgs, DepositStrategyArgs, WithdrawStrategyArgs, InitializeDirectWithdrawStrategyArgs, DirectWithdrawStrategyArgs } from "./types";
 declare class AccountUtils {
     conn: Connection;
     constructor(conn: Connection);
@@ -165,7 +165,40 @@ export declare class VoltrClient extends AccountUtils {
         payer: PublicKey;
     }): Promise<TransactionInstruction>;
     /**
-     * Creates a deposit instruction
+     * Creates an instruction to update a vault
+     * @param {VaultConfig} vaultConfig - Configuration parameters for the vault
+     * @param {BN} vaultConfig.maxCap - Maximum capacity of the vault
+     * @param {BN} vaultConfig.startAtTs - Vault start timestamp in seconds
+     * @param {number} vaultConfig.managerManagementFee - Manager's management fee in basis points (e.g., 50 = 0.5%)
+     * @param {number} vaultConfig.managerPerformanceFee - Manager's performance fee in basis points (e.g., 1000 = 10%)
+     * @param {number} vaultConfig.adminManagementFee - Admin's management fee in basis points (e.g., 50 = 0.5%)
+     * @param {number} vaultConfig.adminPerformanceFee - Admin's performance fee in basis points (e.g., 1000 = 10%)
+     * @param {Object} params - Parameters for updating the vault
+     * @param {PublicKey} params.vault - Public key of the vault
+     * @param {PublicKey} params.admin - Public key of the vault admin
+     * @returns Transaction instruction for updating the vault
+     *
+     * @example
+     * ```typescript
+     * const ix = await client.createUpdateVaultIx(
+     *   {
+     *     maxCap: new BN('1000000000'),
+     *     startAtTs: new BN(Math.floor(Date.now() / 1000)),
+     *     managerManagementFee: 50,
+     *     managerPerformanceFee: 1000,
+     *     adminManagementFee: 50,
+     *     adminPerformanceFee: 1000,
+     *   },
+     *   { vault: vaultPubkey, admin: adminPubkey }
+     * );
+     * ```
+     */
+    createUpdateVaultIx(vaultConfig: VaultConfig, { vault, admin, }: {
+        vault: PublicKey;
+        admin: PublicKey;
+    }): Promise<TransactionInstruction>;
+    /**
+     * Creates a deposit instruction for a vault
      *
      * @param {BN} amount - Amount of tokens to deposit
      * @param {Object} params - Deposit parameters
@@ -178,7 +211,7 @@ export declare class VoltrClient extends AccountUtils {
      *
      * @example
      * ```typescript
-     * const ix = await client.createDepositIx(
+     * const ix = await client.createDepositVaultIx(
      *   new BN('1000000000'),
      *   {
      *     userAuthority: userPubkey,
@@ -189,14 +222,14 @@ export declare class VoltrClient extends AccountUtils {
      * );
      * ```
      */
-    createDepositIx(amount: BN, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
+    createDepositVaultIx(amount: BN, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
         userAuthority: PublicKey;
         vault: PublicKey;
         vaultAssetMint: PublicKey;
         assetTokenProgram: PublicKey;
     }): Promise<TransactionInstruction>;
     /**
-     * Creates a withdraw instruction
+     * Creates a withdraw instruction for a vault
      *
      * @param amount - Amount of LP tokens to withdraw
      * @param {Object} params - Withdraw parameters
@@ -209,7 +242,7 @@ export declare class VoltrClient extends AccountUtils {
      * @throws {Error} If the instruction creation fails
      *
      * @example
-     * const ix = await client.createWithdrawIx(
+     * const ix = await client.createWithdrawVaultIx(
      *   new BN('1000000000'),
      *   {
      *     userAuthority: userPubkey,
@@ -219,7 +252,7 @@ export declare class VoltrClient extends AccountUtils {
      *   }
      * );
      */
-    createWithdrawIx(amount: BN, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
+    createWithdrawVaultIx(amount: BN, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }: {
         userAuthority: PublicKey;
         vault: PublicKey;
         vaultAssetMint: PublicKey;

package/dist/client.js

@@ -278,7 +278,7 @@ class VoltrClient extends AccountUtils {
         const addresses = this.findVaultAddresses(vault.publicKey);
         const vaultAssetIdleAta = (0, spl_token_1.getAssociatedTokenAddressSync)(vaultAssetMint, addresses.vaultAssetIdleAuth, true);
         return await this.vaultProgram.methods
-            .initialize(vaultParams.config, vaultParams.name, vaultParams.description)
+            .initializeVault(vaultParams.config, vaultParams.name, vaultParams.description)
             .accounts({
             payer,
             admin,
@@ -291,7 +291,45 @@ class VoltrClient extends AccountUtils {
             .instruction();
     }
     /**
-     * Creates a deposit instruction
+     * Creates an instruction to update a vault
+     * @param {VaultConfig} vaultConfig - Configuration parameters for the vault
+     * @param {BN} vaultConfig.maxCap - Maximum capacity of the vault
+     * @param {BN} vaultConfig.startAtTs - Vault start timestamp in seconds
+     * @param {number} vaultConfig.managerManagementFee - Manager's management fee in basis points (e.g., 50 = 0.5%)
+     * @param {number} vaultConfig.managerPerformanceFee - Manager's performance fee in basis points (e.g., 1000 = 10%)
+     * @param {number} vaultConfig.adminManagementFee - Admin's management fee in basis points (e.g., 50 = 0.5%)
+     * @param {number} vaultConfig.adminPerformanceFee - Admin's performance fee in basis points (e.g., 1000 = 10%)
+     * @param {Object} params - Parameters for updating the vault
+     * @param {PublicKey} params.vault - Public key of the vault
+     * @param {PublicKey} params.admin - Public key of the vault admin
+     * @returns Transaction instruction for updating the vault
+     *
+     * @example
+     * ```typescript
+     * const ix = await client.createUpdateVaultIx(
+     *   {
+     *     maxCap: new BN('1000000000'),
+     *     startAtTs: new BN(Math.floor(Date.now() / 1000)),
+     *     managerManagementFee: 50,
+     *     managerPerformanceFee: 1000,
+     *     adminManagementFee: 50,
+     *     adminPerformanceFee: 1000,
+     *   },
+     *   { vault: vaultPubkey, admin: adminPubkey }
+     * );
+     * ```
+     */
+    async createUpdateVaultIx(vaultConfig, { vault, admin, }) {
+        return await this.vaultProgram.methods
+            .updateVault(vaultConfig)
+            .accountsPartial({
+            admin,
+            vault,
+        })
+            .instruction();
+    }
+    /**
+     * Creates a deposit instruction for a vault
      *
      * @param {BN} amount - Amount of tokens to deposit
      * @param {Object} params - Deposit parameters
@@ -304,7 +342,7 @@ class VoltrClient extends AccountUtils {
      *
      * @example
      * ```typescript
-     * const ix = await client.createDepositIx(
+     * const ix = await client.createDepositVaultIx(
      *   new BN('1000000000'),
      *   {
      *     userAuthority: userPubkey,
@@ -315,9 +353,9 @@ class VoltrClient extends AccountUtils {
      * );
      * ```
      */
-    async createDepositIx(amount, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
+    async createDepositVaultIx(amount, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
         return await this.vaultProgram.methods
-            .deposit(amount)
+            .depositVault(amount)
             .accounts({
             userTransferAuthority: userAuthority,
             vault,
@@ -327,7 +365,7 @@ class VoltrClient extends AccountUtils {
             .instruction();
     }
     /**
-     * Creates a withdraw instruction
+     * Creates a withdraw instruction for a vault
      *
      * @param amount - Amount of LP tokens to withdraw
      * @param {Object} params - Withdraw parameters
@@ -340,7 +378,7 @@ class VoltrClient extends AccountUtils {
      * @throws {Error} If the instruction creation fails
      *
      * @example
-     * const ix = await client.createWithdrawIx(
+     * const ix = await client.createWithdrawVaultIx(
      *   new BN('1000000000'),
      *   {
      *     userAuthority: userPubkey,
@@ -350,9 +388,9 @@ class VoltrClient extends AccountUtils {
      *   }
      * );
      */
-    async createWithdrawIx(amount, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
+    async createWithdrawVaultIx(amount, { userAuthority, vault, vaultAssetMint, assetTokenProgram, }) {
         return await this.vaultProgram.methods
-            .withdraw(amount)
+            .withdrawVault(amount)
             .accounts({
             userTransferAuthority: userAuthority,
             vault,
@@ -737,7 +775,7 @@ class VoltrClient extends AccountUtils {
      * @returns Promise resolving to the vault account data
      */
     async fetchVaultAccount(vault) {
-        return await this.vaultProgram.account.vault.fetch(vault);
+        return await this.vaultProgram.account.vault.fetch(vault, "confirmed");
     }
     /**
      * Fetches a strategy init receipt account's data
@@ -750,7 +788,7 @@ class VoltrClient extends AccountUtils {
      * ```
      */
     async fetchStrategyInitReceiptAccount(strategyInitReceipt) {
-        return await this.vaultProgram.account.strategyInitReceipt.fetch(strategyInitReceipt);
+        return await this.vaultProgram.account.strategyInitReceipt.fetch(strategyInitReceipt, "confirmed");
     }
     /**
      * Fetches an adaptor add receipt account's data
@@ -763,7 +801,7 @@ class VoltrClient extends AccountUtils {
      * ```
      */
     async fetchAdaptorAddReceiptAccount(adaptorAddReceipt) {
-        return await this.vaultProgram.account.adaptorAddReceipt.fetch(adaptorAddReceipt);
+        return await this.vaultProgram.account.adaptorAddReceipt.fetch(adaptorAddReceipt, "confirmed");
     }
     // --------------------------------------- Helpers
     /**