@paxoslabs/amplify-sdk 0.5.2 → 1.0.0

package/dist/display.d.ts

@@ -1,263 +0,0 @@
-import { Address } from 'viem';
-import { C as ChainId } from './chain-utils-BdJecHBA.js';
-import 'viem/chains';
-
-/**
- * @file Display module type definitions
- * @module display/types
- */
-
-/** Status of a withdrawal request */
-type WithdrawalRequestStatus = 'PENDING' | 'COMPLETE' | 'PENDING_REFUND' | 'REFUNDED';
-/** A withdrawal request returned from the backend API */
-interface WithdrawalRequest {
-    id: string;
-    vaultAddress: Address;
-    chainId: number;
-    wantAssetAddress: Address;
-    status: WithdrawalRequestStatus;
-    createdAt: string;
-    userAddress: Address;
-    receiverAddress: Address;
-    refundReceiverAddress: Address;
-    orderAmount: string;
-    orderIndex: number;
-    isSubmittedViaSignature: boolean;
-    isForceProcessed: boolean;
-    isMarkedForRefund: boolean;
-    isMarkedForRefundByUser: boolean;
-    didOrderFailTransfer: boolean;
-}
-/** Parameters for getWithdrawalRequests */
-interface GetWithdrawalRequestsParams {
-    userAddress: Address;
-    chainId?: number;
-    vaultAddress?: Address;
-    vaultName?: string;
-    status?: WithdrawalRequestStatus;
-    pageSize?: number;
-    pageToken?: string;
-}
-/** Return type for getWithdrawalRequests */
-interface WithdrawalRequestsResult {
-    withdrawalRequests: WithdrawalRequest[];
-    nextPageToken: string | null;
-}
-/** Parameters for getWithdrawalFee */
-interface GetWithdrawalFeeParams {
-    /** 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;
-    amount: string;
-    offerAsset: Address;
-    wantAsset: Address;
-    receiver: Address;
-}
-/** Return type for getWithdrawalFee */
-interface WithdrawalFeeResult {
-    feeAmount: bigint;
-    feePercentage: bigint;
-}
-/** Parameters for getMinimumWithdrawalOrderSize */
-interface GetMinimumWithdrawalOrderSizeParams {
-    /** 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 getMinimumWithdrawalOrderSize */
-interface MinimumWithdrawalOrderSizeResult {
-    minimumOrderSize: bigint;
-    shareDecimals: number;
-}
-/** Parameters for getMinimumMint */
-interface GetMinimumMintParams {
-    /** 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 to deposit. Must match the vault's supported asset. */
-    depositAssetAddress: Address;
-    depositAmount: string;
-}
-/** Return type for getMinimumMint */
-interface MinimumMintResult {
-    expectedShares: bigint;
-    exchangeRate: bigint;
-    shareDecimals: number;
-    assetDecimals: number;
-}
-/** Parameters for getVaultAPY */
-interface GetVaultAPYParams {
-    vaultAddress?: Address;
-    vaultName?: string;
-    chainId?: number;
-}
-/** Return type for getVaultAPY */
-interface VaultAPYResult {
-    apy: number;
-    apyFormatted: string;
-    vaultAddress: Address;
-    timestamp: string;
-}
-/** Parameters for getVaultTVL */
-interface GetVaultTVLParams {
-    vaultAddress?: Address;
-    vaultName?: string;
-    chainId?: number;
-}
-/** Return type for getVaultTVL */
-interface VaultTVLResult {
-    tvl: string;
-    tvlAsset: string;
-    vaultAddress: Address;
-    chainId: number;
-    timestamp: string;
-}
-
-/**
- * @file Deposit display helpers
- * @module display/deposit-display
- */
-
-/**
- * Calculates the expected vault shares a user will receive for a deposit
- *
- * Uses the on-chain exchange rate from the Accountant contract to calculate
- * how many vault shares will be minted for a given deposit amount.
- *
- * @param params - Deposit parameters
- * @returns Expected shares, exchange rate, and decimal info
- * @throws {APIError} If vault not found or contract read fails
- *
- * @example
- * ```typescript
- * const result = await getMinimumMint({
- *   vaultName: "Amplify USDC Core",
- *   chainId: 1,
- *   depositAssetAddress: "0xA0b8...", // USDC
- *   depositAmount: "1000.0",
- * });
- * console.log(result.expectedShares);
- * ```
- */
-declare function getMinimumMint(params: GetMinimumMintParams): Promise<MinimumMintResult>;
-
-/**
- * @file Vault display helpers
- * @module display/vault-display
- */
-
-/**
- * Fetches the latest APY for a vault from the backend API
- *
- * Requests the most recent APY data point by using
- * orderByTimestamp=desc with pageSize=1.
- *
- * @param params - Vault identifier parameters (vaultAddress, vaultName, or both)
- * @returns Latest APY value and metadata
- * @throws {APIError} If the API request fails or no data found
- *
- * @example
- * ```typescript
- * const result = await getVaultAPY({
- *   vaultAddress: "0x1234...",
- * });
- * console.log(result.apyFormatted); // "4.50%"
- * ```
- */
-declare function getVaultAPY(params: GetVaultAPYParams): Promise<VaultAPYResult>;
-/**
- * Fetches the current TVL for a vault from the backend API
- *
- * Requests the most recent TVL data point by using
- * includeCurrent=true, orderByTimestamp=desc with pageSize=1.
- *
- * @param params - Vault identifier parameters (vaultAddress, vaultName, or both)
- * @returns Current TVL value and metadata
- * @throws {APIError} If the API request fails or no data found
- *
- * @example
- * ```typescript
- * const result = await getVaultTVL({
- *   vaultAddress: "0x1234...",
- * });
- * console.log(result.tvl, result.tvlAsset);
- * ```
- */
-declare function getVaultTVL(params: GetVaultTVLParams): Promise<VaultTVLResult>;
-
-/**
- * @file Withdrawal display helpers
- * @module display/withdrawal-display
- */
-
-/**
- * Fetches a user's withdrawal requests from the backend API
- *
- * @param params - Filter parameters for withdrawal requests
- * @returns Paginated list of withdrawal requests
- * @throws {APIError} If the API request fails or parameters are invalid
- *
- * @example
- * ```typescript
- * const result = await getWithdrawalRequests({
- *   userAddress: "0x1234...",
- *   status: "PENDING",
- *   chainId: 1,
- * });
- * console.log(result.withdrawalRequests);
- * ```
- */
-declare function getWithdrawalRequests(params: GetWithdrawalRequestsParams): Promise<WithdrawalRequestsResult>;
-/**
- * Reads the withdrawal fee from the on-chain FeeModule contract
- *
- * Performs two sequential RPC calls:
- * 1. Reads the FeeModule address from WithdrawQueue.feeModule()
- * 2. Multicalls calculateOfferFees + offerFeePercentage on the FeeModule
- *
- * @param params - Parameters for fee calculation
- * @returns Fee amount and fee percentage
- * @throws {APIError} If vault not found or contract read fails
- *
- * @example
- * ```typescript
- * const fee = await getWithdrawalFee({
- *   vaultName: "Amplify USDC Core",
- *   chainId: 1,
- *   assetAddress: "0xA0b8...", // USDC
- *   amount: "1.0",
- *   offerAsset: "0x1234...",  // vault shares
- *   wantAsset: "0xA0b8...",   // USDC
- *   receiver: "0x5678...",
- * });
- * console.log(fee.feeAmount, fee.feePercentage);
- * ```
- */
-declare function getWithdrawalFee(params: GetWithdrawalFeeParams): Promise<WithdrawalFeeResult>;
-/**
- * Reads the minimum withdrawal order size from the WithdrawQueue contract
- *
- * @param params - Parameters to identify the vault
- * @returns Minimum order size in vault shares and share decimals
- * @throws {APIError} If vault not found or contract read fails
- *
- * @example
- * ```typescript
- * const result = await getMinimumWithdrawalOrderSize({
- *   vaultName: "Amplify USDC Core",
- *   chainId: 1,
- *   assetAddress: "0xA0b8...",
- * });
- * console.log(result.minimumOrderSize, result.shareDecimals);
- * ```
- */
-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 };

package/dist/display.js

@@ -1,36 +0,0 @@
-'use strict';
-
-var chunkSWUG4PTB_js = require('./chunk-SWUG4PTB.js');
-require('./chunk-ZKDXRGI5.js');
-require('./chunk-NNDY5TID.js');
-require('./chunk-TNL23CO2.js');
-require('./chunk-WYBYBPX5.js');
-
-
-
-Object.defineProperty(exports, "getMinimumMint", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getMinimumMint; }
-});
-Object.defineProperty(exports, "getMinimumWithdrawalOrderSize", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getMinimumWithdrawalOrderSize; }
-});
-Object.defineProperty(exports, "getVaultAPY", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getVaultAPY; }
-});
-Object.defineProperty(exports, "getVaultTVL", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getVaultTVL; }
-});
-Object.defineProperty(exports, "getWithdrawalFee", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getWithdrawalFee; }
-});
-Object.defineProperty(exports, "getWithdrawalRequests", {
-  enumerable: true,
-  get: function () { return chunkSWUG4PTB_js.getWithdrawalRequests; }
-});
-//# sourceMappingURL=display.js.map
-//# sourceMappingURL=display.js.map

package/dist/display.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"display.js"}

package/dist/display.mjs

@@ -1,7 +0,0 @@
-export { getMinimumMint, getMinimumWithdrawalOrderSize, getVaultAPY, getVaultTVL, getWithdrawalFee, getWithdrawalRequests } from './chunk-QZHI2T7O.mjs';
-import './chunk-7JQQ2TH4.mjs';
-import './chunk-Q5FXJU5Y.mjs';
-import './chunk-6CU533DM.mjs';
-import './chunk-WK7EJRBB.mjs';
-//# sourceMappingURL=display.mjs.map
-//# sourceMappingURL=display.mjs.map

package/dist/display.mjs.map

@@ -1 +0,0 @@
-{"version":3,"sources":[],"names":[],"mappings":"","file":"display.mjs"}