@circle-fin/usdckit 0.11.1

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,133 @@
+# 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.
+
+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.
+
+
+### 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.
+* Fund sweeping: Automate fund aggregation and optimize gas efficiency.
+
+## Setup
+
+USDCKit is built on top of Circle Programmable Wallet - Developer Controlled Wallet, you will need to set up a Circle Programmable Wallets account before using the service. Please follow these steps:
+
+1. **Sign Up**: Go to the [Circle Programmable Wallets](https://www.circle.com/en/programmable-wallets) website and sign up for an account. This account will be used to manage your access to Circle Web3 services.
+2. **Create a Project**: Once logged in, create a new project. This project will be used to manage your wallets and API keys.
+3. **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.
+4. **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.
+5. **You are good to go!**
+
+
+### Installation
+
+To install USDCKit from NPM, run the following command in your project directory:
+
+```bash
+npm install @circle-fin/usdckit
+```
+
+## Usage
+
+### Initialization
+
+To get started with USDKit, initialize a client with the API Key and Entity Secret from [Setup](#setup)
+```typescript
+import { createCircleClient } from '@circle-fin/usdckit'
+import { ETH_SEPOLIA } from '@circle-fin/usdckit/chains'
+
+const client = createCircleClient({
+    apiKey: 'CIRCLE_API_KEY',
+    entitySecret: 'CIRCLE_ENTITY_SECRET',
+    chain: ETH_SEPOLIA, // Optional.  Defaults to `ETH_SEPOLIA`
+})
+```
+
+### Create Account
+To create a new account, use the `createAccount` method. This will generate a new account that you can use for various operations such as transferring tokens and retrieving balances.
+
+```typescript
+const account = await client.createAccount()  // Creates an account on ETH_SEPOLIA
+```
+
+
+### Query for accounts
+To query for existing accounts, use the getAccounts 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' })
+
+// Query by refId
+const account = await client.getAccounts({ refId: 'user-1' })
+
+// Query by balance
+const account = await client.getAccounts({ amountGte: 1000 })
+```
+
+
+### Fund Account with Testnet Tokens
+
+To fund an account with testnet tokens, you can use the `drip` method. This method provides native tokens, USDC, and EURC for testing purposes.
+
+```typescript
+await client.drip({ account })  // Receive native tokens, USDC, and EURC
+await client.drip({ account, token: null })  // Receive native
+await client.drip({ account, token: client.chain.contracts.USDC })  // Receive USDC
+```
+
+### Transfer tokens
+The `transfer()` 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.
+
+```typescript
+// Create Transfer - Native Tokens
+const transaction_native = await client.transfer({
+    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',
+})
+```
+
+#### Batch Transfers
+
+```typescript
+// Create Transfer - Batch transfer
+const transaction_batch = await client.transfer({
+  from: [account_1, account_2],
+  to: account_3,
+  token: client.chain.contracts.USDC,
+  amount: '0.01',
+})
+```
+
+#### Drain specified tokens from account
+This 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({
+  from: account_1,
+  to: account_2,
+  token: client.chain.contracts.USDC,
+})
+```
+
+### Get Account Balance
+Retrieves the token balances for a specified account.
+
+```typescript
+const balance = await client.getTokenBalances({ account: account_2 })
+```

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

@@ -0,0 +1,16 @@
+import { type TransferReturnType, type TransferParams } from './transfer.js';
+import type { ExtendedViemClient } from '../types.js';
+/**
+ * Parameters for draining tokens from accounts, excluding the amount parameter.
+ */
+export type DrainFromParams = Omit<TransferParams, 'amount'>;
+export type DrainFromReturnType = TransferReturnType;
+/**
+ * Calculates the token balance for each provided account and calls {@link transfer} with the calculated amount.
+ *
+ * @param client - The client instance to use for the operation.
+ * @param params - Parameters for the drain operation, excluding amount which is determined automatically.
+ * @returns An array of transfer results.
+ */
+export declare function drainFrom(client: ExtendedViemClient, params: DrainFromParams): Promise<DrainFromReturnType>;
+//# sourceMappingURL=drainFrom.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"drainFrom.d.ts","sourceRoot":"","sources":["../../../src/actions/drainFrom.ts"],"names":[],"mappings":"AAeA,OAAO,EAAE,KAAK,kBAAkB,EAAE,KAAK,cAAc,EAAY,MAAM,eAAe,CAAA;AAEtF,OAAO,KAAK,EAAW,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAE9D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;AAC5D,MAAM,MAAM,mBAAmB,GAAG,kBAAkB,CAAA;AAEpD;;;;;;GAMG;AACH,wBAAsB,SAAS,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAgBjH"}

package/dist/cjs/actions/drainFrom.js

@@ -0,0 +1,39 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.drainFrom = drainFrom;
+const utils_1 = require("viem/utils");
+const getTokenBalances_js_1 = require("../providers/developer-controlled-wallets/actions/getTokenBalances.js");
+const transfer_js_1 = require("./transfer.js");
+/**
+ * Calculates the token balance for each provided account and calls {@link transfer} with the calculated amount.
+ *
+ * @param client - The client instance to use for the operation.
+ * @param params - Parameters for the drain operation, excluding amount which is determined automatically.
+ * @returns An array of transfer results.
+ */
+async function drainFrom(client, params) {
+    const getTokenBalances = (0, utils_1.getAction)(client, getTokenBalances_js_1.getTokenBalances, 'getTokenBalances');
+    const { token = null } = params;
+    /**
+     * Gets the current balance of tokens for an account to be drained.
+     *
+     * @param account - The account to check the balance for
+     * @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;
+    }
+    return await (0, transfer_js_1.transfer)(client, { ...params, amount: zeroAmount });
+}
+//# sourceMappingURL=drainFrom.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"drainFrom.js","sourceRoot":"","sources":["../../../src/actions/drainFrom.ts"],"names":[],"mappings":";AAAA,kDAAkD;AAClD,uBAAuB;AACvB,EAAE;AACF,2CAA2C;AAC3C,EAAE;AACF,4EAA4E;AAC5E,kDAAkD;AAClD,8EAA8E;AAC9E,yEAAyE;AACzE,mFAAmF;;AAuBnF,8BAgBC;AArCD,sCAAsC;AAEtC,+GAA6H;AAE7H,+CAAsF;AAUtF;;;;;;GAMG;AACI,KAAK,UAAU,SAAS,CAAC,MAA0B,EAAE,MAAuB;IACjF,MAAM,gBAAgB,GAAG,IAAA,iBAAS,EAAC,MAAM,EAAE,sCAAiB,EAAE,kBAAkB,CAAC,CAAA;IACjF,MAAM,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,MAAM,CAAA;IAE/B;;;;;OAKG;IACH,KAAK,UAAU,UAAU,CAAC,OAAgB;QACxC,MAAM,QAAQ,GAAG,CAAC,MAAM,gBAAgB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAwB,CAAA;QACpF,OAAO,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,EAAE,CAAA;IACpC,CAAC;IAED,OAAO,MAAM,IAAA,sBAAQ,EAAC,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAA;AAClE,CAAC"}

package/dist/cjs/actions/drainFrom.test.d.ts

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

package/dist/cjs/actions/drainFrom.test.d.ts.map

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

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

@@ -0,0 +1,73 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const index_js_1 = require("../chains/index.js");
+const drainFrom_js_1 = require("./drainFrom.js");
+(0, vitest_1.describe)('drainFrom()', () => {
+    (0, vitest_1.afterEach)(() => {
+        vitest_1.vi.restoreAllMocks();
+    });
+    const client = {
+        chain: index_js_1.ETH_SEPOLIA,
+        getContract: vitest_1.vi.fn(({ address }) => ({
+            address,
+            read: {
+                decimals: vitest_1.vi.fn(() => 6),
+            },
+        })),
+        estimateTransferFee: vitest_1.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: vitest_1.vi.fn(() => ({
+            id: 'transaction-id',
+            state: 'COMPLETE',
+            txHash: 'tx-hash',
+        })),
+        waitForTransactionHash: vitest_1.vi.fn(({ id }) => ({
+            id,
+            state: 'COMPLETE',
+            txHash: 'tx-hash',
+        })),
+        waitForTransactionReceipt: vitest_1.vi.fn(() => { }),
+        getTokenBalances: vitest_1.vi.fn(() => [
+            {
+                token: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238',
+                decimals: 6,
+                symbol: 'USDC',
+                value: 1237999924n,
+                formatted: '1237.999924',
+            },
+        ]),
+    };
+    (0, vitest_1.it)('should call transfer() with the full amount of account', async () => {
+        const params = {
+            from: { address: '0x123', type: 'json-rpc' },
+            to: { address: '0x321', type: 'json-rpc' },
+            token: index_js_1.ETH_SEPOLIA.contracts.USDC,
+        };
+        const expectedResult = [{ hash: 'tx-hash' }];
+        const result = await (0, drainFrom_js_1.drainFrom)(client, params);
+        (0, vitest_1.expect)(result).toEqual(expectedResult);
+        (0, vitest_1.expect)(client.createTransaction).toHaveBeenCalledWith({
+            sourceAddress: params.from.address,
+            destinationAddress: params.to.address,
+            blockchain: 'ETH-SEPOLIA',
+            amounts: ['1237.999924'],
+            tokenAddress: params.token.address,
+            fee: { type: 'absolute', config: { gasLimit: '3', maxFee: '6', priorityFee: '9' } },
+        });
+    });
+});
+//# sourceMappingURL=drainFrom.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"drainFrom.test.js","sourceRoot":"","sources":["../../../src/actions/drainFrom.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,iDAAgD;AAEhD,iDAA0C;AAI1C,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,IAAA,kBAAS,EAAC,GAAG,EAAE;QACb,WAAE,CAAC,eAAe,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,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;SACF,CAAC,CAAC;QACH,mBAAmB,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;YAChC,IAAI,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE;YACvF,MAAM,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE;YACxF,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE;SACrF,CAAC,CAAC;QACH,iBAAiB,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC;YAC9B,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,sBAAsB,EAAE,WAAE,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,EAAkB,EAAE,EAAE,CAAC,CAAC;YACzD,EAAE;YACF,KAAK,EAAE,UAAU;YACjB,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,yBAAyB,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC;QAC1C,gBAAgB,EAAE,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC;YAC5B;gBACE,KAAK,EAAE,4CAA4C;gBACnD,QAAQ,EAAE,CAAC;gBACX,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,WAAW;gBAClB,SAAS,EAAE,aAAa;aACzB;SACF,CAAC;KACH,CAAA;IAED,IAAA,WAAE,EAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,MAAM,GAAG;YACb,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE;YAC5C,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE;YAC1C,KAAK,EAAE,sBAAW,CAAC,SAAS,CAAC,IAAI;SACzB,CAAA;QACV,MAAM,cAAc,GAAG,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAA;QAE5C,MAAM,MAAM,GAAG,MAAM,IAAA,wBAAS,EAAC,MAAuC,EAAE,MAAM,CAAC,CAAA;QAC/E,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAEtC,IAAA,eAAM,EAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,oBAAoB,CAAC;YACpD,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO;YAClC,kBAAkB,EAAE,MAAM,CAAC,EAAE,CAAC,OAAO;YACrC,UAAU,EAAE,aAAa;YACzB,OAAO,EAAE,CAAC,aAAa,CAAC;YACxB,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,OAAO;YAClC,GAAG,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE;SACpF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,33 @@
+import { type Chain, type ChainContract } from 'viem';
+import { type Account, type Address, type NativeUnits, type BaseUnits, type ExtendedViemClient } from '../types.js';
+export type GenerateTransferLinkParams = {
+    /** The recipient address. */
+    to: Address | Account;
+    /** The amount to transfer. */
+    amount: NativeUnits | BaseUnits;
+    /** The token address (optional). */
+    token?: Address | ChainContract | null;
+    /** The blockchain chain to use (optional, defaults to client's chain). */
+    chain?: Chain;
+};
+/**
+ * Generates a ERC-681 transfer link for a specified recipient and amount.
+ *
+ * @param client - The client instance to use for the operation.
+ * @returns A promise that resolves to the generated transfer link.
+ *
+ * @throws Will throw an error if the contract read operation fails.
+ *
+ * @example
+ * ```typescript
+ * const link = await generateTransferLink(client, {
+ *   to: '0xRecipientAddress',
+ *   amount: '100',
+ *   chain: someChain,
+ *   token: '0xTokenAddress'
+ * });
+ * console.log(link);
+ * ```
+ */
+export declare function generateTransferLink(client: ExtendedViemClient, params: GenerateTransferLinkParams): Promise<string>;
+//# sourceMappingURL=generateTransferLink.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"generateTransferLink.d.ts","sourceRoot":"","sources":["../../../src/actions/generateTransferLink.ts"],"names":[],"mappings":"AAWA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,aAAa,EAAE,MAAM,MAAM,CAAA;AAIrD,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,OAAO,EAEZ,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,kBAAkB,EACxB,MAAM,aAAa,CAAA;AAKpB,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,CAgCjB"}

package/dist/cjs/actions/generateTransferLink.js

@@ -0,0 +1,66 @@
+"use strict";
+// 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.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateTransferLink = generateTransferLink;
+const utils_1 = require("viem/utils");
+const getContract_js_1 = require("../providers/smart-contracts-platform/actions/getContract.js");
+const index_js_1 = require("../utils/index.js");
+const parseAddress_js_1 = require("../utils/parseAddress.js");
+const toERC681_js_1 = require("../utils/toERC681.js");
+/**
+ * Generates a ERC-681 transfer link for a specified recipient and amount.
+ *
+ * @param client - The client instance to use for the operation.
+ * @returns A promise that resolves to the generated transfer link.
+ *
+ * @throws Will throw an error if the contract read operation fails.
+ *
+ * @example
+ * ```typescript
+ * const link = await generateTransferLink(client, {
+ *   to: '0xRecipientAddress',
+ *   amount: '100',
+ *   chain: someChain,
+ *   token: '0xTokenAddress'
+ * });
+ * console.log(link);
+ * ```
+ */
+async function generateTransferLink(client, params) {
+    const { to, amount, chain = client.chain } = params;
+    const token = params.token != null ? (0, parseAddress_js_1.parseAddress)(params.token) : undefined;
+    const getContract = (0, utils_1.getAction)(client, getContract_js_1.getContract, 'getContract');
+    const toAccount = (0, index_js_1.parseAccount)(to);
+    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());
+    }
+    return tokenContract !== undefined
+        ? (0, toERC681_js_1.toERC681)({
+            abi: tokenContract.abi,
+            address: tokenContract.address,
+            functionName: 'transfer',
+            args: [toAccount.address, (0, index_js_1.parseUnits)(amount, tokenCurrencyDecimals)],
+            chainId: chain.id,
+        })
+        : (0, toERC681_js_1.toERC681)({
+            address: toAccount.address,
+            value: (0, index_js_1.parseUnits)(amount, nativeCurrencyDecimals),
+            chainId: chain.id,
+        });
+}
+//# sourceMappingURL=generateTransferLink.js.map

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

@@ -0,0 +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;;AAgDnF,oDAmCC;AAhFD,sCAAsC;AAEtC,iGAA0G;AAS1G,gDAA4D;AAC5D,8DAAuD;AACvD,sDAA+C;AAa/C;;;;;;;;;;;;;;;;;;GAkBG;AACI,KAAK,UAAU,oBAAoB,CACxC,MAA0B,EAC1B,MAAkC;IAElC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,MAAM,CAAA;IACnD,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,IAAA,8BAAY,EAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE3E,MAAM,WAAW,GAAG,IAAA,iBAAS,EAAC,MAAM,EAAE,4BAAY,EAAE,aAAa,CAAC,CAAA;IAElE,MAAM,SAAS,GAAG,IAAA,uBAAY,EAAC,EAAE,CAAC,CAAA;IAElC,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,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,IAAA,qBAAU,EAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;YACpE,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC;QACJ,CAAC,CAAC,IAAA,sBAAQ,EAAC;YACP,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,IAAA,qBAAU,EAAC,MAAM,EAAE,sBAAsB,CAAC;YACjD,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC,CAAA;AACR,CAAC"}

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

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

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

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