@paxoslabs/amplify-sdk 0.0.1 → 0.1.0-alpha.0

package/CHANGELOG.md

@@ -7,6 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <!-- auto-changelog-above -->
 
+
+## [0.1.0-alpha.0](https://github.com/Ion-Protocol/amplify-sdk/compare/v0.0.2...v0.1.0-alpha.0) (2025-12-08)
+
+### Features
+
+* **deposit:** export CommunityCodeDepositTxData type and fix cache check ([426f711](https://github.com/Ion-Protocol/amplify-sdk/commit/426f7116ddd72309aca2e77117a622d6a6a1e0dd))
+
+### Bug Fixes
+
+* **deposit:** update CommunityCodeDepositor support for partner code deposits ([c8c281e](https://github.com/Ion-Protocol/amplify-sdk/commit/c8c281efcbc69b9ce3fd887c5ece6a19688004f3))
+* **lint:** remove unused variables and useless try-catch ([5d1ed6d](https://github.com/Ion-Protocol/amplify-sdk/commit/5d1ed6dc73693714127d6ea79afff781b34c1bab))
+* **types:** improve type safety and chain cache initialization ([03bcf41](https://github.com/Ion-Protocol/amplify-sdk/commit/03bcf4171fd72fc1bd55d84301cd78f55f2d57b2))
+
+### Styles
+
+* apply formatting and update branding to Amplify SDK ([c9f4d19](https://github.com/Ion-Protocol/amplify-sdk/commit/c9f4d193286b6b5fdfdf18a26ce9f6e2704f719f))
+
+### Code Refactoring
+
+* **chain-utils:** remove redundant optional chaining after null check ([22f1181](https://github.com/Ion-Protocol/amplify-sdk/commit/22f1181e9e670436a2eda1d6ef7e6921a4c61188))
+
 ## [Unreleased]
 
 ### BREAKING CHANGES
@@ -109,4 +130,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Configured semantic versioning with alpha/beta/rc support
 - Implemented comprehensive CI/CD pipeline with quality gates
 - Added security auditing and dependency scanning
-- Configured automated NPM publishing with provenance
+- Configured automated NPM publishing with provenance

package/README.md

@@ -12,29 +12,7 @@
 A TypeScript SDK for interacting with Paxos Labs Amplify Vaults, providing type-safe functions for discovering vaults, depositing assets, and withdrawing across multiple blockchain networks.
 
 [![npm version](https://img.shields.io/npm/v/@paxoslabs/amplify-sdk.svg)](https://www.npmjs.com/package/@paxoslabs/amplify-sdk)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-## Table of Contents
-
-- [Features](#features)
-- [Quick Start (5 Minutes)](#quick-start-5-minutes)
-- [Documentation](#documentation)
-  - [Complete Guides](#-complete-guides)
-  - [Example Projects](#-example-projects)
-- [Core API Overview](#core-api-overview)
-  - [Vault Discovery](#vault-discovery)
-  - [Cache Management](#cache-management)
-  - [Deposits](#deposits)
-  - [Permit Deposits (Gas-Optimized)](#permit-deposits-gas-optimized)
-  - [Withdrawals](#withdrawals)
-- [TypeScript Support](#typescript-support)
-- [Error Handling](#error-handling)
-- [Supported Networks](#supported-networks)
-- [Requirements](#requirements)
-- [API Configuration](#api-configuration)
-- [Available Vault Keys](#available-vault-keys)
-- [Contributing](#contributing)
-- [License](#license)
+[![License: BSD 3-Clause](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
 
 ## Features
 
@@ -47,9 +25,7 @@ A TypeScript SDK for interacting with Paxos Labs Amplify Vaults, providing type-
 - **Full TypeScript Support** - Complete type definitions and autocomplete
 - **React Ready** - Works with viem (vanilla) and wagmi (React hooks)
 
-## Quick Start (5 Minutes)
-
-### 1. Installation
+## Installation
 
 ```bash
 # npm
@@ -65,469 +41,18 @@ pnpm add @paxoslabs/amplify-sdk viem
 pnpm add wagmi @tanstack/react-query
 ```
 
-### 2. Initialize the SDK
-
-**⚠️ Required**: Initialize the SDK with your API key before using any functions.
-
-```typescript
-import { initAmplifySDK } from "@paxoslabs/amplify-sdk";
-
-// Initialize SDK with your API key
-await initAmplifySDK("pxl_your_api_key_here");
-```
-
-**Get Your API Key**: Contact Paxos Labs to request an API key for access.
-
-**Environment Variables** (Recommended):
-
-```bash
-# .env file
-PAXOS_API_KEY=pxl_your_api_key_here
-```
-
-```typescript
-// In your app
-await initAmplifySDK(process.env.PAXOS_API_KEY!);
-```
-
-**Features**:
-
-- ✅ **Automatic Authentication**: All API calls include authentication headers
-- ✅ **Cache Pre-population**: Vaults and assets cached during initialization
-- ✅ **Idempotent**: Multiple calls with same key are safe (no-op)
-- ✅ **Re-initialization**: Switch API keys at runtime for environment changes
-
-### 3. Discover Available Vaults
-
-```typescript
-import { fetchVaults } from "@paxoslabs/amplify-sdk";
-
-// Fetch all available vaults
-const allVaults = await fetchVaults();
-
-// Or filter by chain and yield type
-const primeVaults = await fetchVaults({
-  chainId: 1, // Ethereum mainnet
-  yieldType: "PRIME",
-});
-
-console.log(`Found ${primeVaults.length} PRIME vaults on Ethereum`);
-```
-
-### 4. Find Supported Deposit Assets
-
-```typescript
-import { fetchSupportedAssets } from "@paxoslabs/amplify-sdk";
-
-// Fetch assets supported for deposits
-const assets = await fetchSupportedAssets({
-  chainId: 1, // Ethereum mainnet
-});
-
-// Find USDC
-const usdc = assets.find((asset) => asset.symbol === "USDC");
-console.log(`USDC address: ${usdc?.address}`);
-```
-
-### 5. Deposit into a Vault (Viem)
-
-```typescript
-import { createWalletClient, http } from "viem";
-import { mainnet } from "viem/chains";
-import { privateKeyToAccount } from "viem/accounts";
-import {
-  prepareApproveDepositToken,
-  prepareDepositTransactionData,
-  isDepositSpendApproved,
-} from "@paxoslabs/amplify-sdk";
-
-// Setup viem client
-const account = privateKeyToAccount("0x...");
-const client = createWalletClient({
-  account,
-  chain: mainnet,
-  transport: http(),
-});
-
-async function deposit() {
-  const vaultKey = "op-nTBILL"; // T-Bill vault
-  const tokenSymbol = "USDC";
-  const amount = "1000.0"; // $1000 USDC
-  const chainId = 1;
-
-  // 1. Check if approval needed
-  const isApproved = await isDepositSpendApproved({
-    vaultKey,
-    userAddress: account.address,
-    depositTokenSymbol: tokenSymbol,
-    depositAmount: amount,
-    chainId,
-  });
-
-  // 2. Approve if needed
-  if (!isApproved) {
-    const approvalTx = await prepareApproveDepositToken({
-      vaultKey,
-      depositTokenSymbol: tokenSymbol,
-      depositAmount: amount,
-      chainId,
-    });
-
-    const approvalHash = await client.writeContract(approvalTx);
-    console.log(`Approval tx: ${approvalHash}`);
-    // Wait for approval confirmation...
-  }
-
-  // 3. Prepare and execute deposit
-  const depositTx = await prepareDepositTransactionData({
-    vaultKey,
-    userAddress: account.address,
-    depositTokenSymbol: tokenSymbol,
-    depositAmount: amount,
-    chainId,
-    slippage: 100, // 1% slippage (100 basis points)
-  });
-
-  const depositHash = await client.writeContract(depositTx);
-  console.log(`Deposit tx: ${depositHash}`);
-}
-
-deposit();
-```
-
-### 5. Deposit into a Vault (Wagmi + React)
-
-```tsx
-import { useAccount, useWriteContract } from "wagmi";
-import {
-  prepareApproveDepositToken,
-  prepareDepositTransactionData,
-  isDepositSpendApproved,
-} from "@paxoslabs/amplify-sdk";
-
-function DepositComponent() {
-  const { address } = useAccount();
-  const { writeContract } = useWriteContract();
-
-  const handleDeposit = async () => {
-    if (!address) return;
-
-    const vaultKey = "op-nTBILL";
-    const tokenSymbol = "USDC";
-    const amount = "1000.0";
-    const chainId = 1;
-
-    try {
-      // Check approval
-      const isApproved = await isDepositSpendApproved({
-        vaultKey,
-        userAddress: address,
-        depositTokenSymbol: tokenSymbol,
-        depositAmount: amount,
-        chainId,
-      });
-
-      // Approve if needed
-      if (!isApproved) {
-        const approvalTx = await prepareApproveDepositToken({
-          vaultKey,
-          depositTokenSymbol: tokenSymbol,
-          depositAmount: amount,
-          chainId,
-        });
-        await writeContract(approvalTx);
-      }
-
-      // Execute deposit
-      const depositTx = await prepareDepositTransactionData({
-        vaultKey,
-        userAddress: address,
-        depositTokenSymbol: tokenSymbol,
-        depositAmount: amount,
-        chainId,
-        slippage: 100, // 1%
-      });
-
-      await writeContract(depositTx);
-    } catch (error) {
-      console.error("Deposit failed:", error);
-    }
-  };
-
-  return <button onClick={handleDeposit}>Deposit $1000 USDC</button>;
-}
-```
-
-**That's it!** You've discovered vaults and executed your first deposit. ✨
-
 ## Documentation
 
-### 📚 Complete Guides
-
-- **[Getting Started Guide](./docs/getting-started.md)** - Detailed setup and first API call
-- **[API Reference: Vault Discovery](./docs/api-reference/vault-discovery.md)** - Fetch vaults and assets
-- **[API Reference: Deposits](./docs/api-reference/deposits.md)** - Standard deposit flows
-- **[API Reference: Permit Deposits](./docs/api-reference/deposits-permit.md)** - Gas-optimized deposits
-- **[API Reference: Withdrawals](./docs/api-reference/withdrawals.md)** - Withdrawal flows
-- **[API Reference: Caching](./docs/api-reference/caching.md)** - Performance optimization
-- **[API Reference: Types](./docs/api-reference/types.md)** - TypeScript type definitions
-- **[Guide: Error Handling](./docs/guides/error-handling.md)** - Error patterns and recovery
-- **[Guide: React Integration](./docs/guides/react-integration.md)** - React patterns and hooks
-- **[Guide: Multi-Chain Operations](./docs/guides/multi-chain.md)** - Cross-chain deposits/withdrawals
-
-### 💻 Example Projects
-
-- **[Viem Deposit Example](./docs/examples/viem-deposit/)** - Executable viem deposit example
-- **[Wagmi Deposit Example](./docs/examples/wagmi-deposit/)** - React wagmi deposit component
-- **[Wagmi Withdrawal Example](./docs/examples/wagmi-withdraw/)** - React wagmi withdrawal component
-
-## Core API Overview
-
-### Vault Discovery
-
-```typescript
-import {
-  fetchVaults,
-  fetchSupportedAssets,
-  getWithdrawSupportedAssets,
-} from "@paxoslabs/amplify-sdk";
-
-// Discover vaults
-const vaults = await fetchVaults({
-  chainId: 1,
-  yieldType: "PRIME", // or "TBILL", "LENDING"
-});
-
-// Discover deposit assets
-const depositAssets = await fetchSupportedAssets({
-  chainId: 1,
-  symbol: "USDC",
-});
-
-// Discover withdrawal assets
-const withdrawAssets = await getWithdrawSupportedAssets();
-```
-
-### Cache Management
-
-```typescript
-import {
-  initializeCache,
-  getVaultsFromCache,
-  getAssetsFromCache,
-  refreshVaultCache,
-} from "@paxoslabs/amplify-sdk";
-
-// Initialize cache (recommended at app startup)
-await initializeCache();
-
-// Use cached data (80% faster than API calls)
-const cachedVaults = await getVaultsFromCache({ chainId: 1 });
-const cachedAssets = await getAssetsFromCache({ symbol: "USDC" });
-
-// Refresh cache periodically
-await refreshVaultCache();
-```
-
-### Deposits
-
-```typescript
-import {
-  prepareDepositTransactionData,
-  prepareApproveDepositToken,
-  isDepositSpendApproved,
-} from "@paxoslabs/amplify-sdk";
-
-// Check approval status
-const isApproved = await isDepositSpendApproved({
-  vaultKey: "op-nTBILL",
-  userAddress: "0x...",
-  depositTokenSymbol: "USDC",
-  depositAmount: "1000.0",
-  chainId: 1,
-});
-
-// Prepare approval transaction
-const approvalTx = await prepareApproveDepositToken({
-  vaultKey: "op-nTBILL",
-  depositTokenSymbol: "USDC",
-  depositAmount: "1000.0",
-  chainId: 1,
-});
-
-// Prepare deposit transaction
-const depositTx = await prepareDepositTransactionData({
-  vaultKey: "op-nTBILL",
-  userAddress: "0x...",
-  depositTokenSymbol: "USDC",
-  depositAmount: "1000.0",
-  chainId: 1,
-  slippage: 100, // 1% (100 basis points)
-});
-```
-
-### Permit Deposits (Gas-Optimized)
-
-```typescript
-import {
-  prepareDepositWithPermitTransactionData,
-  type PrepareDepositWithPermitTransactionDataParams,
-} from "@paxoslabs/amplify-sdk";
-
-// Sign permit message off-chain (using viem or wagmi)
-const signature = await signTypedData({
-  /* permit EIP-2612 typed data */
-});
-
-// Execute deposit with permit in single transaction
-const permitDepositTx = await prepareDepositWithPermitTransactionData({
-  vaultKey: "op-nTBILL",
-  userAddress: "0x...",
-  depositTokenSymbol: "USDC",
-  depositAmount: "1000.0",
-  chainId: 1,
-  permitSignature: signature,
-  deadline: Math.floor(Date.now() / 1000) + 3600, // 1 hour
-});
-```
-
-### Withdrawals
-
-```typescript
-import {
-  prepareWithdrawTransactionData,
-  prepareApproveWithdrawToken,
-  isWithdrawalSpendApproved,
-} from "@paxoslabs/amplify-sdk";
-
-// Check if vault shares are approved
-const isApproved = await isWithdrawalSpendApproved({
-  vaultKey: "op-nTBILL",
-  userAddress: "0x...",
-  withdrawAmount: "100.0", // vault shares
-  chainId: 1,
-});
-
-// Approve vault shares
-const approvalTx = await prepareApproveWithdrawToken({
-  vaultKey: "op-nTBILL",
-  withdrawAmount: "100.0",
-  chainId: 1,
-});
-
-// Withdraw assets
-const withdrawTx = await prepareWithdrawTransactionData({
-  vaultKey: "op-nTBILL",
-  chainId: 1,
-  userAddress: "0x...",
-  wantTokenSymbol: "USDC",
-  offerAmount: "100.0", // vault shares to redeem
-  deadline: Math.floor(Date.now() / 1000) + 3600, // 1 hour
-  slippage: 100, // 1%
-});
-```
-
-## TypeScript Support
-
-Full type definitions with autocomplete:
-
-```typescript
-import type {
-  AmplifyVault,
-  SupportedAsset,
-  VaultFilterOptions,
-  VaultKey,
-  ChainId,
-  DepositTransactionData,
-  WithdrawTransactionData,
-  PrepareDepositTransactionDataParams,
-} from "@paxoslabs/amplify-sdk";
-
-// All functions have full TypeScript support
-const depositData: DepositTransactionData = await prepareDepositTransactionData(
-  {
-    // TypeScript provides autocomplete and validation
-  }
-);
-```
-
-## Error Handling
-
-```typescript
-import { APIError } from "@paxoslabs/amplify-sdk";
-
-try {
-  const vaults = await fetchVaults({ chainId: 1 });
-} catch (error) {
-  if (error instanceof APIError) {
-    console.error(`API Error: ${error.message}`);
-    console.error(`Endpoint: ${error.context?.endpoint}`);
-    console.error(`Status: ${error.context?.status}`);
-  } else {
-    console.error("Unexpected error:", error);
-  }
-}
-```
-
-## Supported Networks
-
-| Network          | Chain ID   | Status |
-| ---------------- | ---------- | ------ |
-| Ethereum Mainnet | 1          | ✅     |
-| HyperEVM         | 999        | ✅     |
-| Boba Network     | 288        | ✅     |
-| Sei Network      | 713715     | ✅     |
-| Plume Mainnet    | 98866      | ✅     |
-| Form Network     | 478        | ✅     |
-| Swell Mainnet    | 1923       | ✅     |
-| Rari Chain       | 1380012617 | ✅     |
-
-## Requirements
-
-- **Node.js** >= 20
-- **TypeScript** >= 4.9.0 (optional but recommended)
-- **viem** >= 2.0.0 (required)
-- **wagmi** >= 2.0.0 (for React applications)
-- **@tanstack/react-query** >= 5.0.0 (for React applications)
-
-## API Configuration
-
-The SDK connects to the Amplify API at `http://localhost:8500` by default. This is suitable for development environments. For production deployments, you'll need to configure the API endpoint according to your backend setup.
-
-**Note**: All API calls have a 10-second timeout. Network requests that exceed this timeout will throw an `APIError`.
-
-## Available Vault Keys
-
-```typescript
-import { VaultKeys } from "@paxoslabs/amplify-sdk";
-
-console.log(VaultKeys);
-// {
-//   OPNALPHA: "op-nALPHA",
-//   OPNBASIS: "op-nBASIS",
-//   OPNETF: "op-nETF",
-//   OPNPAYFI: "op-nPAYFI",
-//   OPNPLUME: "op-PLUME",
-//   OPNRWA: "op-nRWA",
-//   OPNTBILL: "op-nTBILL",
-//   OPPUSD: "op-pUSD",
-//   XLHYPE: "XLHYPE",
-//   CAMPUSD: "campUSD"
-// }
-```
-
-## Contributing
-
-Contributions are welcome! Please read our [Contributing Guide](./CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+Full documentation at https://developers.paxoslabs.com/
 
 ## License
 
-MIT © Paxos Labs
+BSD © Paxos Labs
 
 ---
 
 **Need Help?**
 
-- 📖 [Full Documentation](./docs/getting-started.md)
+- 📖 [Full Documentation](./docs/getting-started.mdx)
 - 🐛 [Report Issues](https://github.com/Ion-Protocol/amplify-sdk/issues)
 - 💬 [GitHub Discussions](https://github.com/Ion-Protocol/amplify-sdk/discussions)

package/dist/{amplify-sdk-api-DPrRhynk.d.mts → amplify-sdk-api-Biol0OIp.d.mts}

@@ -144,7 +144,7 @@ interface VaultFilterOptions {
     /** Filter by yield type */
     yieldType?: YieldType;
     /** Filter by deposit token address */
-    depositTokenAddress?: string;
+    depositTokenAddress?: Address;
 }
 /**
  * Filter options for asset queries

package/dist/{amplify-sdk-api-B5hBTGrB.d.ts → amplify-sdk-api-DGRgEybp.d.ts}

@@ -144,7 +144,7 @@ interface VaultFilterOptions {
     /** Filter by yield type */
     yieldType?: YieldType;
     /** Filter by deposit token address */
-    depositTokenAddress?: string;
+    depositTokenAddress?: Address;
 }
 /**
  * Filter options for asset queries

package/dist/{chunk-IBNTWZ4S.js → chunk-B2QCI6ET.js}

@@ -551,7 +551,7 @@ async function findVaultByConfig(params) {
     );
   }
   const cache = getCache();
-  if (cache.isExpired()) {
+  if (cache.isEmpty() || cache.isExpired()) {
     await cache.refresh();
   }
   const normalizedAddress = params.assetAddress.toLowerCase();
@@ -765,15 +765,9 @@ var CHAIN_ID_TO_CHAIN_MAP = {
 // src/utils/chain-utils.ts
 var chainsCache = null;
 async function getChainFromConfig(chainId, config) {
-  console.log("[Amplify SDK] getChainFromConfig called for chainId:", chainId);
   if (chainsCache && !config) {
     const chain2 = chainsCache.get(Number(chainId));
     if (chain2) {
-      console.log("[Amplify SDK] Returning cached chain:", {
-        chainId: chain2.id,
-        name: chain2.name,
-        hasMulticall3: !!chain2.contracts?.multicall3
-      });
       return chain2;
     }
   }
@@ -782,30 +776,20 @@ async function getChainFromConfig(chainId, config) {
   if (!vault) {
     throw new Error(`Vault not found for ID: ${chainId}`);
   }
-  const sourceChain = CHAIN_ID_TO_CHAIN_MAP[chainId];
-  console.log("[Amplify SDK] Source chain from CHAIN_ID_TO_CHAIN_MAP:", {
-    chainId,
-    found: !!sourceChain,
-    hasMulticall3: !!sourceChain?.contracts?.multicall3,
-    multicall3Address: sourceChain?.contracts?.multicall3?.address
-  });
   if (config && !chainsCache) {
     const cache = /* @__PURE__ */ new Map();
     for (const v of vaults) {
-      if (v.chainId === chainId) {
-        const chainConfig = CHAIN_ID_TO_CHAIN_MAP[v.chainId];
-        cache.set(v.chainId, {
-          id: v.chainId,
-          name: chainConfig?.name,
-          nativeCurrency: chainConfig?.nativeCurrency,
-          rpcUrls: chainConfig?.rpcUrls,
-          contracts: chainConfig?.contracts
-        });
-        console.log("[Amplify SDK] Cached chain config:", {
-          chainId: v.chainId,
-          hasMulticall3: !!chainConfig?.contracts?.multicall3
-        });
+      const chainConfig = CHAIN_ID_TO_CHAIN_MAP[v.chainId];
+      if (!chainConfig) {
+        throw new Error(`Chain config not found for ID: ${v.chainId}`);
       }
+      cache.set(v.chainId, {
+        id: v.chainId,
+        name: chainConfig.name,
+        nativeCurrency: chainConfig.nativeCurrency,
+        rpcUrls: chainConfig.rpcUrls,
+        contracts: chainConfig.contracts
+      });
     }
     chainsCache = cache;
   }
@@ -813,12 +797,6 @@ async function getChainFromConfig(chainId, config) {
   if (!chain) {
     throw new Error(`Chain not found for ID: ${chainId}`);
   }
-  console.log("[Amplify SDK] Returning chain:", {
-    chainId: chain.id,
-    name: chain.name,
-    hasMulticall3: !!chain.contracts?.multicall3,
-    multicall3Address: chain.contracts?.multicall3?.address
-  });
   return chain;
 }
 function clearChainsCache() {
@@ -851,5 +829,5 @@ exports.getWithdrawSupportedAssets = getWithdrawSupportedAssets;
 exports.initAmplifySDK = initAmplifySDK;
 exports.initializeCache = initializeCache;
 exports.refreshVaultCache = refreshVaultCache;
-//# sourceMappingURL=chunk-IBNTWZ4S.js.map
-//# sourceMappingURL=chunk-IBNTWZ4S.js.map
+//# sourceMappingURL=chunk-B2QCI6ET.js.map
+//# sourceMappingURL=chunk-B2QCI6ET.js.map