@circle-fin/usdckit 0.16.0 → 0.17.1

package/dist/esm/providers/cross-chain-transfer-protocol/actions/approve.test.js

@@ -0,0 +1,253 @@
+// 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, test, expect, vi, afterEach, it } from 'vitest';
+import { UnsupportedChainError } from '../../../errors/UnsupportedChainError.js';
+import { ETH_SEPOLIA, MATIC_AMOY } from '../chains/index.js';
+import { approve as action } from './approve.js';
+const client = {
+    chain: ETH_SEPOLIA,
+    getContract: vi.fn(),
+    simulateContract: vi.fn(),
+    writeContract: vi.fn(),
+};
+describe(`${action.name}`, () => {
+    vi.mock('viem', async (importOriginal) => ({
+        ...(await importOriginal()),
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        createPublicClient: vi.fn(({ chain }) => ({ ...client, chain })),
+    }));
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    test.each([
+        [
+            'explicit chain, account (string)',
+            {
+                token: MATIC_AMOY.contracts.USDC.address,
+                spender: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                value: 123n,
+                chain: MATIC_AMOY,
+                account: '0xmaticamoy',
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        chain: MATIC_AMOY,
+                    },
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: MATIC_AMOY.contracts.USDC.address,
+                            abi: [],
+                            functionName: 'approve',
+                            args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xmaticamoy',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                        chain: MATIC_AMOY,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+        [
+            'default chain, account (string)',
+            {
+                token: ETH_SEPOLIA.contracts.USDC.address,
+                spender: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                value: 123n,
+                account: '0xethsepolia',
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.USDC.address,
+                        chain: ETH_SEPOLIA,
+                    },
+                    {
+                        address: ETH_SEPOLIA.contracts.USDC.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [ETH_SEPOLIA.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xethsepolia',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: ETH_SEPOLIA.contracts.USDC.address,
+                            abi: [],
+                            functionName: 'approve',
+                            args: [ETH_SEPOLIA.contracts.tokenMessenger.address, 123n],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xethsepolia',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [ETH_SEPOLIA.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xethsepolia',
+                        }),
+                        chain: ETH_SEPOLIA,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+        [
+            'default chain, account (object with chain)',
+            {
+                token: MATIC_AMOY.contracts.USDC.address,
+                spender: MATIC_AMOY.contracts.tokenMessenger.address,
+                value: 123n,
+                account: { address: '0xmaticamoy', chain: MATIC_AMOY },
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        chain: MATIC_AMOY,
+                    },
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: MATIC_AMOY.contracts.USDC.address,
+                            abi: [],
+                            functionName: 'approve',
+                            args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xmaticamoy',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.USDC.address,
+                        abi: [],
+                        functionName: 'approve',
+                        args: [MATIC_AMOY.contracts.tokenMessenger.address, 123n],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                        chain: MATIC_AMOY,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+    ])('should execute successfully using %s', async (_, params, [getContract, simulateContract, writeContract], expectedResult) => {
+        client.getContract.mockResolvedValue(getContract[1]);
+        client.simulateContract.mockResolvedValue(simulateContract[1]);
+        client.writeContract.mockResolvedValue(writeContract[1]);
+        const result = await action(client, params);
+        expect(result).toEqual(expectedResult);
+        expect(client.getContract).toHaveBeenCalledWith(getContract[0]);
+        expect(client.simulateContract).toHaveBeenCalledWith(simulateContract[0]);
+        expect(client.writeContract).toHaveBeenCalledWith(writeContract[0]);
+    });
+    it('should throw UnsupportedChainError for unsupported chain', async () => {
+        await expect(action(client, {
+            token: MATIC_AMOY.contracts.USDC.address,
+            spender: ETH_SEPOLIA.contracts.tokenMessenger.address,
+            value: 123n,
+            account: '0xmaticamoy',
+            chain: { id: -1 },
+        })).rejects.toThrow(UnsupportedChainError);
+    });
+});
+//# sourceMappingURL=approve.test.js.map

package/dist/esm/providers/cross-chain-transfer-protocol/actions/approve.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"approve.test.js","sourceRoot":"","sources":["../../../../../src/providers/cross-chain-transfer-protocol/actions/approve.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,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AAElE,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAA;AAE5D,OAAO,EAAE,OAAO,IAAI,MAAM,EAAE,MAAM,cAAc,CAAA;AAKhD,MAAM,MAAM,GAAG;IACb,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,EAAE,CAAC,EAAE,EAAE;IACpB,gBAAgB,EAAE,EAAE,CAAC,EAAE,EAAE;IACzB,aAAa,EAAE,EAAE,CAAC,EAAE,EAAE;CACd,CAAA;AAEV,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC;QACzC,GAAG,CAAC,MAAM,cAAc,EAAE,CAAC;QAC3B,mEAAmE;QACnE,kBAAkB,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;KACjE,CAAC,CAAC,CAAA;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,eAAe,EAAE,CAAA;IACtB,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,IAAI,CAAC;QACR;YACE,kCAAkC;YAClC;gBACE,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;gBACxC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO;gBACrD,KAAK,EAAE,IAAI;gBACX,KAAK,EAAE,UAAU;gBACjB,OAAO,EAAE,aAAa;aACvB;YACD;gBACE,cAAc;gBACd;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,KAAK,EAAE,UAAU;qBAClB;oBACD;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;qBACR;iBACF;gBACD,mBAAmB;gBACnB;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBACzD,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,aAAa;yBACvB,CAAC;qBACH;oBACD;wBACE,OAAO,EAAE;4BACP,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;4BAC1C,GAAG,EAAE,EAAE;4BACP,YAAY,EAAE,SAAS;4BACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;4BACzD,GAAG,EAAE,SAAS;4BACd,mEAAmE;4BACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;gCAC/B,OAAO,EAAE,aAAa;6BACvB,CAAC;yBACH;wBACD,MAAM,EAAE,IAAI;qBACb;iBACF;gBACD,gBAAgB;gBAChB;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBACzD,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,aAAa;yBACvB,CAAC;wBACF,KAAK,EAAE,UAAU;qBAClB;oBACD,4CAA4C;iBAC7C;aACF;YACD,4CAA4C;SAC7C;QACD;YACE,iCAAiC;YACjC;gBACE,KAAK,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;gBACzC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO;gBACrD,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,cAAc;aACxB;YACD;gBACE,cAAc;gBACd;oBACE;wBACE,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC3C,KAAK,EAAE,WAAW;qBACnB;oBACD;wBACE,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC3C,GAAG,EAAE,EAAE;qBACR;iBACF;gBACD,mBAAmB;gBACnB;oBACE;wBACE,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC3C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBAC1D,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,cAAc;yBACxB,CAAC;qBACH;oBACD;wBACE,OAAO,EAAE;4BACP,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;4BAC3C,GAAG,EAAE,EAAE;4BACP,YAAY,EAAE,SAAS;4BACvB,IAAI,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;4BAC1D,GAAG,EAAE,SAAS;4BACd,mEAAmE;4BACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;gCAC/B,OAAO,EAAE,cAAc;6BACxB,CAAC;yBACH;wBACD,MAAM,EAAE,IAAI;qBACb;iBACF;gBACD,gBAAgB;gBAChB;oBACE;wBACE,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC3C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBAC1D,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,cAAc;yBACxB,CAAC;wBACF,KAAK,EAAE,WAAW;qBACnB;oBACD,4CAA4C;iBAC7C;aACF;YACD,4CAA4C;SAC7C;QACD;YACE,4CAA4C;YAC5C;gBACE,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;gBACxC,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO;gBACpD,KAAK,EAAE,IAAI;gBACX,OAAO,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE,KAAK,EAAE,UAAU,EAAwB;aAC7E;YACD;gBACE,cAAc;gBACd;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,KAAK,EAAE,UAAU;qBAClB;oBACD;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;qBACR;iBACF;gBACD,mBAAmB;gBACnB;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBACzD,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,aAAa;yBACvB,CAAC;qBACH;oBACD;wBACE,OAAO,EAAE;4BACP,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;4BAC1C,GAAG,EAAE,EAAE;4BACP,YAAY,EAAE,SAAS;4BACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;4BACzD,GAAG,EAAE,SAAS;4BACd,mEAAmE;4BACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;gCAC/B,OAAO,EAAE,aAAa;6BACvB,CAAC;yBACH;wBACD,MAAM,EAAE,IAAI;qBACb;iBACF;gBACD,gBAAgB;gBAChB;oBACE;wBACE,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;wBAC1C,GAAG,EAAE,EAAE;wBACP,YAAY,EAAE,SAAS;wBACvB,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC;wBACzD,GAAG,EAAE,SAAS;wBACd,mEAAmE;wBACnE,OAAO,EAAE,MAAM,CAAC,gBAAgB,CAAC;4BAC/B,OAAO,EAAE,aAAa;yBACvB,CAAC;wBACF,KAAK,EAAE,UAAU;qBAClB;oBACD,4CAA4C;iBAC7C;aACF;YACD,4CAA4C;SAC7C;KACO,CAAC,CACT,sCAAsC,EACtC,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,WAAW,EAAE,gBAAgB,EAAE,aAAa,CAAC,EAAE,cAAc,EAAE,EAAE;QAClF,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QACpD,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9D,MAAM,CAAC,aAAa,CAAC,iBAAiB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;QAExD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAuC,EAAE,MAAM,CAAC,CAAA;QAE5E,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAA;QAEtC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QAC/D,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAA;QACzE,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IACrE,CAAC,CACF,CAAA;IAED,EAAE,CAAC,0DAA0D,EAAE,KAAK,IAAI,EAAE;QACxE,MAAM,MAAM,CACV,MAAM,CAAC,MAAuC,EAAE;YAC9C,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO;YACxC,OAAO,EAAE,WAAW,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO;YACrD,KAAK,EAAE,IAAI;YACX,OAAO,EAAE,aAAa;YACtB,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAW;SAC3B,CAAC,CACH,CAAC,OAAO,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAA;IAC1C,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.d.ts

@@ -0,0 +1,28 @@
+import type { Account, Address, BaseUnits, ControlFlowOptions, ExtendedViemClient, NativeUnits } from '../../../types.js';
+import type { Chain, ChainContract, FeeValuesEIP1559 } from 'viem';
+export type DepositForBurnParams = {
+    /** The amount to be deposited. */
+    amount: BaseUnits | NativeUnits;
+    /** The domain of the destination chain. */
+    destinationDomain: number;
+    /** The address of the account or contract that will receive the minted tokens. */
+    mintRecipient: Address;
+    /** The address of the token to be burned */
+    burnToken: Address | ChainContract;
+    /** The blockchain network on which the transaction will be executed. */
+    chain?: Chain;
+    /** The address or account that will execute the transaction. */
+    account: Address | Account;
+    /** The gas limit for the transaction. */
+    gas?: bigint;
+    /** The fee values for the transaction */
+    fees?: FeeValuesEIP1559;
+};
+/**
+ * Executes the `depositForBurn` function of the Token Messenger contract for CCTP.
+ *
+ * @param client - The client instance to use for the operation.
+ * @returns Returns the transaction hash of the contract execution
+ */
+export declare function depositForBurn(client: ExtendedViemClient, params: DepositForBurnParams & ControlFlowOptions): Promise<Address>;
+//# sourceMappingURL=depositForBurn.d.ts.map

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"depositForBurn.d.ts","sourceRoot":"","sources":["../../../../../src/providers/cross-chain-transfer-protocol/actions/depositForBurn.ts"],"names":[],"mappings":"AAwBA,OAAO,KAAK,EACV,OAAO,EACP,OAAO,EACP,SAAS,EACT,kBAAkB,EAClB,kBAAkB,EAClB,WAAW,EACZ,MAAM,mBAAmB,CAAA;AAC1B,OAAO,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,MAAM,CAAA;AAElE,MAAM,MAAM,oBAAoB,GAAG;IACjC,kCAAkC;IAClC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAA;IAC/B,2CAA2C;IAC3C,iBAAiB,EAAE,MAAM,CAAA;IACzB,kFAAkF;IAClF,aAAa,EAAE,OAAO,CAAA;IACtB,4CAA4C;IAC5C,SAAS,EAAE,OAAO,GAAG,aAAa,CAAA;IAClC,wEAAwE;IACxE,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,gEAAgE;IAChE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAA;IAC1B,yCAAyC;IACzC,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,yCAAyC;IACzC,IAAI,CAAC,EAAE,gBAAgB,CAAA;CACxB,CAAA;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAClC,MAAM,EAAE,kBAAkB,EAC1B,MAAM,EAAE,oBAAoB,GAAG,kBAAkB,GAChD,OAAO,CAAC,OAAO,CAAC,CAgDlB"}

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.js

@@ -0,0 +1,58 @@
+// 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 { createPublicClient, http } from 'viem';
+import { simulateContract as _simulateContract } from 'viem/actions';
+import { getAction, pad } from 'viem/utils';
+import { UnsupportedChainError } from '../../../errors/UnsupportedChainError.js';
+import { parseAccount } from '../../../utils/parseAccount.js';
+import { parseAddress } from '../../../utils/parseAddress.js';
+import { parseUnits } from '../../../utils/parseUnits.js';
+import { raise } from '../../../utils/raise.js';
+import { writeContract as _writeContract } from '../../smart-contract-platform/actions/writeContract.js';
+import { getContract as _getContract } from '../../smart-contract-platform/index.js';
+import { extractChain } from '../extractChain.js';
+/**
+ * Executes the `depositForBurn` function of the Token Messenger contract for CCTP.
+ *
+ * @param client - The client instance to use for the operation.
+ * @returns Returns the transaction hash of the contract execution
+ */
+export async function depositForBurn(client, params) {
+    const { amount: _amount, destinationDomain, mintRecipient, burnToken: _burnToken, chain: _chain, account: _account, gas, fees, } = params;
+    const account = parseAccount(_account);
+    const chain = extractChain(_chain ?? account.chain ?? client.chain) ?? raise(new UnsupportedChainError());
+    const burnToken = { chain: chain, ...parseAddress(_burnToken) };
+    const getContract = getAction(client, _getContract, 'getContract');
+    // HACK: `simulateContract` does not support `chain` parameter
+    const simulateContract = getAction(createPublicClient({
+        chain,
+        transport: http(),
+    }), _simulateContract, 'simulateContract');
+    const writeContract = getAction(client, _writeContract, 'writeContract');
+    const contract = await getContract({
+        address: chain.contracts.tokenMessenger.address,
+        chain,
+    });
+    // @ts-expect-error: Ignore ts(2331) for `read` property
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
+    const amount = typeof _amount === 'string' ? parseUnits(_amount, (await contract.read.decimals())) : _amount;
+    const { request } = await simulateContract({
+        address: contract.address,
+        abi: contract.abi,
+        functionName: 'depositForBurn',
+        args: [amount, destinationDomain, pad(mintRecipient), burnToken.address],
+        account,
+        gas,
+        ...fees,
+    });
+    return await writeContract({ ...request, chain, signal: params.signal });
+}
+//# sourceMappingURL=depositForBurn.js.map

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"depositForBurn.js","sourceRoot":"","sources":["../../../../../src/providers/cross-chain-transfer-protocol/actions/depositForBurn.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,kBAAkB,EAAE,IAAI,EAAE,MAAM,MAAM,CAAA;AAC/C,OAAO,EAAE,gBAAgB,IAAI,iBAAiB,EAAE,MAAM,cAAc,CAAA;AACpE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,MAAM,YAAY,CAAA;AAE3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,0CAA0C,CAAA;AAChF,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAA;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAC/C,OAAO,EAAE,aAAa,IAAI,cAAc,EAAE,MAAM,wDAAwD,CAAA;AACxG,OAAO,EAAE,WAAW,IAAI,YAAY,EAAE,MAAM,wCAAwC,CAAA;AACpF,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AA+BjD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAA0B,EAC1B,MAAiD;IAEjD,MAAM,EACJ,MAAM,EAAE,OAAO,EACf,iBAAiB,EACjB,aAAa,EACb,SAAS,EAAE,UAAU,EACrB,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,QAAQ,EACjB,GAAG,EACH,IAAI,GACL,GAAG,MAAM,CAAA;IAEV,MAAM,OAAO,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAA;IACtC,MAAM,KAAK,GAAG,YAAY,CAAC,MAAM,IAAI,OAAO,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,qBAAqB,EAAE,CAAC,CAAA;IACzG,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,YAAY,CAAC,UAAU,CAAC,EAAE,CAAA;IAE/D,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC,CAAA;IAClE,8DAA8D;IAC9D,MAAM,gBAAgB,GAAG,SAAS,CAChC,kBAAkB,CAAC;QACjB,KAAK;QACL,SAAS,EAAE,IAAI,EAAE;KAClB,CAAC,EACF,iBAAiB,EACjB,kBAAkB,CACnB,CAAA;IACD,MAAM,aAAa,GAAG,SAAS,CAAC,MAAM,EAAE,cAAc,EAAE,eAAe,CAAC,CAAA;IAExE,MAAM,QAAQ,GAAG,MAAM,WAAW,CAAC;QACjC,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO;QAC/C,KAAK;KACN,CAAC,CAAA;IAEF,wDAAwD;IACxD,yGAAyG;IACzG,MAAM,MAAM,GAAG,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAW,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;IAEtH,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,gBAAgB,CAAC;QACzC,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,YAAY,EAAE,gBAAgB;QAC9B,IAAI,EAAE,CAAC,MAAM,EAAE,iBAAiB,EAAE,GAAG,CAAC,aAAa,CAAC,EAAE,SAAS,CAAC,OAAO,CAAC;QACxE,OAAO;QACP,GAAG;QACH,GAAG,IAAI;KACR,CAAC,CAAA;IAEF,OAAO,MAAM,aAAa,CAAC,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAA;AAC1E,CAAC"}

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.test.d.ts

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

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.test.d.ts.map

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

package/dist/esm/providers/cross-chain-transfer-protocol/actions/depositForBurn.test.js

@@ -0,0 +1,292 @@
+// 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, test, expect, vi, afterEach, it } from 'vitest';
+import { UnsupportedChainError } from '../../../errors/UnsupportedChainError.js';
+import { ETH_SEPOLIA, MATIC_AMOY } from '../chains/index.js';
+import { depositForBurn as action } from './depositForBurn.js';
+const client = {
+    chain: ETH_SEPOLIA,
+    getContract: vi.fn(),
+    simulateContract: vi.fn(),
+    writeContract: vi.fn(),
+};
+describe(`${action.name}`, () => {
+    vi.mock('viem', async (importOriginal) => ({
+        ...(await importOriginal()),
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        createPublicClient: vi.fn(({ chain }) => ({ ...client, chain })),
+    }));
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    test.each([
+        [
+            'explicit chain, account (string)',
+            {
+                amount: 123n,
+                destinationDomain: ETH_SEPOLIA.domainId,
+                mintRecipient: '0xethsepolia',
+                burnToken: MATIC_AMOY.contracts.USDC.address,
+                chain: MATIC_AMOY,
+                account: '0xmaticamoy',
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        chain: MATIC_AMOY,
+                    },
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [
+                            123n,
+                            ETH_SEPOLIA.domainId,
+                            '0x000000000000000000000000000000000000000000000000000000ethsepolia',
+                            MATIC_AMOY.contracts.USDC.address,
+                        ],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: MATIC_AMOY.contracts.tokenMessenger.address,
+                            abi: [],
+                            functionName: 'depositForBurn',
+                            args: [
+                                123n,
+                                ETH_SEPOLIA.domainId,
+                                '0x000000000000000000000000000000000000000000000000000000ethsepolia',
+                                MATIC_AMOY.contracts.USDC.address,
+                            ],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xmaticamoy',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [
+                            123n,
+                            ETH_SEPOLIA.domainId,
+                            '0x000000000000000000000000000000000000000000000000000000ethsepolia',
+                            MATIC_AMOY.contracts.USDC.address,
+                        ],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                        chain: MATIC_AMOY,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+        [
+            'default chain, account (string)',
+            {
+                amount: 123n,
+                destinationDomain: MATIC_AMOY.domainId,
+                mintRecipient: '0xmaticamoy',
+                burnToken: ETH_SEPOLIA.contracts.USDC.address,
+                account: '0xethsepolia',
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                        chain: ETH_SEPOLIA,
+                    },
+                    {
+                        address: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [
+                            123n,
+                            MATIC_AMOY.domainId,
+                            '0x0000000000000000000000000000000000000000000000000000000maticamoy',
+                            ETH_SEPOLIA.contracts.USDC.address,
+                        ],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xethsepolia',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                            abi: [],
+                            functionName: 'depositForBurn',
+                            args: [
+                                123n,
+                                MATIC_AMOY.domainId,
+                                '0x0000000000000000000000000000000000000000000000000000000maticamoy',
+                                ETH_SEPOLIA.contracts.USDC.address,
+                            ],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xethsepolia',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: ETH_SEPOLIA.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [
+                            123n,
+                            MATIC_AMOY.domainId,
+                            '0x0000000000000000000000000000000000000000000000000000000maticamoy',
+                            ETH_SEPOLIA.contracts.USDC.address,
+                        ],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xethsepolia',
+                        }),
+                        chain: ETH_SEPOLIA,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+        [
+            'default chain, account (object with chain)',
+            {
+                amount: 123n,
+                destinationDomain: ETH_SEPOLIA.domainId,
+                mintRecipient: '0xethsepolia',
+                burnToken: MATIC_AMOY.contracts.USDC.address,
+                account: { address: '0xmaticamoy', chain: MATIC_AMOY },
+            },
+            [
+                // getContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        chain: MATIC_AMOY,
+                    },
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                    },
+                ],
+                // simulateContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [
+                            123n,
+                            ETH_SEPOLIA.domainId,
+                            '0x000000000000000000000000000000000000000000000000000000ethsepolia',
+                            MATIC_AMOY.contracts.USDC.address,
+                        ],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                    },
+                    {
+                        request: {
+                            address: MATIC_AMOY.contracts.tokenMessenger.address,
+                            abi: [],
+                            functionName: 'depositForBurn',
+                            args: [123n, ETH_SEPOLIA.domainId, '0xethsepolia', MATIC_AMOY.contracts.USDC.address],
+                            gas: undefined,
+                            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                            account: expect.objectContaining({
+                                address: '0xmaticamoy',
+                            }),
+                        },
+                        result: true,
+                    },
+                ],
+                // writeContract
+                [
+                    {
+                        address: MATIC_AMOY.contracts.tokenMessenger.address,
+                        abi: [],
+                        functionName: 'depositForBurn',
+                        args: [123n, ETH_SEPOLIA.domainId, '0xethsepolia', MATIC_AMOY.contracts.USDC.address],
+                        gas: undefined,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({
+                            address: '0xmaticamoy',
+                        }),
+                        chain: MATIC_AMOY,
+                    },
+                    '0x0000000000000000000000000000000000000001',
+                ],
+            ],
+            '0x0000000000000000000000000000000000000001',
+        ],
+    ])('should execute successfully using %s', async (_, params, [getContract, simulateContract, writeContract], expectedResult) => {
+        client.getContract.mockResolvedValue(getContract[1]);
+        client.simulateContract.mockResolvedValue(simulateContract[1]);
+        client.writeContract.mockResolvedValue(writeContract[1]);
+        const result = await action(client, params);
+        expect(result).toEqual(expectedResult);
+        expect(client.getContract).toHaveBeenCalledWith(getContract[0]);
+        expect(client.simulateContract).toHaveBeenCalledWith(simulateContract[0]);
+        expect(client.writeContract).toHaveBeenCalledWith(writeContract[0]);
+    });
+    it('should throw UnsupportedChainError for unsupported chain', async () => {
+        await expect(action(client, {
+            amount: 123n,
+            destinationDomain: ETH_SEPOLIA.domainId,
+            mintRecipient: '0xethsepolia',
+            burnToken: MATIC_AMOY.contracts.USDC.address,
+            account: '0xmaticamoy',
+            chain: { id: -1 },
+        })).rejects.toThrow(UnsupportedChainError);
+    });
+});
+//# sourceMappingURL=depositForBurn.test.js.map