@voltr/vault-sdk 1.0.21 → 2.0.0

package/src/extensions/withdrawals.ts

@@ -0,0 +1,113 @@
+import type { Account, Address } from "@solana/kit";
+
+import {
+  fetchRequestWithdrawVaultReceipt,
+  fetchVault,
+  findRequestWithdrawVaultReceiptPda,
+  findVaultLpMintPda,
+  VOLTR_VAULT_PROGRAM_ADDRESS,
+  type RequestWithdrawVaultReceipt,
+  type Vault,
+} from "../generated";
+import { fetchAllRequestWithdrawVaultReceiptsOfVault } from "./batchFetchers";
+import { convertDecimalBitsToNumber } from "./decimal";
+import { getTotalManagementFeeBps } from "./lpEconomics";
+import { calculateAssetsForWithdrawAmount } from "./math";
+import type { ExtensionsRpc } from "./rpc";
+
+export type PendingWithdrawal = {
+  user: Address;
+  amountAssetToWithdrawEffective: number;
+  amountAssetToWithdrawAtRequest: number;
+  amountAssetToWithdrawAtPresent: number;
+  amountLpEscrowed: bigint;
+  withdrawableFromTs: bigint;
+};
+
+function processWithdrawalReceipt(
+  receipt: RequestWithdrawVaultReceipt,
+  vault: Vault,
+  lpSupply: bigint,
+): PendingWithdrawal {
+  const amountAssetToWithdrawAtRequest = convertDecimalBitsToNumber(
+    receipt.amountAssetToWithdrawDecimalBits,
+  );
+
+  const amountAssetToWithdrawAtPresent = Number(
+    calculateAssetsForWithdrawAmount({
+      vaultTotalValue: vault.asset.totalValue,
+      vaultLastUpdatedLockedProfit:
+        vault.lockedProfitState.lastUpdatedLockedProfit,
+      vaultLastReport: vault.lockedProfitState.lastReport,
+      vaultLockedProfitDegradationDuration:
+        vault.vaultConfiguration.lockedProfitDegradationDuration,
+      vaultAccumulatedLpAdminFees: vault.feeState.accumulatedLpAdminFees,
+      vaultAccumulatedLpManagerFees: vault.feeState.accumulatedLpManagerFees,
+      vaultAccumulatedLpProtocolFees: vault.feeState.accumulatedLpProtocolFees,
+      vaultDeadWeight: vault.deadWeight,
+      vaultRedemptionFeeBps: vault.feeConfiguration.redemptionFee,
+      vaultManagementFeeBps: getTotalManagementFeeBps(vault.feeConfiguration),
+      vaultLastManagementFeeUpdateTs: vault.feeUpdate.lastManagementFeeUpdateTs,
+      lpSupply,
+      lpAmount: receipt.amountLpEscrowed,
+    }),
+  );
+
+  return {
+    user: receipt.user,
+    amountAssetToWithdrawEffective: Math.min(
+      amountAssetToWithdrawAtPresent,
+      amountAssetToWithdrawAtRequest,
+    ),
+    amountAssetToWithdrawAtRequest,
+    amountAssetToWithdrawAtPresent,
+    amountLpEscrowed: receipt.amountLpEscrowed,
+    withdrawableFromTs: receipt.withdrawableFromTs,
+  };
+}
+
+async function fetchVaultWithLpSupply(
+  rpc: ExtensionsRpc,
+  vault: Address,
+): Promise<{ data: Vault; lpSupply: bigint }> {
+  const account = await fetchVault(rpc, vault);
+  const [lpMint] = await findVaultLpMintPda(
+    { vault },
+    { programAddress: VOLTR_VAULT_PROGRAM_ADDRESS },
+  );
+  const supplyResp = await rpc.getTokenSupply(lpMint).send();
+  return {
+    data: account.data,
+    lpSupply: BigInt(supplyResp.value.amount),
+  };
+}
+
+export async function getPendingWithdrawalForUser(
+  rpc: ExtensionsRpc,
+  vault: Address,
+  user: Address,
+): Promise<PendingWithdrawal> {
+  const { data, lpSupply } = await fetchVaultWithLpSupply(rpc, vault);
+  const [receiptAddress] = await findRequestWithdrawVaultReceiptPda(
+    { vault, userTransferAuthority: user },
+    { programAddress: VOLTR_VAULT_PROGRAM_ADDRESS },
+  );
+  const receipt = await fetchRequestWithdrawVaultReceipt(rpc, receiptAddress);
+  return processWithdrawalReceipt(receipt.data, data, lpSupply);
+}
+
+export async function getAllPendingWithdrawalsForVault(
+  rpc: ExtensionsRpc,
+  vault: Address,
+): Promise<PendingWithdrawal[]> {
+  const [{ data, lpSupply }, receipts] = await Promise.all([
+    fetchVaultWithLpSupply(rpc, vault),
+    fetchAllRequestWithdrawVaultReceiptsOfVault(rpc, vault),
+  ]);
+
+  return receipts.map((account: Account<RequestWithdrawVaultReceipt>) =>
+    processWithdrawalReceipt(account.data, data, lpSupply),
+  );
+}
+
+export { processWithdrawalReceipt };

package/src/generated/accounts/adaptorAddReceipt.ts

@@ -0,0 +1,194 @@
+/**
+ * This code was AUTOGENERATED using the Codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun Codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+import {
+  assertAccountExists,
+  assertAccountsExist,
+  combineCodec,
+  decodeAccount,
+  fetchEncodedAccount,
+  fetchEncodedAccounts,
+  fixDecoderSize,
+  fixEncoderSize,
+  getAddressDecoder,
+  getAddressEncoder,
+  getBytesDecoder,
+  getBytesEncoder,
+  getStructDecoder,
+  getStructEncoder,
+  getU64Decoder,
+  getU64Encoder,
+  getU8Decoder,
+  getU8Encoder,
+  transformEncoder,
+  type Account,
+  type Address,
+  type EncodedAccount,
+  type FetchAccountConfig,
+  type FetchAccountsConfig,
+  type FixedSizeCodec,
+  type FixedSizeDecoder,
+  type FixedSizeEncoder,
+  type MaybeAccount,
+  type MaybeEncodedAccount,
+  type ReadonlyUint8Array,
+} from "@solana/kit";
+
+export const ADAPTOR_ADD_RECEIPT_DISCRIMINATOR = new Uint8Array([
+  105, 99, 219, 155, 77, 241, 7, 119,
+]);
+
+export function getAdaptorAddReceiptDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(
+    ADAPTOR_ADD_RECEIPT_DISCRIMINATOR,
+  );
+}
+
+export type AdaptorAddReceipt = {
+  discriminator: ReadonlyUint8Array;
+  /** The vault associated with this strategy. */
+  vault: Address;
+  /** The adapter program address. */
+  adaptorProgram: Address;
+  /** A version number (1 byte). */
+  version: number;
+  /** The bump for the adaptor add receipt. */
+  bump: number;
+  /** 7 bytes of padding to align future 8-byte fields on 8-byte boundaries. */
+  padding0: ReadonlyUint8Array;
+  /** The epoch at which the strategy was last updated. */
+  lastUpdatedEpoch: bigint;
+  /** Reserved space for future fields */
+  reserved: ReadonlyUint8Array;
+};
+
+export type AdaptorAddReceiptArgs = {
+  /** The vault associated with this strategy. */
+  vault: Address;
+  /** The adapter program address. */
+  adaptorProgram: Address;
+  /** A version number (1 byte). */
+  version: number;
+  /** The bump for the adaptor add receipt. */
+  bump: number;
+  /** 7 bytes of padding to align future 8-byte fields on 8-byte boundaries. */
+  padding0: ReadonlyUint8Array;
+  /** The epoch at which the strategy was last updated. */
+  lastUpdatedEpoch: number | bigint;
+  /** Reserved space for future fields */
+  reserved: ReadonlyUint8Array;
+};
+
+/** Gets the encoder for {@link AdaptorAddReceiptArgs} account data. */
+export function getAdaptorAddReceiptEncoder(): FixedSizeEncoder<AdaptorAddReceiptArgs> {
+  return transformEncoder(
+    getStructEncoder([
+      ["discriminator", fixEncoderSize(getBytesEncoder(), 8)],
+      ["vault", getAddressEncoder()],
+      ["adaptorProgram", getAddressEncoder()],
+      ["version", getU8Encoder()],
+      ["bump", getU8Encoder()],
+      ["padding0", fixEncoderSize(getBytesEncoder(), 7)],
+      ["lastUpdatedEpoch", getU64Encoder()],
+      ["reserved", fixEncoderSize(getBytesEncoder(), 56)],
+    ]),
+    (value) => ({ ...value, discriminator: ADAPTOR_ADD_RECEIPT_DISCRIMINATOR }),
+  );
+}
+
+/** Gets the decoder for {@link AdaptorAddReceipt} account data. */
+export function getAdaptorAddReceiptDecoder(): FixedSizeDecoder<AdaptorAddReceipt> {
+  return getStructDecoder([
+    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
+    ["vault", getAddressDecoder()],
+    ["adaptorProgram", getAddressDecoder()],
+    ["version", getU8Decoder()],
+    ["bump", getU8Decoder()],
+    ["padding0", fixDecoderSize(getBytesDecoder(), 7)],
+    ["lastUpdatedEpoch", getU64Decoder()],
+    ["reserved", fixDecoderSize(getBytesDecoder(), 56)],
+  ]);
+}
+
+/** Gets the codec for {@link AdaptorAddReceipt} account data. */
+export function getAdaptorAddReceiptCodec(): FixedSizeCodec<
+  AdaptorAddReceiptArgs,
+  AdaptorAddReceipt
+> {
+  return combineCodec(
+    getAdaptorAddReceiptEncoder(),
+    getAdaptorAddReceiptDecoder(),
+  );
+}
+
+export function decodeAdaptorAddReceipt<TAddress extends string = string>(
+  encodedAccount: EncodedAccount<TAddress>,
+): Account<AdaptorAddReceipt, TAddress>;
+export function decodeAdaptorAddReceipt<TAddress extends string = string>(
+  encodedAccount: MaybeEncodedAccount<TAddress>,
+): MaybeAccount<AdaptorAddReceipt, TAddress>;
+export function decodeAdaptorAddReceipt<TAddress extends string = string>(
+  encodedAccount: EncodedAccount<TAddress> | MaybeEncodedAccount<TAddress>,
+):
+  | Account<AdaptorAddReceipt, TAddress>
+  | MaybeAccount<AdaptorAddReceipt, TAddress> {
+  return decodeAccount(
+    encodedAccount as MaybeEncodedAccount<TAddress>,
+    getAdaptorAddReceiptDecoder(),
+  );
+}
+
+export async function fetchAdaptorAddReceipt<TAddress extends string = string>(
+  rpc: Parameters<typeof fetchEncodedAccount>[0],
+  address: Address<TAddress>,
+  config?: FetchAccountConfig,
+): Promise<Account<AdaptorAddReceipt, TAddress>> {
+  const maybeAccount = await fetchMaybeAdaptorAddReceipt(rpc, address, config);
+  assertAccountExists(maybeAccount);
+  return maybeAccount;
+}
+
+export async function fetchMaybeAdaptorAddReceipt<
+  TAddress extends string = string,
+>(
+  rpc: Parameters<typeof fetchEncodedAccount>[0],
+  address: Address<TAddress>,
+  config?: FetchAccountConfig,
+): Promise<MaybeAccount<AdaptorAddReceipt, TAddress>> {
+  const maybeAccount = await fetchEncodedAccount(rpc, address, config);
+  return decodeAdaptorAddReceipt(maybeAccount);
+}
+
+export async function fetchAllAdaptorAddReceipt(
+  rpc: Parameters<typeof fetchEncodedAccounts>[0],
+  addresses: Array<Address>,
+  config?: FetchAccountsConfig,
+): Promise<Account<AdaptorAddReceipt>[]> {
+  const maybeAccounts = await fetchAllMaybeAdaptorAddReceipt(
+    rpc,
+    addresses,
+    config,
+  );
+  assertAccountsExist(maybeAccounts);
+  return maybeAccounts;
+}
+
+export async function fetchAllMaybeAdaptorAddReceipt(
+  rpc: Parameters<typeof fetchEncodedAccounts>[0],
+  addresses: Array<Address>,
+  config?: FetchAccountsConfig,
+): Promise<MaybeAccount<AdaptorAddReceipt>[]> {
+  const maybeAccounts = await fetchEncodedAccounts(rpc, addresses, config);
+  return maybeAccounts.map((maybeAccount) =>
+    decodeAdaptorAddReceipt(maybeAccount),
+  );
+}
+
+export function getAdaptorAddReceiptSize(): number {
+  return 145;
+}

package/src/generated/accounts/directWithdrawInitReceipt.ts

@@ -0,0 +1,235 @@
+/**
+ * This code was AUTOGENERATED using the Codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun Codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+import {
+  addDecoderSizePrefix,
+  addEncoderSizePrefix,
+  assertAccountExists,
+  assertAccountsExist,
+  combineCodec,
+  decodeAccount,
+  fetchEncodedAccount,
+  fetchEncodedAccounts,
+  fixDecoderSize,
+  fixEncoderSize,
+  getAddressDecoder,
+  getAddressEncoder,
+  getBooleanDecoder,
+  getBooleanEncoder,
+  getBytesDecoder,
+  getBytesEncoder,
+  getOptionDecoder,
+  getOptionEncoder,
+  getStructDecoder,
+  getStructEncoder,
+  getU32Decoder,
+  getU32Encoder,
+  getU8Decoder,
+  getU8Encoder,
+  transformEncoder,
+  type Account,
+  type Address,
+  type Codec,
+  type Decoder,
+  type EncodedAccount,
+  type Encoder,
+  type FetchAccountConfig,
+  type FetchAccountsConfig,
+  type MaybeAccount,
+  type MaybeEncodedAccount,
+  type Option,
+  type OptionOrNullable,
+  type ReadonlyUint8Array,
+} from "@solana/kit";
+
+export const DIRECT_WITHDRAW_INIT_RECEIPT_DISCRIMINATOR = new Uint8Array([
+  206, 77, 207, 208, 25, 244, 81, 172,
+]);
+
+export function getDirectWithdrawInitReceiptDiscriminatorBytes() {
+  return fixEncoderSize(getBytesEncoder(), 8).encode(
+    DIRECT_WITHDRAW_INIT_RECEIPT_DISCRIMINATOR,
+  );
+}
+
+export type DirectWithdrawInitReceipt = {
+  discriminator: ReadonlyUint8Array;
+  /** The vault associated with this strategy. */
+  vault: Address;
+  /** The strategy address. */
+  strategy: Address;
+  /** The position value. */
+  adaptorProgram: Address;
+  /** The instruction discriminator. */
+  instructionDiscriminator: ReadonlyUint8Array;
+  /** The additional arguments. */
+  additionalArgs: Option<ReadonlyUint8Array>;
+  /** Whether the user args are allowed. */
+  allowUserArgs: boolean;
+  /** A version number (1 byte). */
+  version: number;
+  /** The bump for the strategy init receipt. */
+  bump: number;
+};
+
+export type DirectWithdrawInitReceiptArgs = {
+  /** The vault associated with this strategy. */
+  vault: Address;
+  /** The strategy address. */
+  strategy: Address;
+  /** The position value. */
+  adaptorProgram: Address;
+  /** The instruction discriminator. */
+  instructionDiscriminator: ReadonlyUint8Array;
+  /** The additional arguments. */
+  additionalArgs: OptionOrNullable<ReadonlyUint8Array>;
+  /** Whether the user args are allowed. */
+  allowUserArgs: boolean;
+  /** A version number (1 byte). */
+  version: number;
+  /** The bump for the strategy init receipt. */
+  bump: number;
+};
+
+/** Gets the encoder for {@link DirectWithdrawInitReceiptArgs} account data. */
+export function getDirectWithdrawInitReceiptEncoder(): Encoder<DirectWithdrawInitReceiptArgs> {
+  return transformEncoder(
+    getStructEncoder([
+      ["discriminator", fixEncoderSize(getBytesEncoder(), 8)],
+      ["vault", getAddressEncoder()],
+      ["strategy", getAddressEncoder()],
+      ["adaptorProgram", getAddressEncoder()],
+      [
+        "instructionDiscriminator",
+        addEncoderSizePrefix(getBytesEncoder(), getU32Encoder()),
+      ],
+      [
+        "additionalArgs",
+        getOptionEncoder(
+          addEncoderSizePrefix(getBytesEncoder(), getU32Encoder()),
+        ),
+      ],
+      ["allowUserArgs", getBooleanEncoder()],
+      ["version", getU8Encoder()],
+      ["bump", getU8Encoder()],
+    ]),
+    (value) => ({
+      ...value,
+      discriminator: DIRECT_WITHDRAW_INIT_RECEIPT_DISCRIMINATOR,
+    }),
+  );
+}
+
+/** Gets the decoder for {@link DirectWithdrawInitReceipt} account data. */
+export function getDirectWithdrawInitReceiptDecoder(): Decoder<DirectWithdrawInitReceipt> {
+  return getStructDecoder([
+    ["discriminator", fixDecoderSize(getBytesDecoder(), 8)],
+    ["vault", getAddressDecoder()],
+    ["strategy", getAddressDecoder()],
+    ["adaptorProgram", getAddressDecoder()],
+    [
+      "instructionDiscriminator",
+      addDecoderSizePrefix(getBytesDecoder(), getU32Decoder()),
+    ],
+    [
+      "additionalArgs",
+      getOptionDecoder(
+        addDecoderSizePrefix(getBytesDecoder(), getU32Decoder()),
+      ),
+    ],
+    ["allowUserArgs", getBooleanDecoder()],
+    ["version", getU8Decoder()],
+    ["bump", getU8Decoder()],
+  ]);
+}
+
+/** Gets the codec for {@link DirectWithdrawInitReceipt} account data. */
+export function getDirectWithdrawInitReceiptCodec(): Codec<
+  DirectWithdrawInitReceiptArgs,
+  DirectWithdrawInitReceipt
+> {
+  return combineCodec(
+    getDirectWithdrawInitReceiptEncoder(),
+    getDirectWithdrawInitReceiptDecoder(),
+  );
+}
+
+export function decodeDirectWithdrawInitReceipt<
+  TAddress extends string = string,
+>(
+  encodedAccount: EncodedAccount<TAddress>,
+): Account<DirectWithdrawInitReceipt, TAddress>;
+export function decodeDirectWithdrawInitReceipt<
+  TAddress extends string = string,
+>(
+  encodedAccount: MaybeEncodedAccount<TAddress>,
+): MaybeAccount<DirectWithdrawInitReceipt, TAddress>;
+export function decodeDirectWithdrawInitReceipt<
+  TAddress extends string = string,
+>(
+  encodedAccount: EncodedAccount<TAddress> | MaybeEncodedAccount<TAddress>,
+):
+  | Account<DirectWithdrawInitReceipt, TAddress>
+  | MaybeAccount<DirectWithdrawInitReceipt, TAddress> {
+  return decodeAccount(
+    encodedAccount as MaybeEncodedAccount<TAddress>,
+    getDirectWithdrawInitReceiptDecoder(),
+  );
+}
+
+export async function fetchDirectWithdrawInitReceipt<
+  TAddress extends string = string,
+>(
+  rpc: Parameters<typeof fetchEncodedAccount>[0],
+  address: Address<TAddress>,
+  config?: FetchAccountConfig,
+): Promise<Account<DirectWithdrawInitReceipt, TAddress>> {
+  const maybeAccount = await fetchMaybeDirectWithdrawInitReceipt(
+    rpc,
+    address,
+    config,
+  );
+  assertAccountExists(maybeAccount);
+  return maybeAccount;
+}
+
+export async function fetchMaybeDirectWithdrawInitReceipt<
+  TAddress extends string = string,
+>(
+  rpc: Parameters<typeof fetchEncodedAccount>[0],
+  address: Address<TAddress>,
+  config?: FetchAccountConfig,
+): Promise<MaybeAccount<DirectWithdrawInitReceipt, TAddress>> {
+  const maybeAccount = await fetchEncodedAccount(rpc, address, config);
+  return decodeDirectWithdrawInitReceipt(maybeAccount);
+}
+
+export async function fetchAllDirectWithdrawInitReceipt(
+  rpc: Parameters<typeof fetchEncodedAccounts>[0],
+  addresses: Array<Address>,
+  config?: FetchAccountsConfig,
+): Promise<Account<DirectWithdrawInitReceipt>[]> {
+  const maybeAccounts = await fetchAllMaybeDirectWithdrawInitReceipt(
+    rpc,
+    addresses,
+    config,
+  );
+  assertAccountsExist(maybeAccounts);
+  return maybeAccounts;
+}
+
+export async function fetchAllMaybeDirectWithdrawInitReceipt(
+  rpc: Parameters<typeof fetchEncodedAccounts>[0],
+  addresses: Array<Address>,
+  config?: FetchAccountsConfig,
+): Promise<MaybeAccount<DirectWithdrawInitReceipt>[]> {
+  const maybeAccounts = await fetchEncodedAccounts(rpc, addresses, config);
+  return maybeAccounts.map((maybeAccount) =>
+    decodeDirectWithdrawInitReceipt(maybeAccount),
+  );
+}

package/src/generated/accounts/index.ts

@@ -0,0 +1,14 @@
+/**
+ * This code was AUTOGENERATED using the Codama library.
+ * Please DO NOT EDIT THIS FILE, instead use visitors
+ * to add features, then rerun Codama to update it.
+ *
+ * @see https://github.com/codama-idl/codama
+ */
+
+export * from "./adaptorAddReceipt";
+export * from "./directWithdrawInitReceipt";
+export * from "./protocol";
+export * from "./requestWithdrawVaultReceipt";
+export * from "./strategyInitReceipt";
+export * from "./vault";