@circle-fin/usdckit 0.17.1 → 0.19.0

package/README.md

@@ -1,62 +1,89 @@
 # USDCKit
 
 ## Introduction
-USDCKit is a Node.js SDK that streamlines interactions with USDC. With USDCKit, you can integrate USDC into your applications and enable secure and efficient blockchain transactions. USDCKit aims to provide multi-chain fund orchestration features to enable USDC payment use cases like crypto acquiring (C2B), payroll (B2C), remittance (C2C), and B2B cross-border payments. We currently support features for transferring tokens, retrieving wallet balances, and sweeping tokens.
+
+USDCKit is a Node.js SDK that streamlines interactions with USDC. With USDCKit, you can integrate USDC into your applications and enable secure and efficient blockchain transactions. USDCKit aims to provide multi-chain fund orchestration features to enable USDC payment use cases like crypto acquiring (C2B), payroll (B2C), remittance (C2C), and B2B cross-border payments.
 
 The SDK is compatible with popular open-source clients like viem, web3.js, and ethers.js, and can also function as a standalone client. The SDK is built with TypeScript and supports high-level use cases involving USDC, making it an important tool for developers working with digital currencies.
 
 This guide will help you get started quickly and efficiently, whether you're building a wallet, a payment gateway, or anything in between. It covers the following items:
+
 - [Benefits of using USDCKit](#benefits-of-using-usdckit)
-- [Quickstart to write your first line of code using USDCKit](#quickstart)
+- [Quickstart to write your first line of code using USDCKit](#quickstart-steps)
 - [Sample Code to run USDC Acquiring Flow](./documents/Solutions.USDC_Acquiring_Flow.html)
 
 ### Benefits of Using USDCKit
+
 - **Faster time-to-market**. USDCKit simplifies accepting and managing USDC payments with minimal code. It provides reusable payment modules and removes technical complexities for faster integration.
 - **Payment Focused**. USDCKit is built to offer all the features and tools required to create a complete end-to-end USDC payment flow, with functionalities tailored for payment use cases. It also includes sample code for specific payment products, making it easier to develop your own. The focus of the current release is USDC Acquiring use case.
 - **Scalable payments without bottlenecks**. Process millions of transactions efficiently with USDCKit’s high-performance infrastructure.‍
 - **Enterprise-grade compliance management**. Adhere to global regulatory standards with real-time transaction screening through Compliance Engine.‍
 
 #### Key features
-USDCKit supports the following features:
-* Wallet management: Create and manage wallets across multiple chains.
-* Balance querying and filtering: Query wallet balances and filter wallets by balance threshold.
-* Fund transfer: Transfer funds between wallets on the same chain.
-* Cross-chain transfer: Transfer funds between wallets on different chains.
-* Fund sweeping: Automate fund aggregation and optimize gas efficiency.
+
+Besides basic wallet management, transfers, and balance queries, USDCKit supports the following features:
+
+- **Fund sweeping**: Automate fund aggregation with many-to-1 transfers and optimize gas efficiency.
+- **Cross-chain transfer**: Transfer funds between wallets on different chains.
+- **Transaction screening**: Prevent wallets from transacting with OFAC sanctioned addresses
+- **Wallet filtering**: Query and filter wallets by balance threshold.
 
 ## Quickstart Steps
+
 ### Setup
-USDCKit is built on top of Circle Wallets’ developer-controlled wallets. You will need to set up a Developer Console account before using the service. Please follow these steps:
-1. **Sign Up**: Go to the Developer Console and sign up for an account. This account will be used to manage your access to Circle’s Developer Services. Follow the [instructions](https://developers.circle.com/interactive-quickstarts/get-started#create-a-web3-services-account) for more details.
-2. **Generate API Keys**: Navigate to the API section of your project and generate a new API key. Make sure to store the API key securely as it will be used to authenticate your requests. Follow the [instructions](https://developers.circle.com/interactive-quickstarts/get-started#create-your-api-key) for more details.
-3. **Generate Entity Secret**: The Entity Secret is a robust 32-byte key engineered to enhance the security mechanisms of wallets. Follow the [instructions](https://developers.circle.com/interactive-quickstarts/dev-controlled-wallets#setup-your-entity-secret) to setup your Entity Secret.
-4. **You are good to go!**
+
+USDCKit is built on top of Circle Wallets’ Dev-controlled wallets. You will need to set up a [Circle Developer Console](https://console.circle.com/signup) account before using the service. Please follow these steps:
+
+1. **Sign Up**
+
+   Go to the [Circle Developer Console](https://console.circle.com/signup) and sign up for an account. This account will be used to manage your access to Circle’s Developer Services such as Dev-controlled wallets and smart contract platform. Follow the [instructions](https://developers.circle.com/interactive-quickstarts/get-started#create-a-web3-services-account) for more details.
+
+2. **Generate API Key**
+
+   Navigate to the [API & Client Keys](https://console.circle.com/api-keys) section of your project and generate a new **API Key**. Make sure to store the **API Key** securely as it will be used to authenticate your requests. Follow the [instructions](https://developers.circle.com/interactive-quickstarts/get-started#create-your-api-key) for more details.
+
+3. **Register Entity Secret**
+
+   Run the following command to create and register an **Entity Secret**. The command will prompt you to enter the **API Key** generated from the previous step.
+
+   ```bash
+   npx @circle-fin/usdckit register-entity-secret
+   ```
+
+   After running the command, your new **Entity Secret** will be displayed in the console and saved to an environment file (`.env` by default). A **Recovery File** is also stored (`recovery.dat` by default).
+
+   A UI-based approach for setting up the **Entity Secret** is also [available](https://developers.circle.com/interactive-quickstarts/dev-controlled-wallets#setup-your-entity-secret).
 
 ### Installation
+
 To install USDCKit from NPM, run the following command in your project directory:
+
 ```bash
 npm install @circle-fin/usdckit
 ```
+
 ### Initialization
-To get started with USDKit, initialize a client with the API Key and Entity Secret from [Setup](#setup)
+
+To get started with USDCKit, initialize a client with the **API Key** and [Entity Secret](https://developers.circle.com/w3s/entity-secret-management#what-is-an-entity-secret) from [Setup](#setup)
 
 ```typescript
 import { createCircleClient } from '@circle-fin/usdckit'
 import { ETH_SEPOLIA } from '@circle-fin/usdckit/chains'
 
 const client = createCircleClient({
-    apiKey: 'REPLACE_WITH_CIRCLE_API_KEY',
-    entitySecret: 'REPLACE_WITH_CIRCLE_ENTITY_SECRET',
+  apiKey: 'CIRCLE_API_KEY',
+  entitySecret: 'CIRCLE_ENTITY_SECRET',
 
-    // Optional.  Defaults to `ETH_SEPOLIA`
-    chain: ETH_SEPOLIA,
+  // Optional.  Defaults to `ETH_SEPOLIA`
+  chain: ETH_SEPOLIA,
 })
 ```
 
 ## Usage
 
 ### Create Account
-To create a new account, use the [createAccount](./functions/providers_developer-controlled-wallets.createAccount.html) method. This will generate a new account that you can use for various operations such as transferring tokens and retrieving balances.
+
+To create a new account (also known as wallet), use the [createAccount](./functions/providers_circle-wallets.createAccount.html) method. This will generate a new account that you can use for various operations such as transferring tokens and retrieving balances.
 
 ```typescript
 // Creates an account on the default chain ETH_SEPOLIA
@@ -64,21 +91,23 @@ const account = await client.createAccount()
 ```
 
 ### Query for accounts
-To query for existing accounts, use the [getAccounts](./functions/providers_developer-controlled-wallets.getAccounts.html) method. This will return the account details associated with the provided account query.
+
+To query for existing accounts, use the [getAccounts](./functions/providers_circle-wallets.getAccounts.html) method. This will return the account details associated with the provided account query.
 
 ```typescript
 // Query by Address
-const account = await client.getAccounts({ address: '0xmy-address' })
+const account = await client.getAccounts({ address: '0xabc123...def456' })
 
 // Query by refId
 const account = await client.getAccounts({ refId: 'user-1' })
 
-// Query by balance
+// Query by balance greater or equal to
 const account = await client.getAccounts({ amountGte: 1000 })
 ```
 
 ### Fund Account with Testnet Tokens
-To fund an account with testnet tokens, you can use the [drip](./functions/providers_faucet.drip.html) method. This method provides native tokens, USDC, and EURC for testing purposes.
+
+To fund an account with testnet tokens, you can use the [drip](./functions/providers_circle-wallets.drip.html) method. This method provides native tokens, USDC, and EURC for testing purposes.
 
 ```typescript
 // Receive native tokens, USDC, and EURC
@@ -92,34 +121,36 @@ await client.drip({ account, token: client.chain.contracts.USDC })
 ```
 
 ### Transfer tokens
-The [transfer](./functions/actions.transfer.html) method allows the transferring of native or ERC-20 tokens between accounts. Multiple source accounts can be transferred with a single call.  Fees can be controllable using the `fees` parameter.  Below are examples of how to use the `transfer()` method for each type of token.
+
+The [transfer](./functions/actions.transfer.html) method allows the transferring of native or ERC-20 tokens between accounts. Multiple source accounts can be transferred with a single call. Fees can be controllable using the `fees` parameter. USDC can be transferred between accounts across chains via CCTP. Below are examples of how to use the `transfer()` method for each type of token.
 
 ```typescript
 // Create Transfer - Native Tokens
 const transaction_native = await client.transfer({
-    from: account,
-    to: anotherAccount,
-    amount: '0.00000001',	// or use base units `1n`
+  from: account,
+  to: anotherAccount,
+  amount: '0.00000001', // or use base units `1n`
 })
 
 // Create Transfer - USDC
 const transaction_usdc = await client.transfer({
-    from: account,
-    to: anotherAccount,
-    token: client.chain.contracts.USDC,
-    amount: '0.01',
+  from: account,
+  to: anotherAccount,
+  token: client.chain.contracts.USDC,
+  amount: '0.01',
 })
 
 // Create Transfer - Cross chain USDC
 const transaction_usdc = await client.transfer({
-    from: accountOnETH_SEPOLIA,
-    to: accountOnMATIC_AMOY,
-    token: ETH_SEPOLIA.contracts.USDC,
-    amount: '0.01',
+  from: accountOnETH_SEPOLIA,
+  to: accountOnMATIC_AMOY,
+  token: ETH_SEPOLIA.contracts.USDC,
+  amount: '0.01',
 })
 ```
 
-#### Batch Transfers
+#### Batch Transfer
+
 Transfer from multiple source accounts to a single destination account
 
 ```typescript
@@ -132,35 +163,68 @@ const transaction_batch = await client.transfer({
 })
 ```
 
-#### Drain specified tokens from account
-[drainFrom](./functions/actions.drainFrom.html) function transfers all specified tokens from one account to another. In this example, it transfers all USDC tokens from `account_1` to `account_2`.
+#### Sweep Tokens
+
+[sweep](./functions/actions.sweep.html) function transfers all specified tokens from one account to another. In this example, it transfers all USDC tokens from `account_1` to `account_2`.
 
 ```typescript
-const transaction_drain = await client.drainFrom({
+const [tx] = await client.sweep({
   from: account_1,
   to: account_2,
   token: client.chain.contracts.USDC,
 })
 ```
 
+### Swap tokens
+
+The [swap](./functions/actions.swapExactIn.html) action swaps one ERC-20 token for another
+
+```typescript
+// Swap 100 USDC for WETH
+const txHash = await client.swap({
+  tokenIn: client.chain.contracts.USDC,
+  tokenInAmount: '100',
+  tokenOut: '0xfff9976782d46cc05630d1f6ebab18b2324d6b14',
+  account,
+})
+```
+
 ### Get Account Balance
-Use [getTokenBalances](./functions/providers_developer-controlled-wallets.getTokenBalances.html) to retrieve the token balances for a specified account.
+
+Use [getTokenBalances](./functions/providers_circle-wallets.getTokenBalances.html) to retrieve the token balances for a specified account.
 
 ```typescript
 const balance = await client.getTokenBalances({ account: account_2 })
 ```
 
+### Enable Logging
+
+Logging is enabled by configuring the `logLevel` parameter when creating the client. This allows you to see detailed logs of the operations performed by USDCKit, which can be helpful for debugging and monitoring purposes.
+
+See [createCircleClient](./functions/index.createCircleClient.html) for more details.
+
+```typescript
+const client = createClient({
+  ...,
+  logLevel: 'debug',
+})
+
+```
+
 ## Sample Code to run USDC Acquiring Flow
+
 For more details on how to run an end-to-end USDC Acquiring Flow to support your business, refer to the [USDC Acquiring Flow sample code](./documents/Solutions.USDC_Acquiring_Flow.html)
 
 ## Future Plans
+
 The current private release marks the first version of USDCKit, and we recognize that additional tools are needed to create a smooth USDC payment experience. As such, we are actively working on several modules and would greatly appreciate your feedback. Our roadmap includes, but is not limited to, the following:
-- Swap of USDC
+
+- Swap between USDC and other tokens
 - Mass Payout of USDC
 - Gas Efficiency Enhancement
 
 ## Feedback & Support
+
 If you have any questions or need assistance, don't hesitate to reach out to the team directly([usdckit@circle.com](mailto:usdckit@circle.com)). We're here to support you every step of the way.
 
 Happy coding!
-

package/dist/cjs/actions/generateTransferLink.d.ts

@@ -1,12 +1,15 @@
-import type { Account, Address, NativeUnits, BaseUnits, ExtendedViemClient } from '../types.js';
-import type { Chain, ChainContract } from 'viem';
+import type { Account, Address, Chain, NativeUnits, BaseUnits, ExtendedViemClient } from '../types.js';
+import type { Abi } from 'viem';
 export type GenerateTransferLinkParams = {
     /** The recipient address. */
     to: Address | Account;
     /** The amount to transfer. */
     amount: NativeUnits | BaseUnits;
     /** The token address (optional). */
-    token?: Address | ChainContract | null;
+    token?: Address | {
+        address: Address;
+        abi?: Abi;
+    } | null;
     /** The blockchain chain to use (optional, defaults to client's chain). */
     chain?: Chain;
 };
@@ -23,10 +26,10 @@ export type GenerateTransferLinkParams = {
  * const link = await generateTransferLink(client, {
  *   to: '0xRecipientAddress',
  *   amount: '100',
- *   chain: someChain,
+ *   chain: ETH_SEPOLIA,
  *   token: '0xTokenAddress'
- * });
- * console.log(link);
+ * })
+ * // => 'ethereum:0xRecipientAddress@11155111?value=100&token=0xTokenAddress'
  * ```
  */
 export declare function generateTransferLink(client: ExtendedViemClient, params: GenerateTransferLinkParams): Promise<string>;

package/dist/cjs/actions/generateTransferLink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generateTransferLink.d.ts","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAY,WAAW,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACzG,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAEhD,MAAM,MAAM,0BAA0B,GAAG;IACvC,6BAA6B;IAC7B,EAAE,EAAE,OAAO,GAAG,OAAO,CAAA;IACrB,8BAA8B;IAC9B,MAAM,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,GAAG,aAAa,GAAG,IAAI,CAAA;IACtC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,0BAA0B,GACjC,OAAO,CAAC,MAAM,CAAC,CAyBjB"}
+{"version":3,"file":"generateTransferLink.d.ts","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AACtG,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAE/B,MAAM,MAAM,0BAA0B,GAAG;IACvC,6BAA6B;IAC7B,EAAE,EAAE,OAAO,GAAG,OAAO,CAAA;IACrB,8BAA8B;IAC9B,MAAM,EAAE,WAAW,GAAG,SAAS,CAAA;IAC/B,oCAAoC;IACpC,KAAK,CAAC,EAAE,OAAO,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,GAAG,CAAC,EAAE,GAAG,CAAA;KAAE,GAAG,IAAI,CAAA;IACxD,0EAA0E;IAC1E,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,oBAAoB,CACxC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,0BAA0B,GACjC,OAAO,CAAC,MAAM,CAAC,CAqBjB"}

package/dist/cjs/actions/generateTransferLink.js

@@ -11,12 +11,11 @@
 // prohibited without the express written permission of Circle Internet Group, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateTransferLink = generateTransferLink;
-const utils_1 = require("viem/utils");
-const getContract_js_1 = require("../providers/smart-contract-platform/actions/getContract.js");
+const viem_1 = require("viem");
 const parseAccount_js_1 = require("../utils/parseAccount.js");
 const parseAddress_js_1 = require("../utils/parseAddress.js");
+const parseUnitsAsToken_js_1 = require("../utils/parseUnitsAsToken.js");
 const toERC681_js_1 = require("../utils/toERC681.js");
-const parseUnitsAsToken_js_1 = require("./parseUnitsAsToken.js");
 /**
  * Generates a ERC-681 transfer link for a specified recipient and amount.
  *
@@ -30,24 +29,22 @@ const parseUnitsAsToken_js_1 = require("./parseUnitsAsToken.js");
  * const link = await generateTransferLink(client, {
  *   to: '0xRecipientAddress',
  *   amount: '100',
- *   chain: someChain,
+ *   chain: ETH_SEPOLIA,
  *   token: '0xTokenAddress'
- * });
- * console.log(link);
+ * })
+ * // => 'ethereum:0xRecipientAddress@11155111?value=100&token=0xTokenAddress'
  * ```
  */
 async function generateTransferLink(client, params) {
-    const { to, amount: _amount, chain = client.chain } = params;
-    const getContract = (0, utils_1.getAction)(client, getContract_js_1.getContract, 'getContract');
-    const parseUnitsAsToken = (0, utils_1.getAction)(client, parseUnitsAsToken_js_1.parseUnitsAsToken, 'parseUnitsAsToken');
-    const token = params.token != null ? (0, parseAddress_js_1.parseAddress)(params.token) : undefined;
-    const tokenContract = token != null ? await getContract(token) : undefined;
-    const toAccount = (0, parseAccount_js_1.parseAccount)(to);
-    const amount = await parseUnitsAsToken({ value: _amount, token: token?.address, chain });
-    return tokenContract !== undefined
+    const { to, amount: _amount, chain: _chain = client.chain } = params;
+    const toAccount = (0, parseAccount_js_1.parseAccount)(to, { chain: _chain });
+    const chain = toAccount.chain;
+    const token = params.token != null ? (0, parseAddress_js_1.parseAddress)(params.token) : null;
+    const amount = await (0, parseUnitsAsToken_js_1.parseUnitsAsToken)({ value: _amount, token, chain });
+    return token != null
         ? (0, toERC681_js_1.toERC681)({
-            abi: tokenContract.abi,
-            address: tokenContract.address,
+            abi: token.abi ?? viem_1.erc20Abi,
+            address: token.address,
             functionName: 'transfer',
             args: [toAccount.address, amount],
             chainId: chain.id,

package/dist/cjs/actions/generateTransferLink.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateTransferLink.js","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AA4CnF,oDA4BC;AAtED,sCAAsC;AAEtC,gGAAyG;AACzG,8DAAuD;AACvD,8DAAuD;AACvD,sDAA+C;AAE/C,iEAAgF;AAgBhF;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAA0B,EAC1B,MAAkC;IAElC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,MAAM,CAAA;IAE5D,MAAM,WAAW,GAAG,IAAA,iBAAS,EAAC,MAAM,EAAE,4BAAY,EAAE,aAAa,CAAC,CAAA;IAClE,MAAM,iBAAiB,GAAG,IAAA,iBAAS,EAAC,MAAM,EAAE,wCAAkB,EAAE,mBAAmB,CAAC,CAAA;IAEpF,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAA,8BAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC3E,MAAM,aAAa,GAAyB,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAEhG,MAAM,SAAS,GAAG,IAAA,8BAAY,EAAC,EAAE,CAAC,CAAA;IAClC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAA;IAExF,OAAO,aAAa,KAAK,SAAS;QAChC,CAAC,CAAC,IAAA,sBAAQ,EAAC;YACP,GAAG,EAAE,aAAa,CAAC,GAAG;YACtB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,YAAY,EAAE,UAAU;YACxB,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;YACjC,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC;QACJ,CAAC,CAAC,IAAA,sBAAQ,EAAC;YACP,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC,CAAA;AACR,CAAC"}
+{"version":3,"file":"generateTransferLink.js","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AA0CnF,oDAwBC;AAhED,+BAA+B;AAE/B,8DAAuD;AACvD,8DAAuD;AACvD,wEAAiE;AACjE,sDAA+C;AAgB/C;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAA0B,EAC1B,MAAkC;IAElC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,MAAM,CAAA;IAEpE,MAAM,SAAS,GAAG,IAAA,8BAAY,EAAC,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAA;IACrD,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,CAAA;IAC7B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAA,8BAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACtE,MAAM,MAAM,GAAG,MAAM,IAAA,wCAAiB,EAAC,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAA;IAExE,OAAO,KAAK,IAAI,IAAI;QAClB,CAAC,CAAC,IAAA,sBAAQ,EAAC;YACP,GAAG,EAAE,KAAK,CAAC,GAAG,IAAI,eAAQ;YAC1B,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,YAAY,EAAE,UAAU;YACxB,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;YACjC,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC;QACJ,CAAC,CAAC,IAAA,sBAAQ,EAAC;YACP,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC,CAAA;AACR,CAAC"}

package/dist/cjs/actions/generateTransferLink.test.js

@@ -10,6 +10,7 @@
 // of this source code or any related proprietary information is strictly
 // prohibited without the express written permission of Circle Internet Group, Inc.
 Object.defineProperty(exports, "__esModule", { value: true });
+const viem_1 = require("viem");
 const vitest_1 = require("vitest");
 const index_js_1 = require("../chains/index.js");
 const generateTransferLink_js_1 = require("./generateTransferLink.js");
@@ -21,32 +22,7 @@ vitest_1.describe.concurrent('generateTransferLink', () => {
             read: {
                 decimals: vitest_1.vi.fn(() => 6),
             },
-            abi: [
-                {
-                    inputs: [
-                        {
-                            internalType: 'address',
-                            name: 'to',
-                            type: 'address',
-                        },
-                        {
-                            internalType: 'uint256',
-                            name: 'value',
-                            type: 'uint256',
-                        },
-                    ],
-                    name: 'transfer',
-                    outputs: [
-                        {
-                            internalType: 'bool',
-                            name: '',
-                            type: 'bool',
-                        },
-                    ],
-                    stateMutability: 'nonpayable',
-                    type: 'function',
-                },
-            ],
+            abi: viem_1.erc20Abi,
         })),
     };
     vitest_1.test.each([

package/dist/cjs/actions/generateTransferLink.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateTransferLink.test.js","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.test.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AAEnF,mCAAmD;AAEnD,iDAAgD;AAEhD,uEAAgE;AAIhE,iBAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC/C,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,sBAAW;QAClB,WAAW,EAAE,WAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAuB,EAAE,EAAE,CAAC,CAAC;YACxD,OAAO;YACP,IAAI,EAAE;gBACJ,QAAQ,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;aACzB;YACD,GAAG,EAAE;gBACH;oBACE,MAAM,EAAE;wBACN;4BACE,YAAY,EAAE,SAAS;4BACvB,IAAI,EAAE,IAAI;4BACV,IAAI,EAAE,SAAS;yBAChB;wBACD;4BACE,YAAY,EAAE,SAAS;4BACvB,IAAI,EAAE,OAAO;4BACb,IAAI,EAAE,SAAS;yBAChB;qBACF;oBACD,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE;wBACP;4BACE,YAAY,EAAE,MAAM;4BACpB,IAAI,EAAE,EAAE;4BACR,IAAI,EAAE,MAAM;yBACb;qBACF;oBACD,eAAe,EAAE,YAAY;oBAC7B,IAAI,EAAE,UAAU;iBACjB;aACF;SACF,CAAC,CAAC;KAC6B,CAAA;IAElC,aAAI,CAAC,IAAI,CAAC;QACR;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,sBAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,sBAAW;aACnB;YACD,yIAAyI;SAC1I;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,sBAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,sBAAW;aACnB;YACD,2IAA2I;SAC5I;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,EAAE;aACX;YACD,sEAAsE;SACvE;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,GAAG;aACZ;YACD,wFAAwF;SACzF;KACO,CAAC,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE;QACjE,MAAM,IAAA,eAAM,EAAC,IAAA,8CAAoB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"generateTransferLink.test.js","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.test.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AAEnF,+BAA+B;AAC/B,mCAAmD;AAEnD,iDAAgD;AAEhD,uEAAgE;AAIhE,iBAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC/C,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,sBAAW;QAClB,WAAW,EAAE,WAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAuB,EAAE,EAAE,CAAC,CAAC;YACxD,OAAO;YACP,IAAI,EAAE;gBACJ,QAAQ,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;aACzB;YACD,GAAG,EAAE,eAAQ;SACd,CAAC,CAAC;KAC6B,CAAA;IAElC,aAAI,CAAC,IAAI,CAAC;QACR;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,sBAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,sBAAW;aACnB;YACD,yIAAyI;SAC1I;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,sBAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,sBAAW;aACnB;YACD,2IAA2I;SAC5I;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,EAAE;aACX;YACD,sEAAsE;SACvE;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,GAAG;aACZ;YACD,wFAAwF;SACzF;KACO,CAAC,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,EAAE,cAAc,EAAE,EAAE;QACjE,MAAM,IAAA,eAAM,EAAC,IAAA,8CAAoB,EAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/cjs/actions/index.d.ts

@@ -1,26 +1,30 @@
-import { drainFrom } from './drainFrom.js';
 import { generateTransferLink } from './generateTransferLink.js';
-import { parseUnitsAsToken } from './parseUnitsAsToken.js';
+import { swapExactIn } from './swapExactIn.js';
+import { sweep } from './sweep.js';
 import { transfer } from './transfer.js';
-import type { ParseUnitsAsTokenParams } from './parseUnitsAsToken.js';
-import type { Account } from '../types.js';
-import type { DrainFromParams } from './drainFrom.js';
+import type { Account, Chain } from '../types.js';
 import type { GenerateTransferLinkParams } from './generateTransferLink.js';
+import type { SwapExactInParams } from './swapExactIn.js';
+import type { SweepParams } from './sweep.js';
 import type { TransferParams } from './transfer.js';
-import type { Chain, Client, Transport } from 'viem';
+import type { Client, Transport } from 'viem';
 export * from './transfer.js';
-export * from './drainFrom.js';
+export * from './sweep.js';
 export * from './generateTransferLink.js';
-export * from './parseUnitsAsToken.js';
+export * from './swapExactIn.js';
 export type Actions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
     /** See {@link transfer} action */
     transfer: (params: Parameters<typeof transfer>[1]) => ReturnType<typeof transfer>;
-    /** See {@link drainFrom} action */
-    drainFrom: (params: Parameters<typeof drainFrom>[1]) => ReturnType<typeof drainFrom>;
+    /** See {@link sweep} action */
+    sweep: (params: Parameters<typeof sweep>[1]) => ReturnType<typeof sweep>;
+    /** See {@link sweep} action */
+    drainFrom: (params: Parameters<typeof sweep>[1]) => ReturnType<typeof sweep>;
     /** See {@link generateTransferLink} action */
     generateTransferLink: (params: Parameters<typeof generateTransferLink>[1]) => ReturnType<typeof generateTransferLink>;
-    /** See {@link parseUnitsAsToken} action */
-    parseUnitsAsToken: (params: Parameters<typeof parseUnitsAsToken>[1]) => ReturnType<typeof parseUnitsAsToken>;
+    /** See {@link swapExactIn} action */
+    swap: (params: Parameters<typeof swapExactIn>[1]) => ReturnType<typeof swapExactIn>;
+    /** See {@link swapExactIn} action */
+    swapExactIn: (params: Parameters<typeof swapExactIn>[1]) => ReturnType<typeof swapExactIn>;
 };
 /**
  * Returns an object containing action functions bound to the provided client.
@@ -29,13 +33,17 @@ export type Actions<transport extends Transport = Transport, chain extends Chain
  * @returns An object containing the bound action functions.
  */
 export declare function actions(client: Client): {
-    /** See {@link drainFrom} action */
-    drainFrom: (params: DrainFromParams) => Promise<import("./transfer.js").TransferReturnType>;
+    /** See {@link sweep} action */
+    sweep: (params: SweepParams) => Promise<import("./transfer.js").TransferReturnType>;
+    /** See {@link sweep} action */
+    drainFrom: (params: SweepParams) => Promise<import("./transfer.js").TransferReturnType>;
     /** See {@link transfer} action */
     transfer: (params: TransferParams) => Promise<import("./transfer.js").TransferReturnType>;
     /** See {@link generateTransferLink} action */
     generateTransferLink: (params: GenerateTransferLinkParams) => Promise<string>;
-    /** See {@link parseUnitsAsToken} action */
-    parseUnitsAsToken: (params: ParseUnitsAsTokenParams) => Promise<bigint>;
+    /** See {@link swapExactIn} action */
+    swap: (params: SwapExactInParams) => Promise<`0x${string}`>;
+    /** See {@link swapExactIn} action */
+    swapExactIn: (params: SwapExactInParams) => Promise<`0x${string}`>;
 };
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/actions/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC1D,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AACrE,OAAO,KAAK,EAAE,OAAO,EAAsB,MAAM,aAAa,CAAA;AAC9D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AACrD,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAEpD,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AACzC,cAAc,wBAAwB,CAAA;AAGtC,MAAM,MAAM,OAAO,CAEjB,SAAS,SAAS,SAAS,GAAG,SAAS,EAEvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAEnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF,kCAAkC;IAClC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAA;IACjF,mCAAmC;IACnC,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,SAAS,CAAC,CAAA;IACpF,8CAA8C;IAC9C,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;IACrH,2CAA2C;IAC3C,iBAAiB,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAA;CAC7G,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM;IAElC,mCAAmC;wBACf,eAAe;IACnC,kCAAkC;uBACf,cAAc;IACjC,8CAA8C;mCACf,0BAA0B;IAEzD,2CAA2C;gCACf,uBAAuB;EAEtD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAC9C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAsB,MAAM,aAAa,CAAA;AACrE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAA;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,eAAe,CAAA;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAA;AAE7C,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,2BAA2B,CAAA;AACzC,cAAc,kBAAkB,CAAA;AAGhC,MAAM,MAAM,OAAO,CAEjB,SAAS,SAAS,SAAS,GAAG,SAAS,EAEvC,KAAK,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EAEnD,OAAO,SAAS,OAAO,GAAG,SAAS,GAAG,OAAO,GAAG,SAAS,IACvD;IACF,kCAAkC;IAClC,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAA;IACjF,+BAA+B;IAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,KAAK,CAAC,CAAA;IACxE,+BAA+B;IAC/B,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,KAAK,CAAC,CAAA;IAC5E,8CAA8C;IAC9C,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;IACrH,qCAAqC;IACrC,IAAI,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA;IACnF,qCAAqC;IACrC,WAAW,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,WAAW,CAAC,CAAA;CAC3F,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM;IAElC,+BAA+B;oBACf,WAAW;IAC3B,+BAA+B;wBACX,WAAW;IAC/B,kCAAkC;uBACf,cAAc;IACjC,8CAA8C;mCACf,0BAA0B;IAEzD,qCAAqC;mBACtB,iBAAiB;IAChC,qCAAqC;0BACf,iBAAiB;EAE1C"}

package/dist/cjs/actions/index.js

@@ -25,14 +25,14 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.actions = actions;
-const drainFrom_js_1 = require("./drainFrom.js");
 const generateTransferLink_js_1 = require("./generateTransferLink.js");
-const parseUnitsAsToken_js_1 = require("./parseUnitsAsToken.js");
+const swapExactIn_js_1 = require("./swapExactIn.js");
+const sweep_js_1 = require("./sweep.js");
 const transfer_js_1 = require("./transfer.js");
 __exportStar(require("./transfer.js"), exports);
-__exportStar(require("./drainFrom.js"), exports);
+__exportStar(require("./sweep.js"), exports);
 __exportStar(require("./generateTransferLink.js"), exports);
-__exportStar(require("./parseUnitsAsToken.js"), exports);
+__exportStar(require("./swapExactIn.js"), exports);
 /**
  * Returns an object containing action functions bound to the provided client.
  *
@@ -41,14 +41,18 @@ __exportStar(require("./parseUnitsAsToken.js"), exports);
  */
 function actions(client) {
     return {
-        /** See {@link drainFrom} action */
-        drainFrom: (params) => (0, drainFrom_js_1.drainFrom)(client, params),
+        /** See {@link sweep} action */
+        sweep: (params) => (0, sweep_js_1.sweep)(client, params),
+        /** See {@link sweep} action */
+        drainFrom: (params) => (0, sweep_js_1.sweep)(client, params),
         /** See {@link transfer} action */
         transfer: (params) => (0, transfer_js_1.transfer)(client, params),
         /** See {@link generateTransferLink} action */
         generateTransferLink: (params) => (0, generateTransferLink_js_1.generateTransferLink)(client, params),
-        /** See {@link parseUnitsAsToken} action */
-        parseUnitsAsToken: (params) => (0, parseUnitsAsToken_js_1.parseUnitsAsToken)(client, params),
+        /** See {@link swapExactIn} action */
+        swap: (params) => (0, swapExactIn_js_1.swapExactIn)(client, params),
+        /** See {@link swapExactIn} action */
+        swapExactIn: (params) => (0, swapExactIn_js_1.swapExactIn)(client, params),
     };
 }
 //# sourceMappingURL=index.js.map

package/dist/cjs/actions/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;;;;;;;;;;;;;;;AA4CnF,0BAYC;AAtDD,iDAA0C;AAC1C,uEAAgE;AAChE,iEAA0D;AAC1D,+CAAwC;AASxC,gDAA6B;AAC7B,iDAA8B;AAC9B,4DAAyC;AACzC,yDAAsC;AAqBtC;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,MAAc;IACpC,OAAO;QACL,mCAAmC;QACnC,SAAS,EAAE,CAAC,MAAuB,EAAE,EAAE,CAAC,IAAA,wBAAS,EAAC,MAA4B,EAAE,MAAM,CAAC;QACvF,kCAAkC;QAClC,QAAQ,EAAE,CAAC,MAAsB,EAAE,EAAE,CAAC,IAAA,sBAAQ,EAAC,MAA4B,EAAE,MAAM,CAAC;QACpF,8CAA8C;QAC9C,oBAAoB,EAAE,CAAC,MAAkC,EAAE,EAAE,CAC3D,IAAA,8CAAoB,EAAC,MAA4B,EAAE,MAAM,CAAC;QAC5D,2CAA2C;QAC3C,iBAAiB,EAAE,CAAC,MAA+B,EAAE,EAAE,CAAC,IAAA,wCAAiB,EAAC,MAA4B,EAAE,MAAM,CAAC;KAChH,CAAA;AACH,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/actions/index.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;;;;;;;;;;;;;;;AAgDnF,0BAgBC;AA9DD,uEAAgE;AAChE,qDAA8C;AAC9C,yCAAkC;AAClC,+CAAwC;AASxC,gDAA6B;AAC7B,6CAA0B;AAC1B,4DAAyC;AACzC,mDAAgC;AAyBhC;;;;;GAKG;AACH,SAAgB,OAAO,CAAC,MAAc;IACpC,OAAO;QACL,+BAA+B;QAC/B,KAAK,EAAE,CAAC,MAAmB,EAAE,EAAE,CAAC,IAAA,gBAAK,EAAC,MAA4B,EAAE,MAAM,CAAC;QAC3E,+BAA+B;QAC/B,SAAS,EAAE,CAAC,MAAmB,EAAE,EAAE,CAAC,IAAA,gBAAK,EAAC,MAA4B,EAAE,MAAM,CAAC;QAC/E,kCAAkC;QAClC,QAAQ,EAAE,CAAC,MAAsB,EAAE,EAAE,CAAC,IAAA,sBAAQ,EAAC,MAA4B,EAAE,MAAM,CAAC;QACpF,8CAA8C;QAC9C,oBAAoB,EAAE,CAAC,MAAkC,EAAE,EAAE,CAC3D,IAAA,8CAAoB,EAAC,MAA4B,EAAE,MAAM,CAAC;QAC5D,qCAAqC;QACrC,IAAI,EAAE,CAAC,MAAyB,EAAE,EAAE,CAAC,IAAA,4BAAW,EAAC,MAA4B,EAAE,MAAM,CAAC;QACtF,qCAAqC;QACrC,WAAW,EAAE,CAAC,MAAyB,EAAE,EAAE,CAAC,IAAA,4BAAW,EAAC,MAA4B,EAAE,MAAM,CAAC;KAC9F,CAAA;AACH,CAAC"}

package/dist/cjs/actions/index.test.js

@@ -20,14 +20,18 @@ vitest_1.describe.concurrent('actions', () => {
     (0, vitest_1.it)('should return an object with the expected methods', () => {
         const result = (0, index_js_1.actions)(client);
         (0, vitest_1.expect)(result).toEqual({
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            sweep: vitest_1.expect.any(Function),
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             drainFrom: vitest_1.expect.any(Function),
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             generateTransferLink: vitest_1.expect.any(Function),
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-            parseUnitsAsToken: vitest_1.expect.any(Function),
-            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             transfer: vitest_1.expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            swap: vitest_1.expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            swapExactIn: vitest_1.expect.any(Function),
         });
     });
 });

package/dist/cjs/actions/index.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../src/actions/index.test.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AAEnF,mCAA4D;AAE5D,yCAAoC;AAIpC,iBAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,EAAE;IAClC,MAAM,MAAM,GAAG,EAAE,CAAA;IAEjB,IAAA,kBAAS,EAAC,GAAG,EAAE;QACb,WAAE,CAAC,eAAe,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,MAAM,GAAG,IAAA,kBAAO,EAAC,MAA2B,CAAC,CAAA;QAEnD,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,mEAAmE;YACnE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC/B,mEAAmE;YACnE,oBAAoB,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1C,mEAAmE;YACnE,iBAAiB,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YACvC,mEAAmE;YACnE,QAAQ,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../../src/actions/index.test.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AAEnF,mCAA4D;AAE5D,yCAAoC;AAIpC,iBAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,EAAE;IAClC,MAAM,MAAM,GAAG,EAAE,CAAA;IAEjB,IAAA,kBAAS,EAAC,GAAG,EAAE;QACb,WAAE,CAAC,eAAe,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,MAAM,GAAG,IAAA,kBAAO,EAAC,MAA2B,CAAC,CAAA;QAEnD,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,mEAAmE;YACnE,KAAK,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC3B,mEAAmE;YACnE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC/B,mEAAmE;YACnE,oBAAoB,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1C,mEAAmE;YACnE,QAAQ,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC9B,mEAAmE;YACnE,IAAI,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1B,mEAAmE;YACnE,WAAW,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SAClC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,39 @@
+import type { Account, Address, BaseUnits, Chain, ControlFlowOptions, ExtendedViemClient, FeeValuesEIP1559, NativeUnits } from '../types.js';
+import type { Abi } from 'viem';
+/**
+ * Parameters for the {@link swapExactIn} function.
+ */
+export type SwapExactInParams = {
+    /** The token to swap from. */
+    tokenIn: Address | {
+        address: Address;
+        abi?: Abi;
+    };
+    /** The amount of the token to swap from */
+    tokenInAmount: NativeUnits | BaseUnits;
+    /** The token to swap to. */
+    tokenOut: Address | {
+        address: Address;
+        abi?: Abi;
+    };
+    /** The minimum amount of the token to receive from the swap. This is used to protect against slippage. */
+    tokenOutAmount?: NativeUnits | BaseUnits;
+    /** The account address that will execute the transaction */
+    account: Address | Account;
+    /** Gas limit for the transaction */
+    gas?: bigint;
+    /** The fee values for the transaction */
+    fees?: FeeValuesEIP1559;
+    /** The blockchain network on which the transaction will be executed. */
+    chain?: Chain;
+};
+export type SwapExactInParamsReturnType = Address;
+/**
+ * Swaps an exact amount of one token for another token
+ *
+ * @param client - The client instance to use for the operation.
+ * @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>;
+//# sourceMappingURL=swapExactIn.d.ts.map

package/dist/cjs/actions/swapExactIn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"swapExactIn.d.ts","sourceRoot":"","sources":["../../../src/actions/swapExactIn.ts"],"names":[],"mappings":"AAiBA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,SAAS,EACT,KAAK,EACL,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACZ,MAAM,aAAa,CAAA;AACpB,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,MAAM,CAAA;AAE/B;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8BAA8B;IAC9B,OAAO,EAAE,OAAO,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,GAAG,CAAC,EAAE,GAAG,CAAA;KAAE,CAAA;IAClD,2CAA2C;IAC3C,aAAa,EAAE,WAAW,GAAG,SAAS,CAAA;IACtC,4BAA4B;IAC5B,QAAQ,EAAE,OAAO,GAAG;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,GAAG,CAAC,EAAE,GAAG,CAAA;KAAE,CAAA;IACnD,0GAA0G;IAC1G,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAA;IACxC,4DAA4D;IAC5D,OAAO,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,oCAAoC;IACpC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,wEAAwE;IACxE,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG,OAAO,CAAA;AAEjD;;;;;;GAMG;AACH,wBAAsB,WAAW,CAC/B,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,iBAAiB,GAAG,kBAAkB,GAC7C,OAAO,CAAC,2BAA2B,CAAC,CA8BtC"}