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

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Address, erc20Abi, Hex } from 'viem';
-import { A as AmplifyVault, S as SupportedAsset, a as AssetFilterOptions, V as VaultFilterOptions, W as WithdrawSupportedAsset } from './amplify-sdk-api-B5hBTGrB.js';
-export { b as APIError } from './amplify-sdk-api-B5hBTGrB.js';
-export { g as getDepositExchangeRate, a as getWithdrawExchangeRate, i as isDepositSpendApproved, b as isWithdrawalSpendApproved } from './exchange-rate-D3_FVgqa.js';
+import { Address, erc20Abi, ByteArray, Hex } from 'viem';
+import { A as AmplifyVault, S as SupportedAsset, a as AssetFilterOptions, V as VaultFilterOptions, W as WithdrawSupportedAsset } from './amplify-sdk-api-DGRgEybp.js';
+export { b as APIError } from './amplify-sdk-api-DGRgEybp.js';
+export { g as getDepositExchangeRate, a as getWithdrawExchangeRate, i as isDepositSpendApproved, b as isWithdrawalSpendApproved } from './exchange-rate-Cp1ddpw4.js';
 import { Y as YieldType } from './config-B-u3VqEX.js';
 import { C as ChainId } from './vault-config-BNzhv3QV.js';
 import './config-BQynVNDC.js';
@@ -509,6 +509,228 @@ interface ApproveDepositTokenTxData {
  */
 declare function prepareApproveDepositTokenTxData({ yieldType, depositToken, approvalAmount, chainId, }: PrepareApproveDepositTokenTxParams): Promise<ApproveDepositTokenTxData>;
 
+declare const CommunityCodeDepositorAbi: readonly [{
+    readonly type: "constructor";
+    readonly inputs: readonly [{
+        readonly name: "_teller";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "_owner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "authority";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "contract Authority";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "boringVault";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "deposit";
+    readonly inputs: readonly [{
+        readonly name: "depositAsset";
+        readonly type: "address";
+        readonly internalType: "contract ERC20";
+    }, {
+        readonly name: "depositAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minimumMint";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "communityCode";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "depositNative";
+    readonly inputs: readonly [{
+        readonly name: "depositAmount";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minimumMint";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly internalType: "address";
+    }, {
+        readonly name: "communityCode";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "shares";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "payable";
+}, {
+    readonly type: "function";
+    readonly name: "depositNonce";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "owner";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "setAuthority";
+    readonly inputs: readonly [{
+        readonly name: "newAuthority";
+        readonly type: "address";
+        readonly internalType: "contract Authority";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "teller";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "address";
+        readonly internalType: "contract TellerWithMultiAssetSupport";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "transferOwnership";
+    readonly inputs: readonly [{
+        readonly name: "newOwner";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "event";
+    readonly name: "AuthorityUpdated";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newAuthority";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "contract Authority";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "DepositWithCommunityCode";
+    readonly inputs: readonly [{
+        readonly name: "depositor";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "depositAsset";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "contract ERC20";
+    }, {
+        readonly name: "depositAmount";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "minimumMint";
+        readonly type: "uint256";
+        readonly indexed: false;
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "to";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "depositHash";
+        readonly type: "bytes32";
+        readonly indexed: false;
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "communityCode";
+        readonly type: "bytes";
+        readonly indexed: false;
+        readonly internalType: "bytes";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "event";
+    readonly name: "OwnershipTransferred";
+    readonly inputs: readonly [{
+        readonly name: "user";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }, {
+        readonly name: "newOwner";
+        readonly type: "address";
+        readonly indexed: true;
+        readonly internalType: "address";
+    }];
+    readonly anonymous: false;
+}, {
+    readonly type: "error";
+    readonly name: "IncorrectNativeDepositAmount";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "NativeWrapperAccountantDecimalsMismatch";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "ZeroAddress";
+    readonly inputs: readonly [];
+}];
+
 declare const TellerAbi: readonly [{
     readonly inputs: readonly [{
         readonly internalType: "address";
@@ -1796,6 +2018,13 @@ interface DepositTxData {
     args: [Address, bigint, bigint];
     chainId: number;
 }
+interface CommunityCodeDepositTxData {
+    abi: typeof CommunityCodeDepositorAbi;
+    address: Address;
+    functionName: "deposit";
+    args: [Address, bigint, bigint, Address, ByteArray];
+    chainId: number;
+}
 /**
  * Parameters for prepareDepositTransactionData()
  * Accepts yieldType, recipientAddress, depositToken, and chainId for automatic vault resolution
@@ -1814,6 +2043,7 @@ interface PrepareDepositTxDataParams {
     depositAmount: string;
     chainId: ChainId;
     slippage?: number;
+    partnerCode?: string;
 }
 /**
  * Prepares the transaction data needed to deposit assets into a vault
@@ -1837,7 +2067,7 @@ interface PrepareDepositTxDataParams {
  * @returns {Promise<DepositTransactionData>} Promise resolving to the prepared transaction data
  * @throws {APIError} If vault cannot be resolved, asset not found, or contracts not configured
  */
-declare function prepareDepositTxData(params: PrepareDepositTxDataParams): Promise<DepositTxData>;
+declare function prepareDepositTxData(params: PrepareDepositTxDataParams): Promise<DepositTxData | CommunityCodeDepositTxData>;
 
 /**
  * @file Deposit with permit functionality for Nucleus vaults
@@ -1969,7 +2199,7 @@ interface UnencodedDepositWithPermitData {
  *   yieldType: 'PRIME',
  *   depositToken: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
  *   depositAmount: '1000.0',
- *   recipientAddress: userAddress,
+ *   recipientAddress: recipientAddress,
  *   chainId: 1,
  *   deadline: BigInt(Math.floor(Date.now() / 1000) + 3600),
  * });
@@ -2056,7 +2286,7 @@ interface PrepareDepositWithPermitTxDataParams {
  * });
  * ```
  */
-declare function prepareDepositWithPermitTransactionData(params: PrepareDepositWithPermitTxDataParams): Promise<UnencodedDepositWithPermitData>;
+declare function prepareDepositWithPermitTxData(params: PrepareDepositWithPermitTxDataParams): Promise<UnencodedDepositWithPermitData>;
 
 declare const BoringVaultAbi: readonly [{
     readonly type: "constructor";
@@ -2753,7 +2983,7 @@ interface PrepareBulkWithdrawTxDataParams {
     wantAssetAddress: Address;
     chainId: ChainId;
     slippage?: number;
-    userAddress: Address;
+    recipientAddress: Address;
 }
 /**
  * Prepares the transaction data needed to withdraw assets from a vault
@@ -2770,7 +3000,7 @@ interface PrepareBulkWithdrawTxDataParams {
  *   vault: vaults[0],
  *   wantAsset: wantAssets[0],
  *   chainId: 1,
- *   userAddress: '0x1234...',
+ *   recipientAddress: '0x1234...',
  *   offerAmount: "1.0", // 1 vault share
  *   deadline: Math.floor(Date.now() / 1000) + 3600, // 1 hour from now
  *   slippage: 100, // 1% slippage (100 bps)
@@ -2781,7 +3011,7 @@ interface PrepareBulkWithdrawTxDataParams {
  * @param {AmplifyVault} params.vault - Vault configuration from fetchVaults()
  * @param {SupportedAsset} params.wantAsset - Asset metadata from fetchSupportedAssets()
  * @param {ChainId} params.chainId - ID of the chain where the withdrawal will occur
- * @param {Address} params.userAddress - Ethereum address of the user making the withdrawal
+ * @param {Address} params.recipientAddress - Ethereum address of the user making the withdrawal
  * @param {string} params.offerAmount - Amount of vault shares to withdraw as a decimal string
  * @param {number} [params.deadline] - Unix timestamp when the request expires
  * @param {number} [params.slippage] - Maximum acceptable slippage in basis points
@@ -3146,7 +3376,7 @@ type UserRequest = {
  * @property {Address} wantAssetAddress - Address of the want token
  * @property {ChainId} chainId - ID of the chain where the withdrawal will occur
  * @property {string} offerAmount - Amount of vault shares to withdraw as a decimal string
- * @property {Address} userAddress - Ethereum address of the user making the withdrawal
+ * @property {Address} recipientAddress - Ethereum address of the user making the withdrawal
  * @property {number} [deadline] - Unix timestamp when the request expires (optional)
  * @property {number} [slippage] - Maximum acceptable slippage in basis points (optional, default: 100 for 1%)
  *
@@ -3178,7 +3408,7 @@ interface PrepareWithdrawTxDataParams {
     wantAssetAddress: Address;
     chainId: ChainId;
     offerAmount: string;
-    userAddress: Address;
+    recipientAddress: Address;
     deadline?: number;
     slippage?: number;
 }
@@ -3212,7 +3442,7 @@ interface WithdrawTxData {
  *   yieldType: 'PRIME',
  *   wantAssetAddress: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48', // USDC
  *   chainId: 1,
- *   userAddress: '0x1234...',
+ *   recipientAddress: '0x1234...',
  *   offerAmount: "1.0", // 1 vault share
  *   deadline: Math.floor(Date.now() / 1000) + 3600, // 1 hour from now
  *   slippage: 100, // 1% slippage (100 bps)
@@ -3223,7 +3453,7 @@ interface WithdrawTxData {
  * @param {YieldType} params.yieldType - Yield strategy type (PRIME, TBILL, or LENDING)
  * @param {Address} params.wantAssetAddress - Address of the want token
  * @param {ChainId} params.chainId - ID of the chain where the withdrawal will occur
- * @param {Address} params.userAddress - Ethereum address of the user making the withdrawal
+ * @param {Address} params.recipientAddress - Ethereum address of the user making the withdrawal
  * @param {string} params.offerAmount - Amount of vault shares to withdraw as a decimal string
  * @param {number} [params.deadline] - Unix timestamp when the request expires
  * @param {number} [params.slippage] - Maximum acceptable slippage in basis points
@@ -3233,4 +3463,4 @@ interface WithdrawTxData {
  */
 declare const prepareWithdrawTxData: ({ yieldType, wantAssetAddress, chainId, offerAmount, deadline, slippage, }: PrepareWithdrawTxDataParams) => Promise<WithdrawTxData>;
 
-export { AmplifyVault, type ApproveDepositTokenTxData, type ApproveWithdrawTokenTxData, AssetFilterOptions, type BulkWithdrawTxData, type DepositTxData, type EIP712Domain, type InitErrorCode, PERMIT_TYPES, type ParsedPermitSignature, type PermitSignatureData, type PrepareDepositPermitSignatureParams, type PrepareDepositWithPermitTxDataParams, type RequestHeaders, type SDKConfig, SupportedAsset, type UnencodedDepositWithPermitData, VaultFilterOptions, WithdrawSupportedAsset, type WithdrawTxData, YieldType, fetchSupportedAssets, fetchVaults, findVaultByConfig, getAssetsFromCache, getCache, getWithdrawSupportedAssets, initAmplifySDK, initializeCache, parsePermitSignature, prepareApproveDepositTokenTxData, prepareApproveWithdrawTxData, prepareBulkWithdrawTxData, prepareDepositPermitSignature, prepareDepositTxData, prepareDepositWithPermitTransactionData, prepareWithdrawTxData, refreshVaultCache };
+export { AmplifyVault, type ApproveDepositTokenTxData, type ApproveWithdrawTokenTxData, AssetFilterOptions, type BulkWithdrawTxData, type CommunityCodeDepositTxData, type DepositTxData, type EIP712Domain, type InitErrorCode, PERMIT_TYPES, type ParsedPermitSignature, type PermitSignatureData, type PrepareDepositPermitSignatureParams, type PrepareDepositWithPermitTxDataParams, type RequestHeaders, type SDKConfig, SupportedAsset, type UnencodedDepositWithPermitData, VaultFilterOptions, WithdrawSupportedAsset, type WithdrawTxData, YieldType, fetchSupportedAssets, fetchVaults, findVaultByConfig, getAssetsFromCache, getCache, getWithdrawSupportedAssets, initAmplifySDK, initializeCache, parsePermitSignature, prepareApproveDepositTokenTxData, prepareApproveWithdrawTxData, prepareBulkWithdrawTxData, prepareDepositPermitSignature, prepareDepositTxData, prepareDepositWithPermitTxData, prepareWithdrawTxData, refreshVaultCache };