@circle-fin/usdckit 0.11.1

package/dist/esm/actions/transfer.js

@@ -0,0 +1,213 @@
+// Copyright (c) 2025, Circle Internet Group, Inc.
+// All rights reserved.
+//
+// Circle Internet Group, Inc. CONFIDENTIAL
+//
+// This file includes unpublished proprietary source code of Circle Internet
+// Group, Inc. The copyright notice above does not
+// evidence any actual or intended publication of such source code. Disclosure
+// of this source code or any related proprietary information is strictly
+// prohibited without the express written permission of Circle Internet Group, Inc.
+import { parseGwei, formatGwei } from 'viem';
+import { waitForTransactionReceipt as _waitForTransactionReceipt } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import { createTransaction as _createTransaction } from '../providers/developer-controlled-wallets/actions/createTransaction.js';
+import { estimateTransferFee as _estimateTransferFee } from '../providers/developer-controlled-wallets/actions/estimateTransferFee.js';
+import { getTokenBalances as _getTokenBalances } from '../providers/developer-controlled-wallets/actions/getTokenBalances.js';
+import { waitForTransactionHash as _waitForTransactionHash } from '../providers/developer-controlled-wallets/actions/waitForTransactionHash.js';
+import { extractChain } from '../providers/developer-controlled-wallets/extractChain.js';
+import { getContract as _getContract } from '../providers/smart-contracts-platform/actions/getContract.js';
+import { parseAccount, parseUnits, formatUnits } from '../utils/index.js';
+import { max } from '../utils/max.js';
+import { parseAddress } from '../utils/parseAddress.js';
+import { wrapAsync } from '../utils/wrapAsync.js';
+/**
+ * Estimates the fee levels for a transfer.
+ * @param level - The fee level
+ * @returns A function that estimates the fees for a transfer request.
+ */
+export function FEE_LEVEL(level) {
+    return async ({ client, request: { from, to, token, amount, chain }, }) => {
+        const estimateTransferFee = getAction(client, _estimateTransferFee, 'estimateTransferFee');
+        // @ts-expect-error: Ignore ts(2331) for `read` property
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+        const decimals = (token != null ? await token.read.decimals() : chain.nativeCurrency.decimals);
+        const estimate = (await estimateTransferFee({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: extractChain(chain).blockchainId,
+            tokenAddress: token?.address,
+            amounts: [formatUnits(amount, decimals)],
+        }));
+        // NOTE: Assume fee estimations levels are lowercased
+        const { gasLimit, maxFee, priorityFee } = estimate[level.toLowerCase()];
+        return {
+            gas: parseUnits(gasLimit),
+            maxFeePerGas: parseGwei(maxFee),
+            maxPriorityFeePerGas: parseGwei(priorityFee),
+        };
+    };
+}
+/**
+ * Estimates the fee levels for a transfer and transfers the required amount to the `from` account.
+ * @param params - The parameters including account and fee level.
+ * @returns A function that prepares and estimates the fees.
+ */
+export function FEE_LEVEL_WITH_PREPARE({ account, level }) {
+    return async ({ client, request }) => {
+        const { from, chain } = request;
+        const waitForTransactionReceipt = getAction(client, _waitForTransactionReceipt, 'waitForTransactionReceipt');
+        const getTokenBalances = getAction(client, _getTokenBalances, 'getTokenBalances');
+        const _transfer = getAction(client, transfer, 'transfer');
+        const [fees, balances] = await Promise.all([
+            FEE_LEVEL(level)({ client, request }),
+            getTokenBalances({ account: from, token: null }),
+        ]);
+        const [nativeBalance] = balances;
+        const amountToTransfer = max(0n, fees.maxPriorityFeePerGas + fees.maxFeePerGas - (nativeBalance?.value ?? 0n));
+        if (amountToTransfer > 0) {
+            const [transaction] = await _transfer({
+                from: account,
+                to: from,
+                amount: amountToTransfer,
+                chain,
+                fees: FEE_LEVEL(level),
+            });
+            await waitForTransactionReceipt(transaction);
+        }
+        return fees;
+    };
+}
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `LOW` fee level settings for transfer fee estimation.
+ */
+export const LOW = FEE_LEVEL('LOW');
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `MEDIUM` fee level settings for transfer fee estimation.
+ */
+export const MEDIUM = FEE_LEVEL('MEDIUM');
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `HIGH` fee level settings for transfer fee estimation.
+ */
+export const HIGH = FEE_LEVEL('HIGH');
+/**
+ * Estimates the gas required for a transfer.
+ * @param params - The parameters for estimating fees per gas.
+ * @returns The estimated gas in base units.
+ */
+const ESTIMATE_GAS = async ({ client, request }) => {
+    // NOTE: `gas` is the same for all predefined fee levels
+    const { gas } = await HIGH({ client, request });
+    return gas;
+};
+/**
+ * Transfers tokens or native currency from one account to another.
+ * @param client - The client instance.
+ * @param params - The transfer parameters.
+ * @returns An array of transfer return types containing transaction hashes.
+ *
+ * @example
+ * Transferring native tokens
+ * ```typescript
+ * await client.transfer({
+ *   from: '0x0000000000000000000000000000000000000000',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   amount: 1n,
+ * })
+ * ```
+ *
+ * @example
+ * Transferring `USDC` tokens on default chain
+ * ```typescript
+ * await client.transfer({
+ *   from: '0x0000000000000000000000000000000000000000',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   amount: 1n,
+ *   token: client.chain.contracts.USDC,
+ * })
+ * ```
+ *
+ * @example
+ * Specifying gas fees. Default is to use `HIGH` fee level
+ * ```typescript
+ * await client.transfer({
+ *   from: '0x0000000000000000000000000000000000000000',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   amount: 1n,
+ *   gas: 100n,
+ *   fees: { maxFeePerGas: 200n, maxPriorityFeePerGas: 300n },
+ * })
+ * ```
+ *
+ * @example
+ * Usage with {@link FEE_LEVEL}
+ * ```typescript
+ * await client.transfer({
+ *   from: '0x0000000000000000000000000000000000000000',
+ *   to: '0x0000000000000000000000000000000000000000',
+ *   amount: 1n,
+ *   fees: FEE_LEVEL('LOW'),
+ * })
+ * ```
+ */
+export async function transfer(client, params) {
+    const { chain = client.chain, from = client.account, to } = params;
+    const { amount, gas: _gas, fees: _fees = HIGH } = params;
+    const token = params.token != null ? parseAddress(params.token) : undefined;
+    const gas = _gas !== undefined ? parseUnits(_gas, chain.nativeCurrency.decimals) : undefined;
+    const getContract = getAction(client, _getContract, 'getContract');
+    const createTransaction = getAction(client, _createTransaction, 'createTransaction');
+    const waitForTransactionHash = getAction(client, _waitForTransactionHash, 'waitForTransactionHash');
+    const blockchain = extractChain(chain).blockchainId;
+    const toAccount = parseAccount(to);
+    const fromAccounts = (Array.isArray(from) ? from : [from]).map((fromAccount) => parseAccount(fromAccount));
+    const nativeCurrencyDecimals = chain.nativeCurrency.decimals;
+    let tokenContract;
+    let tokenCurrencyDecimals = nativeCurrencyDecimals;
+    if (token != null) {
+        tokenContract = (await getContract(token));
+        // @ts-expect-error: Ignore ts(2331) for `read` property
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+        tokenCurrencyDecimals = (await tokenContract.read.decimals());
+    }
+    async function transferOne({ from, to, amountFn, gasFn, feesFn, }) {
+        const amount = parseUnits(await amountFn(from), tokenCurrencyDecimals);
+        const request = {
+            from,
+            to,
+            token: tokenContract,
+            amount,
+            chain,
+        };
+        const gas = await gasFn({ client, request });
+        const { maxFeePerGas, maxPriorityFeePerGas } = await feesFn({ client, request });
+        const { id } = (await createTransaction({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain,
+            tokenAddress: tokenContract?.address,
+            amounts: [formatUnits(amount, tokenCurrencyDecimals)],
+            fee: {
+                type: 'absolute',
+                config: {
+                    gasLimit: formatUnits(gas),
+                    maxFee: formatGwei(maxFeePerGas),
+                    priorityFee: formatGwei(maxPriorityFeePerGas),
+                },
+            },
+        }));
+        const { txHash } = (await waitForTransactionHash({ id }));
+        return { hash: txHash };
+    }
+    return await Promise.all(fromAccounts.map((fromAccount) => transferOne({
+        from: fromAccount,
+        to: toAccount,
+        amountFn: typeof amount !== 'function' ? wrapAsync(amount) : amount,
+        gasFn: gas !== undefined ? wrapAsync(gas) : ESTIMATE_GAS,
+        feesFn: typeof _fees !== 'function' ? wrapAsync(_fees) : _fees,
+    })));
+}
+//# sourceMappingURL=transfer.js.map

package/dist/esm/actions/transfer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.js","sourceRoot":"","sources":["../../../src/actions/transfer.ts"],"names":[],"mappings":"AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;AAEnF,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,MAAM,CAAA;AAC5C,OAAO,EAAE,yBAAyB,IAAI,0BAA0B,EAAE,MAAM,cAAc,CAAA;AACtF,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,EAAE,iBAAiB,IAAI,kBAAkB,EAAE,MAAM,wEAAwE,CAAA;AAChI,OAAO,EAAE,mBAAmB,IAAI,oBAAoB,EAAE,MAAM,0EAA0E,CAAA;AACtI,OAAO,EAAE,gBAAgB,IAAI,iBAAiB,EAAE,MAAM,uEAAuE,CAAA;AAC7H,OAAO,EAAE,sBAAsB,IAAI,uBAAuB,EAAE,MAAM,6EAA6E,CAAA;AAC/I,OAAO,EAAE,YAAY,EAAE,MAAM,2DAA2D,CAAA;AACxF,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAW1G,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AACzE,OAAO,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAA;AACrC,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AA6DjD;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,KAAgC;IACxD,OAAO,KAAK,EAAE,EACZ,MAAM,EACN,OAAO,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,GAClB,EAAwD,EAAE;QACnF,MAAM,mBAAmB,GAAG,SAAS,CAAC,MAAM,EAAE,oBAAoB,EAAE,qBAAqB,CAAC,CAAA;QAC1F,wDAAwD;QACxD,yGAAyG;QACzG,MAAM,QAAQ,GAAG,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAW,CAAA;QAExG,MAAM,QAAQ,GAAG,CAAC,MAAM,mBAAmB,CAAC;YAC1C,aAAa,EAAE,IAAI,CAAC,OAAO;YAC3B,kBAAkB,EAAE,EAAE,CAAC,OAAO;YAC9B,UAAU,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,YAAY;YAC5C,YAAY,EAAE,KAAK,EAAE,OAAO;YAC5B,OAAO,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;SACzC,CAAC,CAAgG,CAAA;QAElG,qDAAqD;QACrD,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;QAEvE,OAAO;YACL,GAAG,EAAE,UAAU,CAAC,QAAQ,CAAC;YACzB,YAAY,EAAE,SAAS,CAAC,MAAM,CAAC;YAC/B,oBAAoB,EAAE,SAAS,CAAC,WAAW,CAAC;SAC7C,CAAA;IACH,CAAC,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,EAAE,OAAO,EAAE,KAAK,EAA0D;IAC/G,OAAO,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAA4B,EAAE,EAAE;QAC7D,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,OAAO,CAAA;QAC/B,MAAM,yBAAyB,GAAG,SAAS,CAAC,MAAM,EAAE,0BAA0B,EAAE,2BAA2B,CAAC,CAAA;QAC5G,MAAM,gBAAgB,GAAG,SAAS,CAAC,MAAM,EAAE,iBAAiB,EAAE,kBAAkB,CAAC,CAAA;QACjF,MAAM,SAAS,GAAG,SAAS,CAAC,MAAM,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;QAEzD,MAAM,CAAC,IAAI,EAAE,QAAQ,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACzC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;YACrC,gBAAgB,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;SACjD,CAAC,CAAA;QACF,MAAM,CAAC,aAAa,CAAC,GAAG,QAAkC,CAAA;QAE1D,MAAM,gBAAgB,GAAG,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,YAAY,GAAG,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,CAAA;QAE9G,IAAI,gBAAgB,GAAG,CAAC,EAAE,CAAC;YACzB,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,SAAS,CAAC;gBACpC,IAAI,EAAE,OAAO;gBACb,EAAE,EAAE,IAAI;gBACR,MAAM,EAAE,gBAAgB;gBACxB,KAAK;gBACL,IAAI,EAAE,SAAS,CAAC,KAAK,CAAC;aACvB,CAAC,CAAA;YAEF,MAAM,yBAAyB,CAAC,WAAW,CAAC,CAAA;QAC9C,CAAC;QAED,OAAO,IAAI,CAAA;IACb,CAAC,CAAA;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAA;AAEnC;;;GAGG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAA;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;AAErC;;;;GAIG;AACH,MAAM,YAAY,GAAG,KAAK,EAAE,EAAE,MAAM,EAAE,OAAO,EAA4B,EAAsB,EAAE;IAC/F,wDAAwD;IACxD,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;IAC/C,OAAO,GAAG,CAAA;AACZ,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,MAA0B,EAAE,MAAsB;IAC/E,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,MAAM,CAAC,OAAO,EAAE,EAAE,EAAE,GAAG,MAAM,CAAA;IAClE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;IACxD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC3E,MAAM,GAAG,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE5F,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC,CAAA;IAClE,MAAM,iBAAiB,GAAG,SAAS,CAAC,MAAM,EAAE,kBAAkB,EAAE,mBAAmB,CAAC,CAAA;IACpF,MAAM,sBAAsB,GAAG,SAAS,CAAC,MAAM,EAAE,uBAAuB,EAAE,wBAAwB,CAAC,CAAA;IAEnG,MAAM,UAAU,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,YAAY,CAAA;IACnD,MAAM,SAAS,GAAG,YAAY,CAAC,EAAE,CAAC,CAAA;IAClC,MAAM,YAAY,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAA;IAE1G,MAAM,sBAAsB,GAAG,KAAK,CAAC,cAAc,CAAC,QAAQ,CAAA;IAC5D,IAAI,aAAmC,CAAA;IACvC,IAAI,qBAAqB,GAAG,sBAAsB,CAAA;IAElD,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,aAAa,GAAG,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,CAAa,CAAA;QACtD,wDAAwD;QACxD,yGAAyG;QACzG,qBAAqB,GAAG,CAAC,MAAM,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAW,CAAA;IACzE,CAAC;IAED,KAAK,UAAU,WAAW,CAAC,EACzB,IAAI,EACJ,EAAE,EACF,QAAQ,EACR,KAAK,EACL,MAAM,GAOP;QACC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,EAAE,qBAAqB,CAAC,CAAA;QAEtE,MAAM,OAAO,GAAG;YACd,IAAI;YACJ,EAAE;YACF,KAAK,EAAE,aAAa;YACpB,MAAM;YACN,KAAK;SACN,CAAA;QACD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAC5C,MAAM,EAAE,YAAY,EAAE,oBAAoB,EAAE,GAAG,MAAM,MAAM,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAA;QAEhF,MAAM,EAAE,EAAE,EAAE,GAAG,CAAC,MAAM,iBAAiB,CAAC;YACtC,aAAa,EAAE,IAAI,CAAC,OAAO;YAC3B,kBAAkB,EAAE,EAAE,CAAC,OAAO;YAC9B,UAAU;YACV,YAAY,EAAE,aAAa,EAAE,OAAO;YACpC,OAAO,EAAE,CAAC,WAAW,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;YACrD,GAAG,EAAE;gBACH,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE;oBACN,QAAQ,EAAE,WAAW,CAAC,GAAG,CAAC;oBAC1B,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC;oBAChC,WAAW,EAAE,UAAU,CAAC,oBAAoB,CAAC;iBAC9C;aACF;SACF,CAAC,CAAmB,CAAA;QAErB,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,MAAM,sBAAsB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAwB,CAAA;QAChF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,CAAA;IACzB,CAAC;IAED,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,YAAY,CAAC,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAC/B,WAAW,CAAC;QACV,IAAI,EAAE,WAAW;QACjB,EAAE,EAAE,SAAS;QACb,QAAQ,EAAE,OAAO,MAAM,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;QACnE,KAAK,EAAE,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,YAAY;QACxD,MAAM,EAAE,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;KAC/D,CAAC,CACH,CACF,CAAA;AACH,CAAC"}

package/dist/esm/actions/transfer.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=transfer.test.d.ts.map

package/dist/esm/actions/transfer.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.test.d.ts","sourceRoot":"","sources":["../../../src/actions/transfer.test.ts"],"names":[],"mappings":""}

package/dist/esm/actions/transfer.test.js

@@ -0,0 +1,424 @@
+// Copyright (c) 2025, Circle Internet Group, Inc.
+// All rights reserved.
+//
+// Circle Internet Group, Inc. CONFIDENTIAL
+//
+// This file includes unpublished proprietary source code of Circle Internet
+// Group, Inc. The copyright notice above does not
+// evidence any actual or intended publication of such source code. Disclosure
+// of this source code or any related proprietary information is strictly
+// prohibited without the express written permission of Circle Internet Group, Inc.
+import { describe, expect, vi, afterEach, it, test } from 'vitest';
+import { ETH_SEPOLIA } from '../chains/index.js';
+import { FEE_LEVEL_WITH_PREPARE, HIGH, MEDIUM, LOW, transfer } from './transfer.js';
+describe('transfer()', () => {
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    const USDC = {
+        address: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
+        read: {
+            decimals: vi.fn(() => 6),
+        },
+    };
+    const client = {
+        chain: ETH_SEPOLIA,
+        getContract: vi.fn(({ address }) => ({
+            address,
+            read: {
+                decimals: vi.fn(() => 6),
+            },
+        })),
+        estimateTransferFee: vi.fn(() => ({
+            high: { gasLimit: '3', maxFee: '6', priorityFee: '9', baseFee: '12', networkFee: '15' },
+            medium: { gasLimit: '2', maxFee: '4', priorityFee: '6', baseFee: '8', networkFee: '10' },
+            low: { gasLimit: '1', maxFee: '2', priorityFee: '3', baseFee: '4', networkFee: '5' },
+        })),
+        createTransaction: vi.fn(() => ({
+            id: 'transaction-id',
+            state: 'COMPLETE',
+            txHash: 'tx-hash',
+        })),
+        waitForTransactionHash: vi.fn(({ id }) => ({
+            id,
+            state: 'COMPLETE',
+            txHash: 'tx-hash',
+        })),
+        waitForTransactionReceipt: vi.fn(() => { }),
+        getTokenBalances: vi.fn(() => []),
+        transfer: vi.fn(() => [{ hash: 'tx-hash' }]),
+    };
+    it('should transfer native tokens', async () => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: '0.00000001',
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.00000001'],
+            tokenAddress: undefined,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.00000001'],
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    it('should support bigint for amount', async () => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: 1000000n,
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            tokenAddress: undefined,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    test.each([
+        // eslint-disable-next-line @typescript-eslint/require-await
+        [async () => 1000000n, '0.000000000001'],
+        // eslint-disable-next-line @typescript-eslint/require-await
+        [async () => '0.000000000001', '0.000000000001'],
+    ])('should support callable for amount', async (amount, amountFormated) => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount,
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: [amountFormated],
+            tokenAddress: undefined,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: [amountFormated],
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    it('should support the gas argument as unformatted', async () => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: 1000000n,
+            gas: 111n,
+            fees: {
+                maxFeePerGas: 222n,
+                maxPriorityFeePerGas: 333n,
+            },
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).not.toHaveBeenCalled();
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            fee: {
+                type: 'absolute',
+                config: {
+                    gasLimit: '111',
+                    maxFee: '0.000000222',
+                    priorityFee: '0.000000333',
+                },
+            },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    test.each([
+        [
+            { maxFeePerGas: 222n, maxPriorityFeePerGas: 333n },
+            { maxFee: '0.000000222', priorityFee: '0.000000333' },
+        ],
+        [
+            // eslint-disable-next-line @typescript-eslint/require-await
+            async () => ({ maxFeePerGas: 222n, maxPriorityFeePerGas: 333n }),
+            { maxFee: '0.000000222', priorityFee: '0.000000333' },
+        ],
+    ])('should support the fees argument', async (fees, { maxFee, priorityFee }) => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: 1000000n,
+            gas: 111n,
+            fees,
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).not.toHaveBeenCalled();
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            fee: {
+                type: 'absolute',
+                config: {
+                    gasLimit: '111',
+                    maxFee,
+                    priorityFee,
+                },
+            },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    test.each([
+        [
+            {
+                from: { address: '0x123' },
+                to: { address: '0x321' },
+                amount: 1000000n,
+                gas: 111n,
+            },
+            {
+                gasLimit: '111',
+                maxFee: '6',
+                priorityFee: '9',
+            },
+        ],
+        [
+            {
+                from: { address: '0x123' },
+                to: { address: '0x321' },
+                amount: 1000000n,
+                fees: {
+                    maxFeePerGas: 222n,
+                    maxPriorityFeePerGas: 333n,
+                },
+            },
+            {
+                gasLimit: '3',
+                maxFee: '0.000000222',
+                priorityFee: '0.000000333',
+            },
+        ],
+    ])('should support the gas argument with partial gas fields', async (params, gasEstimation) => {
+        await transfer(client, params);
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: params.from.address,
+            destinationAddress: params.to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            fee: {
+                type: 'absolute',
+                config: gasEstimation,
+            },
+            tokenAddress: undefined,
+        });
+    });
+    it('should support the token argument', async () => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: 12250000n,
+            token: { address: '0xabc' },
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.getContract).toHaveBeenCalledWith({ address: params.token.address });
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['12.25'],
+            tokenAddress: params.token.address,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['12.25'],
+            tokenAddress: params.token.address,
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    it('should support the token argument as string', async () => {
+        const params = {
+            from: { address: '0x123' },
+            to: { address: '0x321' },
+            amount: 12250000n,
+            token: '0xabc',
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.getContract).toHaveBeenCalledWith({ address: params.token });
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['12.25'],
+            tokenAddress: params.token,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from.address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['12.25'],
+            tokenAddress: params.token,
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    it('should support batch transfer with multiple from addresses and dynamic amount', async () => {
+        const params = {
+            from: [{ address: '0x123' }, { address: '0x456' }],
+            to: { address: '0x321' },
+            // eslint-disable-next-line @typescript-eslint/require-await
+            amount: async ({ address }) => (address === '0x123' ? 1000000n : 2000000n),
+        };
+        const expectedResult = [{ hash: 'tx-hash' }, { hash: 'tx-hash' }];
+        const { from, to } = params;
+        const result = await transfer(client, params);
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from.at(0).address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            tokenAddress: undefined,
+        });
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: from[1].address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000002'],
+            tokenAddress: undefined,
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from[0].address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000001'],
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: from[1].address,
+            destinationAddress: to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['0.000000000002'],
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+        expect(result).toEqual(expectedResult);
+    });
+    test.each([
+        [
+            HIGH,
+            { token: USDC, amount: 1000000n },
+            { gas: 3n, maxFeePerGas: 6000000000n, maxPriorityFeePerGas: 9000000000n },
+            { amounts: ['1'] },
+        ],
+        [
+            HIGH,
+            { token: undefined, amount: 1000000n },
+            { gas: 3n, maxFeePerGas: 6000000000n, maxPriorityFeePerGas: 9000000000n },
+            { amounts: ['0.000000000001'] },
+        ],
+        [
+            MEDIUM,
+            { token: USDC, amount: 1000000n },
+            { gas: 2n, maxFeePerGas: 4000000000n, maxPriorityFeePerGas: 6000000000n },
+            { amounts: ['1'] },
+        ],
+        [
+            MEDIUM,
+            { token: undefined, amount: 1000000n },
+            { gas: 2n, maxFeePerGas: 4000000000n, maxPriorityFeePerGas: 6000000000n },
+            { amounts: ['0.000000000001'] },
+        ],
+        [
+            LOW,
+            { token: USDC, amount: 1000000n },
+            { gas: 1n, maxFeePerGas: 2000000000n, maxPriorityFeePerGas: 3000000000n },
+            { amounts: ['1'] },
+        ],
+        [
+            LOW,
+            { token: undefined, amount: 1000000n },
+            { gas: 1n, maxFeePerGas: 2000000000n, maxPriorityFeePerGas: 3000000000n },
+            { amounts: ['0.000000000001'] },
+        ],
+    ])('should return gas fee estimations', async (feeLevelFn, { token, amount }, expected, { amounts }) => {
+        const params = {
+            client,
+            request: {
+                from: { address: '0x123' },
+                to: { address: '0x321' },
+                amount,
+                token,
+                chain: ETH_SEPOLIA,
+            },
+        };
+        await expect(feeLevelFn(params)).resolves.toEqual(expected);
+        expect(client.estimateTransferFee).toHaveBeenCalledWith({
+            sourceAddress: params.request.from.address,
+            destinationAddress: params.request.to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts,
+            tokenAddress: token?.address,
+        });
+    });
+    it('should return gas fee estimations for FEE_LEVEL_WITH_PREPARATION', async () => {
+        const sourceAccount = { address: '0xsourceaccount' };
+        const params = {
+            client,
+            request: {
+                from: { address: '0x123' },
+                to: { address: '0x321' },
+                amount: 10000n,
+                token: USDC,
+                chain: ETH_SEPOLIA,
+            },
+        };
+        await expect(FEE_LEVEL_WITH_PREPARE({ level: 'LOW', account: sourceAccount })(params)).resolves.toEqual({
+            gas: 1n,
+            maxFeePerGas: 2000000000n,
+            maxPriorityFeePerGas: 3000000000n,
+        });
+        expect(client.transfer).toHaveBeenCalledWith({
+            amount: 2000000000n + 3000000000n,
+            chain: params.request.chain,
+            from: sourceAccount,
+            to: params.request.from,
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            fees: expect.any(Function),
+        });
+    });
+});
+//# sourceMappingURL=transfer.test.js.map