@paxoslabs/amplify-sdk 0.5.1 → 0.5.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.5.2
+
+### Patch Changes
+
+- Add KYT deposit support with discriminated union types, enterprise config-based routing, vault deprecation warnings, and flatten permit deposit return shape
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -7,55 +13,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- auto-changelog-above -->
 
-
-## [0.5.1](https://github.com/paxoslabs/paxos-labs-monorepo/compare/v0.4.3-alpha.1...v0.5.1) (2026-03-23)
-
-### Features
-
-* Add `oasdiff` to check for breaking backend API changes ([#25](https://github.com/paxoslabs/paxos-labs-monorepo/issues/25)) ([9aa1deb](https://github.com/paxoslabs/paxos-labs-monorepo/commit/9aa1debae1a0c97ca11430547450e38e1491f782))
-* Add Amplify SDK config management UI ([ce383ce](https://github.com/paxoslabs/paxos-labs-monorepo/commit/ce383cedcf1e0f7f520a0fa92b6573eb0ad0aa7c))
-* adding initial docs changes for new SDK version and changes ([be45fa6](https://github.com/paxoslabs/paxos-labs-monorepo/commit/be45fa6a6be4013ea4a7c58be40b9b130b3d5e69))
-* **address-book-admin:** address QA feedback for vault and SDK config flows ([ce87154](https://github.com/paxoslabs/paxos-labs-monorepo/commit/ce871540ab4c58ca35f57c2a932def81af094b31))
-* integrate TanStack Form with client-side validation and fix shadcn audit issues ([a5ec00c](https://github.com/paxoslabs/paxos-labs-monorepo/commit/a5ec00c5db1b5afb4a4e2b6c5601dbe4ed4ad47f))
-* Make backend-v2 + GitHub Actions source of migrations ([#39](https://github.com/paxoslabs/paxos-labs-monorepo/issues/39)) ([720aa9c](https://github.com/paxoslabs/paxos-labs-monorepo/commit/720aa9c9d91e185477fb587ce63392af8f140038))
-* Parametrize BASE_URL in SDK using env var replaced at build time by tsup ([#41](https://github.com/paxoslabs/paxos-labs-monorepo/issues/41)) ([a20e3a6](https://github.com/paxoslabs/paxos-labs-monorepo/commit/a20e3a69d76c30fef2e7f53d543ab47b323c77c4))
-
-### Bug Fixes
-
-* address PR review feedback ([83c612c](https://github.com/paxoslabs/paxos-labs-monorepo/commit/83c612c24a2524b3d025cb0e9bd159f89a863ba1))
-* address PR review feedback — server errors, select a11y, startBlock validation ([d28669b](https://github.com/paxoslabs/paxos-labs-monorepo/commit/d28669b7d6d45743aef558a93364a45fc975d410))
-* address PR review feedback from CodeRabbit ([1567716](https://github.com/paxoslabs/paxos-labs-monorepo/commit/156771673510fa3bbd9f3e57f8dcdf401b777c5c))
-* **address-book-admin:** fix content overflow when sidebar is open ([61f3e61](https://github.com/paxoslabs/paxos-labs-monorepo/commit/61f3e61fe09b96bc80aed493867c269a69efb7c2))
-* **address-book-admin:** handle organizations query error explicitly ([a0e2163](https://github.com/paxoslabs/paxos-labs-monorepo/commit/a0e216393f314cb7abb627c1986b17d254205482))
-* **address-book-admin:** resolve tables not rendering due to client/server boundary violation ([c9b0006](https://github.com/paxoslabs/paxos-labs-monorepo/commit/c9b00062f833edd5f9d401fae038167eef15a1d1))
-* **backend-v2:** query org member by record id instead of userId in remove/update ([26bb1d0](https://github.com/paxoslabs/paxos-labs-monorepo/commit/26bb1d0fd72e1492e36b25015d57c4fbf547dcf0))
-* bound socket.io-parser override to ^4.2.6 to prevent unintended major upgrades ([c0f94ce](https://github.com/paxoslabs/paxos-labs-monorepo/commit/c0f94cefd24b0d1e1a11b2d372f971dcd063c390))
-* handle Supabase query errors in deposit token search ([7a44324](https://github.com/paxoslabs/paxos-labs-monorepo/commit/7a44324e522153e799358bac907b79aaffe39c9b))
-* optimistic update to continue showing new role after update succeeds ([d174c41](https://github.com/paxoslabs/paxos-labs-monorepo/commit/d174c419941d95f858d75d20aab7f9ac362374a1))
-* override socket.io-parser to >=4.2.6 to resolve GHSA-677m-j7p3-52f9 ([47406ea](https://github.com/paxoslabs/paxos-labs-monorepo/commit/47406ea41690428f91d72a723145c9d5d0190893))
-* Prevent adding deleted vault ([#35](https://github.com/paxoslabs/paxos-labs-monorepo/issues/35)) ([34b8b20](https://github.com/paxoslabs/paxos-labs-monorepo/commit/34b8b202a1b058b35ef70e8832ad751c30d4794b))
-* remove duplicate toast ([93fb035](https://github.com/paxoslabs/paxos-labs-monorepo/commit/93fb035ae98cc6db96c2b67fafe70975f61ee528))
-* revert address-book schema change ([1f77a7d](https://github.com/paxoslabs/paxos-labs-monorepo/commit/1f77a7d9608cfd714c2dffd1a3f5a41b2127976a))
-* sdk package version missmatch ([d89500a](https://github.com/paxoslabs/paxos-labs-monorepo/commit/d89500a161ae7ca149ba3fa4a6943c3c4a6841cd))
-* use viem isAddress for validation and fix TanStack Form error handling ([177bc3f](https://github.com/paxoslabs/paxos-labs-monorepo/commit/177bc3f264daddb955187c873d9f408fff30514b))
-* Vault deletion not working from the UI ([#34](https://github.com/paxoslabs/paxos-labs-monorepo/issues/34)) ([3328cca](https://github.com/paxoslabs/paxos-labs-monorepo/commit/3328cca120299ff256f358303a86295b5a4c0ea0))
-
-### Documentation
-
-* **sdk:** replace deprecated getAssetsFromCache with getSupportedAssets in troubleshooting snippet ([6616961](https://github.com/paxoslabs/paxos-labs-monorepo/commit/66169611affd73f5807d66e0580c57df13d5c7bf))
-
-### Code Refactoring
-
-* **address-book-admin:** replace Chain select with number input for Chain ID ([45fce7b](https://github.com/paxoslabs/paxos-labs-monorepo/commit/45fce7b71c1ffd97400f09573491d78577bf389f))
-* Extract shared utilities and simplify SDK config state ([ae23b66](https://github.com/paxoslabs/paxos-labs-monorepo/commit/ae23b6686cbd261ffef2cb7f5835e1974d59a03f))
-* isolate distributor_code_depositor column rename to DB layer ([631212b](https://github.com/paxoslabs/paxos-labs-monorepo/commit/631212b6fdcae70dac6e0c5f3b5c014d37471c96))
-* **sdk:** rename fetchVaults/fetchSupportedAssets to getVaults/getSupportedAssets ([8e65846](https://github.com/paxoslabs/paxos-labs-monorepo/commit/8e6584609eb0a184c6ffe9d4a42d36fe63f81b5a))
-
 ## [0.4.3-alpha.1] (2026-03-13)
 
 ### ⚠ BREAKING CHANGES
 
-* **vaults:** `yieldType` parameter removed from all deposit and withdrawal method arguments — replace with `vaultName: string` (e.g. `"Amplify USDC Core"`) across `prepareDepositTxData()`, `prepareDeposit()`, `prepareWithdrawOrderTxData()`, `prepareWithdrawal()`, and related authorization methods 209599d7
+- **vaults:** `yieldType` parameter removed from all deposit and withdrawal method arguments — replace with `vaultName: string` (e.g. `"Amplify USDC Core"`) across `prepareDepositTxData()`, `prepareDeposit()`, `prepareWithdrawOrderTxData()`, `prepareWithdrawal()`, and related authorization methods 209599d7
 
 ### Features
 

package/README.md

@@ -49,56 +49,56 @@ import {
   prepareDepositAuthorization,
   prepareDeposit,
   DepositAuthMethod,
-} from "@paxoslabs/amplify-sdk";
+} from '@paxoslabs/amplify-sdk'
 
 // Initialize SDK with your API key
-await initAmplifySDK("pxl_your_api_key");
+await initAmplifySDK('pxl_your_api_key')
 
 // Or initialize with custom RPC URLs for better reliability
-await initAmplifySDK("pxl_your_api_key", {
+await initAmplifySDK('pxl_your_api_key', {
   rpcUrls: {
-    1: "https://my-eth-rpc.com",       // Ethereum
-    999: "https://my-hyperEVM-rpc.com", // HyperEVM
+    1: 'https://my-eth-rpc.com', // Ethereum
+    999: 'https://my-hyperEVM-rpc.com', // HyperEVM
   },
-});
+})
 
 // Prepare deposit authorization (auto-detects permit vs approval)
 const auth = await prepareDepositAuthorization({
-  yieldType: "CORE",
-  depositAsset: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48", // USDC
-  depositAmount: "1000.0",
+  yieldType: 'CORE',
+  depositAsset: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
+  depositAmount: '1000.0',
   to: userAddress,
   chainId: 1,
-});
+})
 
 // Shared deposit parameters
 const depositParams = {
-  yieldType: "CORE",
-  depositAsset: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
-  depositAmount: "1000.0",
+  yieldType: 'CORE',
+  depositAsset: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48',
+  depositAmount: '1000.0',
   to: userAddress,
   chainId: 1,
-};
+}
 
 // Handle based on authorization method
 if (auth.method === DepositAuthMethod.PERMIT) {
   // Token supports EIP-2612: sign permit and deposit in one transaction
-  const signature = await signTypedData(auth.permitData);
+  const signature = await signTypedData(auth.permitData)
   const tx = await prepareDeposit({
     ...depositParams,
     signature,
     deadline: auth.permitData.message.deadline,
-  });
-  await writeContract(tx.txData);
+  })
+  await writeContract(tx.txData)
 } else if (auth.method === DepositAuthMethod.APPROVAL) {
   // Token requires ERC20 approval: approve first, then deposit
-  await writeContract(auth.txData);
-  const tx = await prepareDeposit(depositParams);
-  await writeContract(tx.txData);
+  await writeContract(auth.txData)
+  const tx = await prepareDeposit(depositParams)
+  await writeContract(tx.txData)
 } else if (auth.method === DepositAuthMethod.ALREADY_APPROVED) {
   // Sufficient allowance exists: proceed directly to deposit
-  const tx = await prepareDeposit(depositParams);
-  await writeContract(tx.txData);
+  const tx = await prepareDeposit(depositParams)
+  await writeContract(tx.txData)
 }
 ```
 

package/dist/{chain-utils-D_b2LEEi.d.mts → chain-utils-5r2UnCDS.d.mts}

@@ -53,6 +53,14 @@ interface VaultContracts {
     baseTokenStandIn?: Address;
     communityCodeDepositorAddress?: Address;
     withdrawQueueAddress?: Address;
+    depositFeeModuleAddress?: Address;
+    withdrawFeeModuleAddress?: Address;
+}
+/**
+ * Enterprise customer configuration for compliance features (e.g. KYT).
+ */
+interface EnterpriseConfig {
+    predicatePolicyId: string | null;
 }
 /**
  * A single depositable/withdrawable asset supported by a vault.
@@ -112,6 +120,39 @@ interface VaultSLA {
     externalWithdrawalQueueDelaySLA: number;
     externalAccountantRateUpdateSLA: number;
 }
+/**
+ * Deposit cap data read on-chain from a CommunityCodeDepositor contract.
+ * Only populated for vaults that have both `communityCodeDepositorAddress`
+ * and `depositFeeModuleAddress` configured.
+ */
+interface VaultDepositCap {
+    supplyCapInBase: bigint;
+    /** True when `supplyCapInBase` is neither `0` nor `maxUint256` (unlimited). */
+    hasDepositCap: boolean;
+}
+interface VaultDepositFeeEntry {
+    /** Deposit asset address, null for global/default fee that applies to all assets */
+    depositAsset: Address | null;
+    /** Fee percentage as raw bigint (denominator 1e18 for DCD contracts), 0n when no fee */
+    feePercentage: bigint;
+    /** Flat fee as raw bigint, 0n when no fee */
+    flatFee: bigint;
+}
+interface VaultDepositFees {
+    hasFees: boolean;
+    feeModuleAddress: Address | null;
+    fees: VaultDepositFeeEntry[];
+    /** ONE_HUNDRED_PERCENT constant from the fee module contract (denominator for percentage and flat fee calculations) */
+    oneHundredPercent?: bigint;
+}
+interface VaultWithdrawFees {
+    hasFees: boolean;
+    feeModuleAddress: Address | null;
+    /** Offer fee in basis points (e.g. 100n = 1%), 0n when no fee */
+    offerFeeBps: bigint;
+    /** Offer fee rate as raw bigint from indexer, 0n when no fee */
+    offerFeeRate: bigint;
+}
 interface AmplifyVault {
     /** Unique identifier for the vault configuration */
     id: string;
@@ -121,12 +162,27 @@ interface AmplifyVault {
     yieldType: YieldType;
     /** Human-readable vault name */
     name: string;
+    /** Whether the vault is being deprecated */
+    inDeprecation: boolean;
     /** Vault smart contract addresses */
     vault: VaultContracts;
+    /** Enterprise customer configuration (compliance settings, e.g. KYT) */
+    enterpriseConfig?: EnterpriseConfig;
     /** SLA data from VaultSLAs table */
     sla?: VaultSLA;
+    /** Whether this vault uses atomic settlement via submitOrderAndProcessAll */
+    atomicWithdrawal: boolean;
     /** Supported deposit assets for this vault */
     supportedAssets: VaultSupportedAsset[];
+    /**
+     * Deposit cap data — only present for vaults with both a
+     * CommunityCodeDepositor and a deposit fee module.
+     */
+    depositCap?: VaultDepositCap;
+    /** (Optional) deposits fees for this vault */
+    depositFees?: VaultDepositFees;
+    /** (Optional) withdraw queue fees for this vault */
+    withdrawFees?: VaultWithdrawFees;
 }
 /**
  * Supported asset (token) metadata
@@ -321,4 +377,4 @@ declare function getChainFromConfig(chainId: number, config?: AmplifyVault[]): P
  */
 declare function clearChainsCache(): void;
 
-export { type AmplifyVault as A, type ChainId as C, type SupportedAsset as S, type VaultFilterOptions as V, type WithdrawSupportedAsset as W, YieldType as Y, type AssetFilterOptions as a, APIError as b, clearChainsCache as c, type VaultSLA as d, type VaultSupportedAsset as e, getChainFromConfig as g, toChainId as t };
+export { type AmplifyVault as A, type ChainId as C, type EnterpriseConfig as E, type SupportedAsset as S, type VaultFilterOptions as V, type WithdrawSupportedAsset as W, YieldType as Y, type AssetFilterOptions as a, APIError as b, clearChainsCache as c, type VaultDepositFees as d, type VaultSLA as e, type VaultSupportedAsset as f, getChainFromConfig as g, type VaultWithdrawFees as h, toChainId as t };

package/dist/{chain-utils-D_b2LEEi.d.ts → chain-utils-5r2UnCDS.d.ts}

@@ -53,6 +53,14 @@ interface VaultContracts {
     baseTokenStandIn?: Address;
     communityCodeDepositorAddress?: Address;
     withdrawQueueAddress?: Address;
+    depositFeeModuleAddress?: Address;
+    withdrawFeeModuleAddress?: Address;
+}
+/**
+ * Enterprise customer configuration for compliance features (e.g. KYT).
+ */
+interface EnterpriseConfig {
+    predicatePolicyId: string | null;
 }
 /**
  * A single depositable/withdrawable asset supported by a vault.
@@ -112,6 +120,39 @@ interface VaultSLA {
     externalWithdrawalQueueDelaySLA: number;
     externalAccountantRateUpdateSLA: number;
 }
+/**
+ * Deposit cap data read on-chain from a CommunityCodeDepositor contract.
+ * Only populated for vaults that have both `communityCodeDepositorAddress`
+ * and `depositFeeModuleAddress` configured.
+ */
+interface VaultDepositCap {
+    supplyCapInBase: bigint;
+    /** True when `supplyCapInBase` is neither `0` nor `maxUint256` (unlimited). */
+    hasDepositCap: boolean;
+}
+interface VaultDepositFeeEntry {
+    /** Deposit asset address, null for global/default fee that applies to all assets */
+    depositAsset: Address | null;
+    /** Fee percentage as raw bigint (denominator 1e18 for DCD contracts), 0n when no fee */
+    feePercentage: bigint;
+    /** Flat fee as raw bigint, 0n when no fee */
+    flatFee: bigint;
+}
+interface VaultDepositFees {
+    hasFees: boolean;
+    feeModuleAddress: Address | null;
+    fees: VaultDepositFeeEntry[];
+    /** ONE_HUNDRED_PERCENT constant from the fee module contract (denominator for percentage and flat fee calculations) */
+    oneHundredPercent?: bigint;
+}
+interface VaultWithdrawFees {
+    hasFees: boolean;
+    feeModuleAddress: Address | null;
+    /** Offer fee in basis points (e.g. 100n = 1%), 0n when no fee */
+    offerFeeBps: bigint;
+    /** Offer fee rate as raw bigint from indexer, 0n when no fee */
+    offerFeeRate: bigint;
+}
 interface AmplifyVault {
     /** Unique identifier for the vault configuration */
     id: string;
@@ -121,12 +162,27 @@ interface AmplifyVault {
     yieldType: YieldType;
     /** Human-readable vault name */
     name: string;
+    /** Whether the vault is being deprecated */
+    inDeprecation: boolean;
     /** Vault smart contract addresses */
     vault: VaultContracts;
+    /** Enterprise customer configuration (compliance settings, e.g. KYT) */
+    enterpriseConfig?: EnterpriseConfig;
     /** SLA data from VaultSLAs table */
     sla?: VaultSLA;
+    /** Whether this vault uses atomic settlement via submitOrderAndProcessAll */
+    atomicWithdrawal: boolean;
     /** Supported deposit assets for this vault */
     supportedAssets: VaultSupportedAsset[];
+    /**
+     * Deposit cap data — only present for vaults with both a
+     * CommunityCodeDepositor and a deposit fee module.
+     */
+    depositCap?: VaultDepositCap;
+    /** (Optional) deposits fees for this vault */
+    depositFees?: VaultDepositFees;
+    /** (Optional) withdraw queue fees for this vault */
+    withdrawFees?: VaultWithdrawFees;
 }
 /**
  * Supported asset (token) metadata
@@ -321,4 +377,4 @@ declare function getChainFromConfig(chainId: number, config?: AmplifyVault[]): P
  */
 declare function clearChainsCache(): void;
 
-export { type AmplifyVault as A, type ChainId as C, type SupportedAsset as S, type VaultFilterOptions as V, type WithdrawSupportedAsset as W, YieldType as Y, type AssetFilterOptions as a, APIError as b, clearChainsCache as c, type VaultSLA as d, type VaultSupportedAsset as e, getChainFromConfig as g, toChainId as t };
+export { type AmplifyVault as A, type ChainId as C, type EnterpriseConfig as E, type SupportedAsset as S, type VaultFilterOptions as V, type WithdrawSupportedAsset as W, YieldType as Y, type AssetFilterOptions as a, APIError as b, clearChainsCache as c, type VaultDepositFees as d, type VaultSLA as e, type VaultSupportedAsset as f, getChainFromConfig as g, type VaultWithdrawFees as h, toChainId as t };