@drift-labs/vaults-sdk 0.1.415 → 0.1.417

package/lib/types/types.d.ts

@@ -19,6 +19,36 @@ export type WithdrawRequest = {
     value: BN;
     ts: BN;
 };
+export type VaultParams = {
+    name: number[];
+    spotMarketIndex: number;
+    redeemPeriod: BN;
+    maxTokens: BN;
+    minDepositAmount: BN;
+    managementFee: BN;
+    profitShare: number;
+    hurdleRate: number;
+    permissioned: boolean;
+    vaultProtocol: VaultProtocolParams | null;
+};
+export type VaultProtocolParams = {
+    protocol: PublicKey;
+    protocolFee: BN;
+    protocolProfitShare: number;
+};
+export type UpdateVaultParams = {
+    redeemPeriod: BN | null;
+    maxTokens: BN | null;
+    minDepositAmount: BN | null;
+    managementFee: BN | null;
+    profitShare: number | null;
+    hurdleRate: number | null;
+    permissioned: boolean | null;
+};
+export type UpdateVaultProtocolParams = {
+    protocolFee: BN | null;
+    protocolProfitShare: number | null;
+};
 export type Vault = {
     name: number[];
     pubkey: PublicKey;
@@ -53,6 +83,7 @@ export type Vault = {
     bump: number;
     permissioned: boolean;
     lastManagerWithdrawRequest: WithdrawRequest;
+    vaultProtocol: PublicKey;
 };
 export type VaultDepositor = {
     vault: PublicKey;
@@ -67,7 +98,20 @@ export type VaultDepositor = {
     cumulativeProfitShareAmount: BN;
     vaultSharesBase: number;
     profitShareFeePaid: BN;
-    padding: number[];
+    padding1: number;
+    padding: BN[];
+};
+export type VaultProtocol = {
+    protocol: PublicKey;
+    protocolProfitAndFeeShares: BN;
+    protocolFee: BN;
+    protocolTotalWithdraws: BN;
+    protocolTotalFee: BN;
+    protocolTotalProfitShare: BN;
+    lastProtocolWithdrawRequest: WithdrawRequest;
+    protocolProfitShare: number;
+    bump: number;
+    version: number;
 };
 export type VaultsProgramAccountBaseEvents = {
     update: void;
@@ -125,6 +169,27 @@ export type VaultDepositorRecord = {
     managementFee: BN;
     managementFeeShares: BN;
 };
+export type VaultDepositorV1Record = {
+    ts: BN;
+    vault: PublicKey;
+    depositorAuthority: PublicKey;
+    action: VaultDepositorAction;
+    amount: BN;
+    spotMarketIndex: number;
+    vaultSharesBefore: BN;
+    vaultSharesAfter: BN;
+    vaultEquityBefore: BN;
+    userVaultSharesBefore: BN;
+    totalVaultSharesBefore: BN;
+    userVaultSharesAfter: BN;
+    totalVaultSharesAfter: BN;
+    protocolProfitShare: BN;
+    protocolFee: BN;
+    protocolFeeShares: BN;
+    managerProfitShare: BN;
+    managementFee: BN;
+    managementFeeShares: BN;
+};
 export type VaultsEventMap = {
     VaultDepositorRecord: Event<VaultDepositorRecord>;
 };

package/lib/vaultClient.d.ts

@@ -2,8 +2,8 @@ import { BN, DriftClient, UserMap } from '@drift-labs/sdk';
 import { Program, ProgramAccount } from '@coral-xyz/anchor';
 import { DriftVaults } from './types/drift_vaults';
 import { CompetitionsClient } from '@drift-labs/competitions-sdk';
-import { AddressLookupTableAccount, PublicKey, TransactionInstruction, TransactionSignature, VersionedTransaction } from '@solana/web3.js';
-import { Vault, VaultDepositor, WithdrawUnit } from './types/types';
+import { AccountMeta, AddressLookupTableAccount, PublicKey, TransactionInstruction, TransactionSignature, VersionedTransaction } from '@solana/web3.js';
+import { Vault, VaultDepositor, VaultProtocol, VaultProtocolParams, WithdrawUnit } from './types/types';
 import { UserMapConfig } from '@drift-labs/sdk/lib/userMap/userMapConfig';
 export type TxParams = {
     cuLimit?: number;
@@ -25,6 +25,10 @@ export declare class VaultClient {
         cliMode?: boolean;
         userMapConfig?: UserMapConfig;
     });
+    /**
+     * Unsubscribes from the vault users map. Call this to clean up any dangling promises.
+     */
+    unsubscribe(): Promise<void>;
     getVault(vault: PublicKey): Promise<Vault>;
     getVaultAndSlot(vault: PublicKey): Promise<{
         vault: Vault;
@@ -35,26 +39,55 @@ export declare class VaultClient {
         vaultDepositor: any;
         slot: number;
     }>;
+    getVaultProtocolAddress(vault: PublicKey): PublicKey;
+    getVaultProtocol(vaultProtocol: PublicKey): Promise<VaultProtocol>;
+    getVaultProtocolAndSlot(vaultProtocol: PublicKey): Promise<{
+        vaultProtocol: VaultProtocol;
+        slot: number;
+    }>;
     getAllVaultDepositorsWithNoWithdrawRequest(vault: PublicKey): Promise<ProgramAccount<VaultDepositor>[]>;
     getAllVaultDepositors(vault: PublicKey): Promise<ProgramAccount<VaultDepositor>[]>;
     getSubscribedVaultUser(vaultDriftUserAccountPubKey: PublicKey): Promise<import("@drift-labs/sdk").User>;
     /**
      *
      * @param vault pubkey
+     * @param factorUnrealizedPNL add unrealized pnl to net balance
      * @returns vault equity, in USDC
      */
     calculateVaultEquity(params: {
         address?: PublicKey;
         vault?: Vault;
+        factorUnrealizedPNL?: boolean;
     }): Promise<BN>;
     /**
      *
      * @param vault pubkey
-     * @returns vault equity, in spot deposit asset
+     * @param factorUnrealizedPNL add unrealized pnl to existing equity
+     * @returns total vault equity, in spot deposit asset
      */
     calculateVaultEquityInDepositAsset(params: {
         address?: PublicKey;
         vault?: Vault;
+        factorUnrealizedPNL?: boolean;
+    }): Promise<BN>;
+    /**
+     * @param params
+     * @returns vault depositor equity, in spot market value (which is usually USDC)
+     */
+    calculateWithdrawableVaultDepositorEquity(params: {
+        vaultDepositorAddress?: PublicKey;
+        vaultDepositor?: VaultDepositor;
+        vaultAddress?: PublicKey;
+        vault?: Vault;
+    }): Promise<BN>;
+    calculateWithdrawableVaultDepositorEquityInDepositAsset(params: {
+        vaultDepositorAddress?: PublicKey;
+        vaultDepositor?: VaultDepositor;
+        vaultAddress?: PublicKey;
+        vault?: Vault;
+    }): Promise<BN>;
+    calculateVaultProtocolEquity(params: {
+        vault: PublicKey;
     }): Promise<BN>;
     initializeVault(params: {
         name: number[];
@@ -66,6 +99,7 @@ export declare class VaultClient {
         profitShare: number;
         hurdleRate: number;
         permissioned: boolean;
+        vaultProtocol?: VaultProtocolParams;
     }): Promise<TransactionSignature>;
     /**
      * Updates the delegate address for a vault. The delegate address will be allowed to trade
@@ -78,7 +112,7 @@ export declare class VaultClient {
     /**
      * Updates the vault margin trading status.
      * @param vault vault address to update
-     * @param enabeld whether to enable margin trading
+     * @param enabled whether to enable margin trading
      * @returns
      */
     updateMarginTradingEnabled(vault: PublicKey, enabled: boolean): Promise<TransactionSignature>;
@@ -152,6 +186,7 @@ export declare class VaultClient {
             spotMarketIndex: number;
             bump: number;
             permissioned: boolean;
+            vaultProtocol: PublicKey;
             padding: BN[];
         };
         accounts: {
@@ -166,8 +201,17 @@ export declare class VaultClient {
             driftProgram: PublicKey;
             tokenProgram: PublicKey;
         };
-        remainingAccounts: import("@solana/web3.js").AccountMeta[];
+        remainingAccounts: AccountMeta[];
     }>;
+    /**
+     * Creates a transaction to deposit funds into the specified vault.
+     * Uses the associated token account of the vault depositor authority and spot market mint,
+     * and assumes it exists before calling this function.
+     * @param vaultDepositor
+     * @param amount
+     * @param initVaultDepositor If true, will initialize the vault depositor account
+     * @returns transaction
+     */
     createDepositTx(vaultDepositor: PublicKey, amount: BN, initVaultDepositor?: {
         authority: PublicKey;
         vault: PublicKey;
@@ -177,6 +221,7 @@ export declare class VaultClient {
      * @param vaultDepositor
      * @param amount
      * @param initVaultDepositor If true, will initialize the vault depositor account
+     * @param txParams
      * @returns
      */
     deposit(vaultDepositor: PublicKey, amount: BN, initVaultDepositor?: {
@@ -214,4 +259,7 @@ export declare class VaultClient {
      * @returns
      */
     initializeCompetitor(vault: PublicKey, competitionsClient: CompetitionsClient, competitionName: string): Promise<TransactionSignature>;
+    protocolRequestWithdraw(vault: PublicKey, amount: BN, withdrawUnit: WithdrawUnit): Promise<TransactionSignature>;
+    protocolCancelWithdrawRequest(vault: PublicKey): Promise<TransactionSignature>;
+    protocolWithdraw(vault: PublicKey): Promise<TransactionSignature>;
 }