@paxoslabs/amplify-sdk 0.5.1 → 0.5.3

package/dist/display.d.ts

@@ -1,5 +1,5 @@
 import { Address } from 'viem';
-import { C as ChainId } from './chain-utils-D_b2LEEi.js';
+import { C as ChainId } from './chain-utils-5r2UnCDS.js';
 import 'viem/chains';
 
 /**
@@ -8,7 +8,7 @@ import 'viem/chains';
  */
 
 /** Status of a withdrawal request */
-type WithdrawalRequestStatus = "PENDING" | "COMPLETE" | "PENDING_REFUND" | "REFUNDED";
+type WithdrawalRequestStatus = 'PENDING' | 'COMPLETE' | 'PENDING_REFUND' | 'REFUNDED';
 /** A withdrawal request returned from the backend API */
 interface WithdrawalRequest {
     id: string;
@@ -92,6 +92,107 @@ interface MinimumMintResult {
     shareDecimals: number;
     assetDecimals: number;
 }
+/** Parameters for getDepositCap */
+interface GetDepositCapParams {
+    /** Human-readable vault name (e.g. "Amplify USDC Core") */
+    vaultName: string;
+    /** Chain ID where the vault is deployed. Must match the vault's chain. */
+    chainId: ChainId;
+    /** Token contract address used to validate the vault (should match the vault's supported asset) */
+    assetAddress: Address;
+}
+/**
+ * Return type for {@link getDepositCap}.
+ * Only produced for vaults with both a CommunityCodeDepositor and a deposit fee module.
+ */
+interface DepositCapResult {
+    /** Supply cap denominated in base asset units (raw uint256 from DCD contract) */
+    supplyCapInBase: bigint;
+    /** True when `supplyCapInBase` is neither `0` nor `maxUint256` (unlimited). */
+    hasDepositCap: boolean;
+    /** Deposit fee module contract address from the DCD (zero address means no fees) */
+    depositFeeModuleAddress: Address;
+    /** Whether the vault has deposit fees (depositFeeModuleAddress != zero address) */
+    hasFees: boolean;
+}
+/** Parameters for calculateDepositFee */
+interface CalculateDepositFeeParams {
+    /** Human-readable vault name (e.g. "Amplify USDC Core") */
+    vaultName: string;
+    /** Chain ID where the vault is deployed. Must match the vault's chain. */
+    chainId: ChainId;
+    /** Token contract address of the deposit asset */
+    assetAddress: Address;
+    /** Human-readable deposit amount (e.g. "1000.0") */
+    depositAmount: string;
+}
+/** Return type for calculateDepositFee */
+interface DepositFeeResult {
+    /** Whether the vault has a fee module configured */
+    hasFees: boolean;
+    /** The deposit fee module contract address (zero address if no fees) */
+    depositFeeModuleAddress: Address;
+    /** Variable fee percentage as raw uint256 from the contract */
+    feePercentage: bigint;
+    /** ONE_HUNDRED_PERCENT constant from the fee module (denominator for percentage calc) */
+    oneHundredPercent: bigint;
+    /** Flat fee in deposit-token units (raw uint256) */
+    flatFee: bigint;
+    /** Computed variable fee amount for the given deposit: depositAmount * feePercentage / oneHundredPercent */
+    variableFeeAmount: bigint;
+    /** Total fee amount: variableFeeAmount + flatFee */
+    totalFeeAmount: bigint;
+    /** Deposit amount after total fee deduction */
+    depositAmountAfterFees: bigint;
+    /** Decimals of the deposit asset (for display formatting) */
+    assetDecimals: number;
+}
+/** Parameters for getCurrentSupply */
+interface GetCurrentSupplyParams {
+    /** Human-readable vault name (e.g. "Amplify USDC Core") */
+    vaultName: string;
+    /** Chain ID where the vault is deployed. Must match the vault's chain. */
+    chainId: ChainId;
+    /** Token contract address used to validate the vault (should match the vault's supported asset) */
+    assetAddress: Address;
+}
+/** Return type for getCurrentSupply */
+interface CurrentSupplyResult {
+    /** Total share supply of the boring vault (raw ERC-20 totalSupply) */
+    totalShareSupply: bigint;
+    /** Exchange rate from the accountant (getRate) */
+    exchangeRate: bigint;
+    /** Decimals reported by the accountant contract */
+    accountantDecimals: number;
+    /** Total value in base-asset units: totalShareSupply * exchangeRate / 10^accountantDecimals */
+    totalValueInBase: bigint;
+}
+/** Parameters for getShareValue */
+interface GetShareValueParams {
+    /** Human-readable vault name (e.g. "Amplify USDC Core") */
+    vaultName: string;
+    /** Chain ID where the vault is deployed. Must match the vault's chain. */
+    chainId: ChainId;
+    /** Quote asset address to value shares in (e.g. USDC). Must match the vault's supported asset. */
+    quoteAssetAddress: Address;
+    /** Wallet address to read share balance for via balanceOf. Optional when shareAmount is provided. */
+    userAddress?: Address;
+    /** Explicit share amount to value (human-readable, e.g. "100.0"). Overrides on-chain balanceOf when provided. */
+    shareAmount?: string;
+}
+/** Return type for getShareValue */
+interface ShareValueResult {
+    /** Share balance used for the calculation (read from chain or derived from shareAmount) */
+    shareBalance: bigint;
+    /** Value of the shares in quote-asset units (raw bigint) */
+    value: bigint;
+    /** Exchange rate from getRateInQuote — quote-asset units per one full share */
+    exchangeRate: bigint;
+    /** Decimals of the BoringVault share token */
+    shareDecimals: number;
+    /** Decimals of the quote asset */
+    quoteAssetDecimals: number;
+}
 /** Parameters for getVaultAPY */
 interface GetVaultAPYParams {
     vaultAddress?: Address;
@@ -147,6 +248,114 @@ interface VaultTVLResult {
  * ```
  */
 declare function getMinimumMint(params: GetMinimumMintParams): Promise<MinimumMintResult>;
+/**
+ * Reads the deposit cap and fee module info from the DCD contract on-chain
+ *
+ * Uses the customer's configured RPC to call `supplyCapInBase()` and
+ * `feeModule()` on the DistributorCodeDepositor contract.
+ *
+ * @param params - Vault identification parameters
+ * @returns Supply cap, fee module address, and derived boolean flags
+ * @throws {APIError} If vault not found or contract read fails
+ *
+ * @example
+ * ```typescript
+ * const cap = await getDepositCap({
+ *   vaultName: "Amplify USDC Core",
+ *   chainId: 1,
+ *   assetAddress: "0xA0b8...",
+ * });
+ * console.log(cap.hasDepositCap); // true if supplyCapInBase != 0 and != maxUint256
+ * console.log(cap.hasFees);       // true if depositFeeModuleAddress from vault config != zeroAddress
+ * ```
+ */
+declare function getDepositCap(params: GetDepositCapParams): Promise<DepositCapResult>;
+/**
+ * Reads the current total supply value from the boring vault and accountant
+ *
+ * Computes `totalValueInBase = totalSupply * accountant.getRate() / 10^accountant.decimals()`,
+ * matching the on-chain supply cap enforcement logic in the DCD contract.
+ *
+ * @param params - Vault identification parameters
+ * @returns Total share supply, exchange rate, and computed value in base-asset units
+ * @throws {APIError} If vault not found or contract read fails
+ *
+ * @example
+ * ```typescript
+ * const supply = await getCurrentSupply({
+ *   vaultName: "Amplify USDC Core",
+ *   chainId: 1,
+ *   assetAddress: "0xA0b8...",
+ * });
+ * console.log(supply.totalValueInBase); // current TVL in base-asset raw units
+ * ```
+ */
+declare function getCurrentSupply(params: GetCurrentSupplyParams): Promise<CurrentSupplyResult>;
+/**
+ * Calculates the deposit fee for a given deposit amount by reading the
+ * fee module's `depositTokenFeeData` and `ONE_HUNDRED_PERCENT` on-chain.
+ *
+ * Returns both the fixed (flat) and variable fee components, along with
+ * the total fee and the net deposit amount after fees.
+ *
+ * @param params - Deposit parameters including vault name, chain, asset, and amount
+ * @returns Fee breakdown with fixed, variable, total, and net amounts
+ * @throws {APIError} If vault not found, no fee module, or contract read fails
+ *
+ * @example
+ * ```typescript
+ * const fee = await calculateDepositFee({
+ *   vaultName: "Amplify USDC Core",
+ *   chainId: 1,
+ *   assetAddress: "0xA0b8...",
+ *   depositAmount: "1000.0",
+ * });
+ * console.log(fee.variableFeeAmount); // variable portion
+ * console.log(fee.flatFee);           // fixed portion
+ * console.log(fee.totalFeeAmount);    // variable + fixed
+ * ```
+ */
+declare function calculateDepositFee(params: CalculateDepositFeeParams): Promise<DepositFeeResult>;
+/**
+ * Calculates the value of vault shares in a quote asset
+ *
+ * Reads the on-chain exchange rate from the Accountant contract via
+ * `getRateInQuote(quoteAsset)` and computes:
+ *   value = shareBalance * rateInQuote / 10^shareDecimals
+ *
+ * The share balance can come from two sources:
+ * - `userAddress`: reads `balanceOf(userAddress)` on the BoringVault on-chain
+ * - `shareAmount`: uses the provided amount directly (skips balanceOf)
+ *
+ * When both are provided, `shareAmount` takes precedence. At least one
+ * must be specified.
+ *
+ * @param params - Share value parameters
+ * @returns Share balance, value in quote-asset units, exchange rate, and decimal info
+ * @throws {APIError} If neither userAddress nor shareAmount provided, vault not found, or contract read fails
+ *
+ * @example
+ * ```typescript
+ * // Look up a user's position value by wallet address
+ * const result = await getShareValue({
+ *   vaultName: "pxlUSDCc",
+ *   chainId: 1,
+ *   quoteAssetAddress: "0xA0b8...", // USDC
+ *   userAddress: "0x1234...",
+ * });
+ * console.log(result.shareBalance); // shares held
+ * console.log(result.value);        // worth in USDC units
+ *
+ * // Or value a known share amount directly
+ * const preview = await getShareValue({
+ *   vaultName: "pxlUSDCc",
+ *   chainId: 1,
+ *   quoteAssetAddress: "0xA0b8...",
+ *   shareAmount: "100.0",
+ * });
+ * ```
+ */
+declare function getShareValue(params: GetShareValueParams): Promise<ShareValueResult>;
 
 /**
  * @file Vault display helpers
@@ -260,4 +469,4 @@ declare function getWithdrawalFee(params: GetWithdrawalFeeParams): Promise<Withd
  */
 declare function getMinimumWithdrawalOrderSize(params: GetMinimumWithdrawalOrderSizeParams): Promise<MinimumWithdrawalOrderSizeResult>;
 
-export { type GetMinimumMintParams, type GetMinimumWithdrawalOrderSizeParams, type GetVaultAPYParams, type GetVaultTVLParams, type GetWithdrawalFeeParams, type GetWithdrawalRequestsParams, type MinimumMintResult, type MinimumWithdrawalOrderSizeResult, type VaultAPYResult, type VaultTVLResult, type WithdrawalFeeResult, type WithdrawalRequest, type WithdrawalRequestStatus, type WithdrawalRequestsResult, getMinimumMint, getMinimumWithdrawalOrderSize, getVaultAPY, getVaultTVL, getWithdrawalFee, getWithdrawalRequests };
+export { type CalculateDepositFeeParams, type CurrentSupplyResult, type DepositCapResult, type DepositFeeResult, type GetCurrentSupplyParams, type GetDepositCapParams, type GetMinimumMintParams, type GetMinimumWithdrawalOrderSizeParams, type GetShareValueParams, type GetVaultAPYParams, type GetVaultTVLParams, type GetWithdrawalFeeParams, type GetWithdrawalRequestsParams, type MinimumMintResult, type MinimumWithdrawalOrderSizeResult, type ShareValueResult, type VaultAPYResult, type VaultTVLResult, type WithdrawalFeeResult, type WithdrawalRequest, type WithdrawalRequestStatus, type WithdrawalRequestsResult, calculateDepositFee, getCurrentSupply, getDepositCap, getMinimumMint, getMinimumWithdrawalOrderSize, getShareValue, getVaultAPY, getVaultTVL, getWithdrawalFee, getWithdrawalRequests };

package/dist/display.js

@@ -1,36 +1,52 @@
 'use strict';
 
-var chunkXVDK6J72_js = require('./chunk-XVDK6J72.js');
-require('./chunk-AUDMOT6F.js');
-require('./chunk-YAYUSBC6.js');
-require('./chunk-3I3PYX2F.js');
-require('./chunk-E5DH5YEE.js');
+var chunkWD6QFSXZ_js = require('./chunk-WD6QFSXZ.js');
+require('./chunk-6JLKHV6O.js');
+require('./chunk-FHE43NKY.js');
+require('./chunk-TNL23CO2.js');
+require('./chunk-GOJQYEJQ.js');
 
 
 
+Object.defineProperty(exports, "calculateDepositFee", {
+  enumerable: true,
+  get: function () { return chunkWD6QFSXZ_js.calculateDepositFee; }
+});
+Object.defineProperty(exports, "getCurrentSupply", {
+  enumerable: true,
+  get: function () { return chunkWD6QFSXZ_js.getCurrentSupply; }
+});
+Object.defineProperty(exports, "getDepositCap", {
+  enumerable: true,
+  get: function () { return chunkWD6QFSXZ_js.getDepositCap; }
+});
 Object.defineProperty(exports, "getMinimumMint", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getMinimumMint; }
+  get: function () { return chunkWD6QFSXZ_js.getMinimumMint; }
 });
 Object.defineProperty(exports, "getMinimumWithdrawalOrderSize", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getMinimumWithdrawalOrderSize; }
+  get: function () { return chunkWD6QFSXZ_js.getMinimumWithdrawalOrderSize; }
+});
+Object.defineProperty(exports, "getShareValue", {
+  enumerable: true,
+  get: function () { return chunkWD6QFSXZ_js.getShareValue; }
 });
 Object.defineProperty(exports, "getVaultAPY", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getVaultAPY; }
+  get: function () { return chunkWD6QFSXZ_js.getVaultAPY; }
 });
 Object.defineProperty(exports, "getVaultTVL", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getVaultTVL; }
+  get: function () { return chunkWD6QFSXZ_js.getVaultTVL; }
 });
 Object.defineProperty(exports, "getWithdrawalFee", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getWithdrawalFee; }
+  get: function () { return chunkWD6QFSXZ_js.getWithdrawalFee; }
 });
 Object.defineProperty(exports, "getWithdrawalRequests", {
   enumerable: true,
-  get: function () { return chunkXVDK6J72_js.getWithdrawalRequests; }
+  get: function () { return chunkWD6QFSXZ_js.getWithdrawalRequests; }
 });
 //# sourceMappingURL=display.js.map
 //# sourceMappingURL=display.js.map

package/dist/display.mjs

@@ -1,7 +1,7 @@
-export { getMinimumMint, getMinimumWithdrawalOrderSize, getVaultAPY, getVaultTVL, getWithdrawalFee, getWithdrawalRequests } from './chunk-WJGSTAPB.mjs';
-import './chunk-Y6RXVDQN.mjs';
-import './chunk-E6SBQNDA.mjs';
-import './chunk-7RWWVUHP.mjs';
-import './chunk-JLZL25CY.mjs';
+export { calculateDepositFee, getCurrentSupply, getDepositCap, getMinimumMint, getMinimumWithdrawalOrderSize, getShareValue, getVaultAPY, getVaultTVL, getWithdrawalFee, getWithdrawalRequests } from './chunk-QMFYPHX5.mjs';
+import './chunk-Y5LBT2WT.mjs';
+import './chunk-UY2WD7MF.mjs';
+import './chunk-6CU533DM.mjs';
+import './chunk-ODXJYXUH.mjs';
 //# sourceMappingURL=display.mjs.map
 //# sourceMappingURL=display.mjs.map