@circle-fin/usdckit 0.11.1

package/dist/esm/actions/generateTransferLink.js

@@ -0,0 +1,63 @@
+// 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 { getAction } from 'viem/utils';
+import { getContract as _getContract } from '../providers/smart-contracts-platform/actions/getContract.js';
+import { parseAccount, parseUnits } from '../utils/index.js';
+import { parseAddress } from '../utils/parseAddress.js';
+import { toERC681 } from '../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);
+ * ```
+ */
+export async function generateTransferLink(client, params) {
+    const { to, amount, chain = client.chain } = params;
+    const token = params.token != null ? parseAddress(params.token) : undefined;
+    const getContract = getAction(client, _getContract, 'getContract');
+    const toAccount = 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
+        ? toERC681({
+            abi: tokenContract.abi,
+            address: tokenContract.address,
+            functionName: 'transfer',
+            args: [toAccount.address, parseUnits(amount, tokenCurrencyDecimals)],
+            chainId: chain.id,
+        })
+        : toERC681({
+            address: toAccount.address,
+            value: parseUnits(amount, nativeCurrencyDecimals),
+            chainId: chain.id,
+        });
+}
+//# sourceMappingURL=generateTransferLink.js.map

package/dist/esm/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;AAGnF,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAEtC,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,8DAA8D,CAAA;AAS1G,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAA;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAA;AAa/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,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,YAAY,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;IAE3E,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC,CAAA;IAElE,MAAM,SAAS,GAAG,YAAY,CAAC,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,QAAQ,CAAC;YACP,GAAG,EAAE,aAAa,CAAC,GAAG;YACtB,OAAO,EAAE,aAAa,CAAC,OAAO;YAC9B,YAAY,EAAE,UAAU;YACxB,IAAI,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;YACpE,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC;QACJ,CAAC,CAAC,QAAQ,CAAC;YACP,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,KAAK,EAAE,UAAU,CAAC,MAAM,EAAE,sBAAsB,CAAC;YACjD,OAAO,EAAE,KAAK,CAAC,EAAE;SAClB,CAAC,CAAA;AACR,CAAC"}

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

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

package/dist/esm/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":""}

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

@@ -0,0 +1,87 @@
+// 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 { expect, test, describe, vi } from 'vitest';
+import { ETH_SEPOLIA } from '../chains/index.js';
+import { generateTransferLink } from './generateTransferLink.js';
+describe.concurrent('generateTransferLink', () => {
+    const client = {
+        chain: ETH_SEPOLIA,
+        getContract: vi.fn(({ address }) => ({
+            address,
+            read: {
+                decimals: 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',
+                },
+            ],
+        })),
+    };
+    test.each([
+        [
+            {
+                to: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
+                amount: 100000n,
+                token: ETH_SEPOLIA.contracts.USDC,
+                chain: ETH_SEPOLIA,
+            },
+            'ethereum:0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238@11155111/transfer?address=0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238&uint256=100000',
+        ],
+        [
+            {
+                to: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
+                amount: '12.25',
+                token: ETH_SEPOLIA.contracts.USDC,
+                chain: ETH_SEPOLIA,
+            },
+            'ethereum:0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238@11155111/transfer?address=0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238&uint256=12250000',
+        ],
+        [
+            {
+                to: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
+                amount: 1n,
+            },
+            'ethereum:0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238@11155111?value=1',
+        ],
+        [
+            {
+                to: '0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238',
+                amount: '1',
+            },
+            'ethereum:0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238@11155111?value=1000000000000000000',
+        ],
+    ])('return a valid URL', async (params, expectedResult) => {
+        await expect(generateTransferLink(client, params)).resolves.toBe(expectedResult);
+    });
+});
+//# sourceMappingURL=generateTransferLink.test.js.map

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

@@ -0,0 +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,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAEnD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAIhE,QAAQ,CAAC,UAAU,CAAC,sBAAsB,EAAE,GAAG,EAAE;IAC/C,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,WAAW;QAClB,WAAW,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,EAAuB,EAAE,EAAE,CAAC,CAAC;YACxD,OAAO;YACP,IAAI,EAAE;gBACJ,QAAQ,EAAE,EAAE,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,IAAI,CAAC,IAAI,CAAC;QACR;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,WAAW;aACnB;YACD,yIAAyI;SAC1I;QACD;YACE;gBACE,EAAE,EAAE,4CAA4C;gBAChD,MAAM,EAAE,OAAO;gBACf,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI;gBACjC,KAAK,EAAE,WAAW;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,MAAM,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;IAClF,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,40 @@
+import { drainFrom } from './drainFrom.js';
+import { generateTransferLink } from './generateTransferLink.js';
+import { transfer } from './transfer.js';
+import type { Account } from '../types.js';
+import type { DrainFromParams } from './drainFrom.js';
+import type { GenerateTransferLinkParams } from './generateTransferLink.js';
+import type { TransferParams } from './transfer.js';
+import type { Chain, Client, Transport } from 'viem';
+export * from './transfer.js';
+export * from './drainFrom.js';
+export * from './generateTransferLink.js';
+export type Actions<transport extends Transport = Transport, chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
+    transfer: (params: Parameters<typeof transfer>[1]) => ReturnType<typeof transfer>;
+    drainFrom: (params: Parameters<typeof drainFrom>[1]) => ReturnType<typeof drainFrom>;
+    generateTransferLink: (params: Parameters<typeof generateTransferLink>[1]) => ReturnType<typeof generateTransferLink>;
+};
+/**
+ * Returns an object containing action functions bound to the provided client.
+ *
+ * @param client - The client instance to bind the actions to.
+ * @returns An object containing the bound action functions.
+ */
+export declare function actions(client: Client): {
+    /**
+     * Drains all tokens of a specified type from given accounts.
+     *
+     * @param params - Parameters for the drain operation.
+     * @returns An array of transfer results.
+     */
+    drainFrom: (params: DrainFromParams) => Promise<import("./transfer.js").TransferReturnType>;
+    /**
+     * Transfers tokens or native currency from one account to another.
+     *
+     * @param params - The transfer parameters.
+     * @returns An array of transfer return types containing transaction hashes.
+     */
+    transfer: (params: TransferParams) => Promise<import("./transfer.js").TransferReturnType>;
+    generateTransferLink: (params: GenerateTransferLinkParams) => Promise<string>;
+};
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +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,QAAQ,EAAE,MAAM,eAAe,CAAA;AAExC,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;AAGzC,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,QAAQ,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAA;IACjF,SAAS,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,SAAS,CAAC,CAAA;IACpF,oBAAoB,EAAE,CAAC,MAAM,EAAE,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAA;CACtH,CAAA;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,MAAM;IAElC;;;;;OAKG;wBACiB,eAAe;IAEnC;;;;;OAKG;uBACgB,cAAc;mCACF,0BAA0B;EAG5D"}

package/dist/esm/actions/index.js

@@ -0,0 +1,42 @@
+// 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 { drainFrom } from './drainFrom.js';
+import { generateTransferLink } from './generateTransferLink.js';
+import { transfer } from './transfer.js';
+export * from './transfer.js';
+export * from './drainFrom.js';
+export * from './generateTransferLink.js';
+/**
+ * Returns an object containing action functions bound to the provided client.
+ *
+ * @param client - The client instance to bind the actions to.
+ * @returns An object containing the bound action functions.
+ */
+export function actions(client) {
+    return {
+        /**
+         * Drains all tokens of a specified type from given accounts.
+         *
+         * @param params - Parameters for the drain operation.
+         * @returns An array of transfer results.
+         */
+        drainFrom: (params) => drainFrom(client, params),
+        /**
+         * Transfers tokens or native currency from one account to another.
+         *
+         * @param params - The transfer parameters.
+         * @returns An array of transfer return types containing transaction hashes.
+         */
+        transfer: (params) => transfer(client, params),
+        generateTransferLink: (params) => generateTransferLink(client, params),
+    };
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +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;AAEnF,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAA;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAQxC,cAAc,eAAe,CAAA;AAC7B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,2BAA2B,CAAA;AAgBzC;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,MAAc;IACpC,OAAO;QACL;;;;;WAKG;QACH,SAAS,EAAE,CAAC,MAAuB,EAAE,EAAE,CAAC,SAAS,CAAC,MAA4B,EAAE,MAAM,CAAC;QAEvF;;;;;WAKG;QACH,QAAQ,EAAE,CAAC,MAAsB,EAAE,EAAE,CAAC,QAAQ,CAAC,MAA4B,EAAE,MAAM,CAAC;QACpF,oBAAoB,EAAE,CAAC,MAAkC,EAAE,EAAE,CAC3D,oBAAoB,CAAC,MAA4B,EAAE,MAAM,CAAC;KAC7D,CAAA;AACH,CAAC"}

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

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

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

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

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

@@ -0,0 +1,30 @@
+// 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 } from 'vitest';
+import { actions } from './index.js';
+describe.concurrent('actions', () => {
+    const client = {};
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    it('should return an object with the expected methods', () => {
+        const result = actions(client);
+        expect(result).toEqual({
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            drainFrom: expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            generateTransferLink: expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            transfer: expect.any(Function),
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

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

@@ -0,0 +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,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAE5D,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAA;AAIpC,QAAQ,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,EAAE;IAClC,MAAM,MAAM,GAAG,EAAE,CAAA;IAEjB,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,eAAe,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,MAAM,GAAG,OAAO,CAAC,MAA2B,CAAC,CAAA;QAEnD,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB,mEAAmE;YACnE,SAAS,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC/B,mEAAmE;YACnE,oBAAoB,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAC1C,mEAAmE;YACnE,QAAQ,EAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;SAC/B,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,151 @@
+import { type Account, type Address, type Contract, type NativeUnits, type BaseUnits, type FeeValuesEIP1559, type Merge, type ExtendedViemClient } from '../types.js';
+import type { Client, Chain, ChainContract } from 'viem';
+/**
+ * Parameters for the {@link transfer} function.
+ */
+export type TransferParams = {
+    /**
+     * The sender's address or account. Can be a single address/account or an array of addresses/accounts.
+     * */
+    from?: Address | Account | (Address | Account)[];
+    /**
+     * The recipient's address or account.
+     * */
+    to: Address | Account;
+    /**
+     * The amount to be transferred. Can be specified directly or as a function that returns a promise resolving to the amount.
+     * */
+    amount: NativeUnits | BaseUnits | ((account: Account) => Promise<NativeUnits | BaseUnits>);
+    /**
+     * The address of the token or chain contract, if applicable.
+     * */
+    token?: Address | ChainContract | null;
+    /**
+     * The gas limit for the transaction.
+     * */
+    gas?: bigint;
+    /**
+     * The fee values for the transaction. Can be specified directly or as a function that returns a promise resolving to the fee values.
+     * */
+    fees?: FeeValuesEIP1559 | ((params: EstimateFeesPerGasParams) => Promise<FeeValuesEIP1559>);
+    /**
+     * The blockchain network on which the transaction will be executed.
+     * */
+    chain?: Chain;
+};
+/**
+ * Return type for the transfer function.
+ */
+export type TransferReturnType = {
+    /** Transaction Hash */
+    hash: Address;
+}[];
+/**
+ * Parameters for estimating fees per gas.
+ */
+export type EstimateFeesPerGasParams = {
+    client: Client;
+    request: {
+        from: Account;
+        to: Account;
+        token?: Contract;
+        amount: BaseUnits;
+        chain: Chain;
+    };
+};
+/**
+ * Estimates the fee levels for a transfer.
+ * @param level - The fee level
+ * @returns A function that estimates the fees for a transfer request.
+ */
+export declare function FEE_LEVEL(level: 'LOW' | 'MEDIUM' | 'HIGH'): ({ client, request: { from, to, token, amount, chain }, }: EstimateFeesPerGasParams) => Promise<Merge<FeeValuesEIP1559, {
+    gas: BaseUnits;
+}>>;
+/**
+ * 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 declare function FEE_LEVEL_WITH_PREPARE({ account, level }: {
+    account: Account;
+    level: 'LOW' | 'MEDIUM' | 'HIGH';
+}): ({ client, request }: EstimateFeesPerGasParams) => Promise<{
+    gasPrice?: undefined | undefined;
+    maxFeePerBlobGas?: undefined | undefined;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    gas: BaseUnits;
+}>;
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `LOW` fee level settings for transfer fee estimation.
+ */
+export declare const LOW: ({ client, request: { from, to, token, amount, chain }, }: EstimateFeesPerGasParams) => Promise<Merge<FeeValuesEIP1559, {
+    gas: BaseUnits;
+}>>;
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `MEDIUM` fee level settings for transfer fee estimation.
+ */
+export declare const MEDIUM: ({ client, request: { from, to, token, amount, chain }, }: EstimateFeesPerGasParams) => Promise<Merge<FeeValuesEIP1559, {
+    gas: BaseUnits;
+}>>;
+/**
+ * Pre-configured fee level estimation function.
+ * Uses the `HIGH` fee level settings for transfer fee estimation.
+ */
+export declare const HIGH: ({ client, request: { from, to, token, amount, chain }, }: EstimateFeesPerGasParams) => Promise<Merge<FeeValuesEIP1559, {
+    gas: BaseUnits;
+}>>;
+/**
+ * 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 declare function transfer(client: ExtendedViemClient, params: TransferParams): Promise<TransferReturnType>;
+//# sourceMappingURL=transfer.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"transfer.d.ts","sourceRoot":"","sources":["../../../src/actions/transfer.ts"],"names":[],"mappings":"AAqBA,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,KAAK,EACV,KAAK,kBAAkB,EACxB,MAAM,aAAa,CAAA;AAMpB,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,MAAM,CAAA;AAExD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;SAEK;IACL,IAAI,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,CAAC,OAAO,GAAG,OAAO,CAAC,EAAE,CAAA;IAChD;;SAEK;IACL,EAAE,EAAE,OAAO,GAAG,OAAO,CAAA;IACrB;;SAEK;IACL,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC,CAAC,CAAA;IAC1F;;SAEK;IACL,KAAK,CAAC,EAAE,OAAO,GAAG,aAAa,GAAG,IAAI,CAAA;IACtC;;SAEK;IACL,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;SAEK;IACL,IAAI,CAAC,EAAE,gBAAgB,GAAG,CAAC,CAAC,MAAM,EAAE,wBAAwB,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAA;IAC3F;;SAEK;IACL,KAAK,CAAC,EAAE,KAAK,CAAA;CACd,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,uBAAuB;IACvB,IAAI,EAAE,OAAO,CAAA;CACd,EAAE,CAAA;AAEH;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IAErC,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE;QACP,IAAI,EAAE,OAAO,CAAA;QACb,EAAE,EAAE,OAAO,CAAA;QACX,KAAK,CAAC,EAAE,QAAQ,CAAA;QAChB,MAAM,EAAE,SAAS,CAAA;QACjB,KAAK,EAAE,KAAK,CAAA;KACb,CAAA;CACF,CAAA;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,IAC1C,0DAGX,wBAAwB,KAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE;IAAE,GAAG,EAAE,SAAS,CAAA;CAAE,CAAC,CAAC,CAuBnF;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;IAAE,OAAO,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAA;CAAE,IACjG,qBAAqB,wBAAwB;;;;;SA/BU,SAAS;GA2D/E;AAED;;;GAGG;AACH,eAAO,MAAM,GAAG,6DAjEX,wBAAwB,KAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE;IAAE,GAAG,EAAE,SAAS,CAAA;CAAE,CAAC,CAiEhD,CAAA;AAEnC;;;GAGG;AACH,eAAO,MAAM,MAAM,6DAvEd,wBAAwB,KAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE;IAAE,GAAG,EAAE,SAAS,CAAA;CAAE,CAAC,CAuE1C,CAAA;AAEzC;;;GAGG;AACH,eAAO,MAAM,IAAI,6DA7EZ,wBAAwB,KAAG,OAAO,CAAC,KAAK,CAAC,gBAAgB,EAAE;IAAE,GAAG,EAAE,SAAS,CAAA;CAAE,CAAC,CA6E9C,CAAA;AAarC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,wBAAsB,QAAQ,CAAC,MAAM,EAAE,kBAAkB,EAAE,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAiF9G"}