@circle-fin/usdckit 0.21.1 → 0.23.0

package/dist/esm/actions/swapExactIn.d.ts

@@ -1,6 +1,6 @@
 import type { Chain } from '../providers/uniswap/index.js';
-import type { Account, Address, BaseUnits, ControlFlowOptions, ExtendedViemClient, FeeValuesEIP1559, NativeUnits } from '../types.js';
-import type { Abi } from 'viem';
+import type { Account, Address, BaseUnits, ControlFlowOptions, FeeValuesEIP1559, NativeUnits } from '../types.js';
+import type { Abi, Client } from 'viem';
 /**
  * Parameters for the {@link swapExactIn} function.
  */
@@ -36,4 +36,4 @@ export type SwapExactInParamsReturnType = Address;
  * @param params - Parameters for the operation
  * @returns The address of the transaction that was executed.
  */
-export declare function swapExactIn(client: ExtendedViemClient, params: SwapExactInParams & ControlFlowOptions): Promise<SwapExactInParamsReturnType>;
+export declare function swapExactIn(client: Client, params: SwapExactInParams & ControlFlowOptions): Promise<SwapExactInParamsReturnType>;

package/dist/esm/actions/sweep.d.ts

@@ -1,5 +1,6 @@
 import type { TransferReturnType, TransferParams } from './transfer.js';
-import type { ControlFlowOptions, ExtendedViemClient } from '../types.js';
+import type { ControlFlowOptions } from '../types.js';
+import type { Client } from 'viem';
 /**
  * Parameters for sweeping tokens from accounts
  */
@@ -13,4 +14,4 @@ export type SweepReturnType = TransferReturnType;
  * @param params - Parameters for the sweep operation
  * @returns An array of transfer results.
  */
-export declare function sweep(client: ExtendedViemClient, params: SweepParams & ControlFlowOptions): Promise<SweepReturnType>;
+export declare function sweep(client: Client, params: SweepParams & ControlFlowOptions): Promise<SweepReturnType>;

package/dist/esm/actions/sweep.js

@@ -9,7 +9,7 @@
 // of this source code or any related proprietary information is strictly
 // prohibited without the express written permission of Circle Internet Group, Inc.
 import { getAction } from 'viem/utils';
-import { getTokenBalances as _getTokenBalances } from '../providers/circle-wallets/actions/getTokenBalances.js';
+import { getTokenBalance as _getTokenBalance } from './getTokenBalance.js';
 import { transfer } from './transfer.js';
 /**
  * Sweeps the specified token balance to the destination wallet.
@@ -20,8 +20,8 @@ import { transfer } from './transfer.js';
  * @returns An array of transfer results.
  */
 export async function sweep(client, params) {
-    const getTokenBalances = getAction(client, _getTokenBalances, 'getTokenBalances');
-    const { token = null } = params;
+    const getTokenBalance = getAction(client, _getTokenBalance, 'getTokenBalance');
+    const { token } = params;
     /**
      * Gets the current balance of tokens for an account to be transferred.
      *
@@ -29,8 +29,8 @@ export async function sweep(client, params) {
      * @returns The current balance in base units, or 0n if no balance is found
      */
     async function zeroAmount(account) {
-        const balances = (await getTokenBalances({ account, token }));
-        return balances.at(0)?.value ?? 0n;
+        const balance = await getTokenBalance({ account, token: token ?? undefined });
+        return balance.value;
     }
     return await transfer(client, { ...params, amount: zeroAmount });
 }

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

@@ -10,26 +10,21 @@
 // prohibited without the express written permission of Circle Internet Group, Inc.
 import { describe, expect, vi, beforeEach, it } from 'vitest';
 import { ETH_SEPOLIA } from '../chains/index.js';
+import { getTokenBalance } from './getTokenBalance.js';
 import { sweep } from './sweep.js';
 import { transfer } from './transfer.js';
 vi.mock('./transfer.js', () => ({
     transfer: vi.fn(),
 }));
+vi.mock('./getTokenBalance.js', () => ({
+    getTokenBalance: vi.fn(),
+}));
 describe('sweep()', () => {
     beforeEach(() => {
         vi.restoreAllMocks();
     });
     const client = {
         chain: ETH_SEPOLIA,
-        getTokenBalances: vi.fn(() => [
-            {
-                token: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
-                decimals: 6,
-                symbol: 'USDC',
-                value: 1237999924n,
-                formatted: '1237.999924',
-            },
-        ]),
     };
     it('should call transfer() with the full amount of account', async () => {
         const params = {
@@ -38,6 +33,14 @@ describe('sweep()', () => {
             token: ETH_SEPOLIA.contracts.USDC,
         };
         const expectedResult = [{ hash: '0xtx-hash' }];
+        // Mock getTokenBalance to return a specific balance
+        vi.mocked(getTokenBalance).mockResolvedValue({
+            token: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
+            decimals: 6,
+            symbol: 'USDC',
+            value: 1237999924n,
+            formatted: '1237.999924',
+        });
         vi.mocked(transfer).mockImplementation(async (_, { amount, from }) => {
             if (typeof amount === 'function') {
                 expect(await amount(from)).toBe(1237999924n);
@@ -51,6 +54,6 @@ describe('sweep()', () => {
             to: { address: '0x321', type: 'json-rpc' },
             token: ETH_SEPOLIA.contracts.USDC,
         }));
-        expect(client.getTokenBalances).toHaveBeenCalled();
+        expect(getTokenBalance).toHaveBeenCalled();
     });
 });

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

@@ -1,5 +1,5 @@
 import type { Chain } from '../providers/circle-wallets/index.js';
-import type { Account, Address, Contract, ControlFlowOptions, NativeUnits, BaseUnits, FeeValuesEIP1559, ExtendedViemClient } from '../types.js';
+import type { Account, Address, Contract, ControlFlowOptions, NativeUnits, BaseUnits, FeeValuesEIP1559 } from '../types.js';
 import type { Abi, Client } from 'viem';
 /**
  * Parameters for the {@link transfer} function.
@@ -121,4 +121,4 @@ export type EstimateFeesPerGasParams = {
  * })
  * ```
  */
-export declare function transfer(client: ExtendedViemClient, params: TransferParams & ControlFlowOptions): Promise<TransferReturnType>;
+export declare function transfer(client: Client, params: TransferParams & ControlFlowOptions): Promise<TransferReturnType>;

package/dist/esm/actions/transfer.js

@@ -8,41 +8,71 @@
 // 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 { formatGwei, erc20Abi } from 'viem';
+import { erc20Abi, encodeFunctionData } from 'viem';
+import { sendTransaction as _sendTransaction, writeContract as _writeContract, estimateGas as _estimateGas, } from 'viem/actions';
 import { getAction } from 'viem/utils';
 import { UnsupportedChainError } from '../errors/UnsupportedChainError.js';
-import { createTransaction as _createTransaction } from '../providers/circle-wallets/actions/createTransaction.js';
-import { waitForTransactionHash as _waitForTransactionHash } from '../providers/circle-wallets/actions/waitForTransactionHash.js';
-import { ESTIMATE_GAS, extractChain, HIGH } from '../providers/circle-wallets/index.js';
+import { extractChain } from '../providers/circle-wallets/index.js';
 import { bridge as _bridge } from '../providers/cross-chain-transfer-protocol/actions/bridge.js';
-import { formatUnits } from '../utils/formatUnits.js';
+import { getClient } from '../utils/getClient.js';
 import { getContract } from '../utils/getContract.js';
 import { parseAccount } from '../utils/parseAccount.js';
 import { parseAddress } from '../utils/parseAddress.js';
 import { parseUnits } from '../utils/parseUnits.js';
 import { raise } from '../utils/raise.js';
 import { wrapAsync } from '../utils/wrapAsync.js';
-async function transferOne(client, { from, to, amount, gas, fees, token, chain: _chain, signal, }) {
-    const createTransaction = getAction(client, _createTransaction, 'createTransaction');
-    const waitForTransactionHash = getAction(client, _waitForTransactionHash, 'waitForTransactionHash');
+/**
+ * Estimates gas for transfer operations.
+ * @param params - The parameters for estimating gas.
+ * @returns The estimated gas in base units.
+ */
+async function estimateTransferGas({ client, request }) {
+    const { from, to, token, amount, chain } = request;
+    const estimateGas = getAction(getClient(client, chain), _estimateGas, 'estimateGas');
+    if (!token) {
+        return await estimateGas({
+            account: from.address,
+            to: to.address,
+            value: amount,
+        });
+    }
+    const data = encodeFunctionData({
+        abi: token.abi,
+        functionName: 'transfer',
+        args: [to.address, amount],
+    });
+    return await estimateGas({
+        account: from.address,
+        to: token.address,
+        data,
+    });
+}
+async function transferOne(client, { from, to, amount, gas, fees, token, chain: _chain, }) {
     const chain = extractChain(_chain) ?? raise(new UnsupportedChainError());
-    const { id } = (await createTransaction({
-        sourceAddress: from.address,
-        destinationAddress: to.address,
-        blockchain: chain.blockchainId,
-        tokenAddress: token?.address,
-        amounts: [amount],
-        fee: {
-            type: 'absolute',
-            config: {
-                gasLimit: formatUnits(gas),
-                maxFee: formatGwei(fees.maxFeePerGas),
-                priorityFee: formatGwei(fees.maxPriorityFeePerGas),
-            },
-        },
-    }));
-    const { txHash } = (await waitForTransactionHash({ id, signal }));
-    return { hash: txHash };
+    if (token) {
+        const writeContract = getAction(getClient(client, chain), _writeContract, 'writeContract');
+        const hash = await writeContract({
+            address: token.address,
+            abi: erc20Abi,
+            functionName: 'transfer',
+            args: [to.address, amount],
+            account: from,
+            chain,
+            gas,
+            ...fees,
+        });
+        return { hash };
+    }
+    const sendTransaction = getAction(getClient(client, chain), _sendTransaction, 'sendTransaction');
+    const hash = await sendTransaction({
+        account: from,
+        to: to.address,
+        value: amount,
+        chain,
+        gas,
+        ...fees,
+    });
+    return { hash };
 }
 /**
  * Transfers tokens or native currency from one account to another.
@@ -111,7 +141,6 @@ async function transferOne(client, { from, to, amount, gas, fees, token, chain:
 export async function transfer(client, params) {
     const { chain: _chain = client.chain, from, to } = params;
     const { amount, gas: _gas, fees } = params;
-    const _fees = fees ?? HIGH;
     const bridge = getAction(client, _bridge, 'bridge');
     const toAccount = parseAccount(to, { chain: _chain });
     const toChain = extractChain(toAccount.chain);
@@ -153,19 +182,18 @@ export async function transfer(client, params) {
             amount: _amount,
             chain: fromChain,
         };
-        const gasFn = gas !== undefined ? wrapAsync(gas) : ESTIMATE_GAS;
+        const gasFn = gas !== undefined ? wrapAsync(gas) : estimateTransferGas;
         const _gas = await gasFn({ client, request });
-        const feesFn = typeof _fees !== 'function' ? wrapAsync(_fees) : _fees;
-        const { maxFeePerGas, maxPriorityFeePerGas } = await feesFn({ client, request });
+        const feesFn = typeof fees !== 'function' ? wrapAsync(fees) : fees;
+        const _fees = await feesFn({ client, request });
         return transferOne(client, {
             from: fromAccount,
             to: toAccount,
-            amount: formatUnits(_amount, tokenCurrencyDecimals),
+            amount: _amount,
             token,
             gas: _gas,
-            fees: { maxFeePerGas, maxPriorityFeePerGas },
+            fees: _fees,
             chain: fromChain,
-            signal: params.signal,
         });
     }));
 }