@circle-fin/usdckit 0.21.1 → 0.23.0

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

@@ -0,0 +1,650 @@
+// 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 { maxUint256 } from 'viem';
+import { getAction } from 'viem/utils';
+import { describe, expect, vi, beforeEach, test } from 'vitest';
+import { ETH_SEPOLIA } from '../chains/index.js';
+import { permit as action } from './permit.js';
+import { signEIP2612Permit } from './signEIP2612Permit.js';
+const client = {
+    chain: ETH_SEPOLIA,
+};
+const account = '0x1234567890abcdef1234567890abcdef12345678';
+const spender = '0x8765432109876543210987654321098765432109';
+const tokenAddress = ETH_SEPOLIA.contracts.USDC.address;
+vi.mock('viem', async (importOriginal) => ({
+    ...(await importOriginal()),
+    createPublicClient: vi.fn(() => ({
+        simulateContract: vi.fn().mockResolvedValue({
+            request: {
+                address: tokenAddress,
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                abi: expect.any(Array),
+                functionName: 'permit',
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                args: expect.any(Array),
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                account: expect.objectContaining({ address: account }),
+            },
+        }),
+    })),
+    http: vi.fn(() => ({})),
+}));
+vi.mock('viem/utils', () => ({
+    getAction: vi.fn(),
+}));
+vi.mock('./signEIP2612Permit.js', () => ({
+    signEIP2612Permit: vi.fn(),
+}));
+describe(`${action.name}`, () => {
+    beforeEach(() => {
+        vi.restoreAllMocks();
+    });
+    test.each([
+        [
+            // Basic permit with NativeUnits
+            {
+                token: tokenAddress,
+                owner: account,
+                spender,
+                value: '1.0',
+            },
+            '0xpermitTransactionHash',
+            // signEIP2612Permit call
+            [
+                {
+                    token: tokenAddress,
+                    owner: account,
+                    spender,
+                    value: '1.0',
+                },
+                {
+                    typedData: {
+                        types: {
+                            EIP712Domain: [
+                                { name: 'name', type: 'string' },
+                                { name: 'version', type: 'string' },
+                                { name: 'chainId', type: 'uint256' },
+                                { name: 'verifyingContract', type: 'address' },
+                            ],
+                            Permit: [
+                                { name: 'owner', type: 'address' },
+                                { name: 'spender', type: 'address' },
+                                { name: 'value', type: 'uint256' },
+                                { name: 'nonce', type: 'uint256' },
+                                { name: 'deadline', type: 'uint256' },
+                            ],
+                        },
+                        primaryType: 'Permit',
+                        domain: {
+                            name: 'USD Coin',
+                            version: '2',
+                            chainId: BigInt(ETH_SEPOLIA.id),
+                            verifyingContract: tokenAddress,
+                        },
+                        message: {
+                            owner: account,
+                            spender,
+                            value: 1000000n,
+                            nonce: 321n,
+                            deadline: maxUint256,
+                        },
+                    },
+                    signature: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                    v: 27,
+                    r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    s: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    yParity: 0,
+                },
+            ],
+            // simulateContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    args: [
+                        account,
+                        spender,
+                        1000000n,
+                        maxUint256,
+                        27,
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    ],
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    gas: undefined,
+                },
+                {
+                    request: {
+                        address: tokenAddress,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        abi: expect.any(Array),
+                        functionName: 'permit',
+                        args: [
+                            account,
+                            spender,
+                            1000000n,
+                            maxUint256,
+                            27,
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        ],
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({ address: account }),
+                    },
+                },
+            ],
+            // writeContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    args: expect.any(Array),
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    chain: ETH_SEPOLIA,
+                },
+                '0xpermitTransactionHash',
+            ],
+        ],
+        [
+            // Permit with BaseUnits
+            {
+                token: tokenAddress,
+                owner: account,
+                spender,
+                value: 1000000n,
+            },
+            '0xpermitTransactionHash',
+            // signEIP2612Permit call
+            [
+                {
+                    token: tokenAddress,
+                    owner: account,
+                    spender,
+                    value: 1000000n,
+                },
+                {
+                    typedData: {
+                        types: {
+                            EIP712Domain: [
+                                { name: 'name', type: 'string' },
+                                { name: 'version', type: 'string' },
+                                { name: 'chainId', type: 'uint256' },
+                                { name: 'verifyingContract', type: 'address' },
+                            ],
+                            Permit: [
+                                { name: 'owner', type: 'address' },
+                                { name: 'spender', type: 'address' },
+                                { name: 'value', type: 'uint256' },
+                                { name: 'nonce', type: 'uint256' },
+                                { name: 'deadline', type: 'uint256' },
+                            ],
+                        },
+                        primaryType: 'Permit',
+                        domain: {
+                            name: 'USD Coin',
+                            version: '2',
+                            chainId: BigInt(ETH_SEPOLIA.id),
+                            verifyingContract: tokenAddress,
+                        },
+                        message: {
+                            owner: account,
+                            spender,
+                            value: 1000000n,
+                            nonce: 321n,
+                            deadline: maxUint256,
+                        },
+                    },
+                    signature: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                    v: 27,
+                    r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    s: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    yParity: 0,
+                },
+            ],
+            // simulateContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    args: [
+                        account,
+                        spender,
+                        1000000n,
+                        maxUint256,
+                        27,
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    ],
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    gas: undefined,
+                },
+                {
+                    request: {
+                        address: tokenAddress,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        abi: expect.any(Array),
+                        functionName: 'permit',
+                        args: [
+                            account,
+                            spender,
+                            1000000n,
+                            maxUint256,
+                            27,
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        ],
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({ address: account }),
+                    },
+                },
+            ],
+            // writeContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    args: expect.any(Array),
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    chain: ETH_SEPOLIA,
+                },
+                '0xpermitTransactionHash',
+            ],
+        ],
+        [
+            // Permit with gas and fees
+            {
+                token: tokenAddress,
+                owner: account,
+                spender,
+                value: '1.0',
+                gas: 50000n,
+                fees: {
+                    maxFeePerGas: 20000000000n,
+                    maxPriorityFeePerGas: 1000000000n,
+                },
+            },
+            '0xpermitTransactionHash',
+            // signEIP2612Permit call
+            [
+                {
+                    token: tokenAddress,
+                    owner: account,
+                    spender,
+                    value: '1.0',
+                    gas: 50000n,
+                    fees: {
+                        maxFeePerGas: 20000000000n,
+                        maxPriorityFeePerGas: 1000000000n,
+                    },
+                },
+                {
+                    typedData: {
+                        types: {
+                            EIP712Domain: [
+                                { name: 'name', type: 'string' },
+                                { name: 'version', type: 'string' },
+                                { name: 'chainId', type: 'uint256' },
+                                { name: 'verifyingContract', type: 'address' },
+                            ],
+                            Permit: [
+                                { name: 'owner', type: 'address' },
+                                { name: 'spender', type: 'address' },
+                                { name: 'value', type: 'uint256' },
+                                { name: 'nonce', type: 'uint256' },
+                                { name: 'deadline', type: 'uint256' },
+                            ],
+                        },
+                        primaryType: 'Permit',
+                        domain: {
+                            name: 'USD Coin',
+                            version: '2',
+                            chainId: BigInt(ETH_SEPOLIA.id),
+                            verifyingContract: tokenAddress,
+                        },
+                        message: {
+                            owner: account,
+                            spender,
+                            value: 1000000n,
+                            nonce: 321n,
+                            deadline: maxUint256,
+                        },
+                    },
+                    signature: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                    v: 27,
+                    r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    s: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    yParity: 0,
+                },
+            ],
+            // simulateContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    args: [
+                        account,
+                        spender,
+                        1000000n,
+                        maxUint256,
+                        27,
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    ],
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    gas: 50000n,
+                    maxFeePerGas: 20000000000n,
+                    maxPriorityFeePerGas: 1000000000n,
+                },
+                {
+                    request: {
+                        address: tokenAddress,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        abi: expect.any(Array),
+                        functionName: 'permit',
+                        args: [
+                            account,
+                            spender,
+                            1000000n,
+                            maxUint256,
+                            27,
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        ],
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({ address: account }),
+                        gas: 50000n,
+                        maxFeePerGas: 20000000000n,
+                        maxPriorityFeePerGas: 1000000000n,
+                    },
+                },
+            ],
+            // writeContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    args: expect.any(Array),
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    chain: ETH_SEPOLIA,
+                    gas: 50000n,
+                    maxFeePerGas: 20000000000n,
+                    maxPriorityFeePerGas: 1000000000n,
+                },
+                '0xpermitTransactionHash',
+            ],
+        ],
+        [
+            // Permit with contract object token
+            {
+                token: { address: tokenAddress },
+                owner: account,
+                spender,
+                value: '1.0',
+            },
+            '0xpermitTransactionHash',
+            // signEIP2612Permit call
+            [
+                {
+                    token: { address: tokenAddress },
+                    owner: account,
+                    spender,
+                    value: '1.0',
+                },
+                {
+                    typedData: {
+                        types: {
+                            EIP712Domain: [
+                                { name: 'name', type: 'string' },
+                                { name: 'version', type: 'string' },
+                                { name: 'chainId', type: 'uint256' },
+                                { name: 'verifyingContract', type: 'address' },
+                            ],
+                            Permit: [
+                                { name: 'owner', type: 'address' },
+                                { name: 'spender', type: 'address' },
+                                { name: 'value', type: 'uint256' },
+                                { name: 'nonce', type: 'uint256' },
+                                { name: 'deadline', type: 'uint256' },
+                            ],
+                        },
+                        primaryType: 'Permit',
+                        domain: {
+                            name: 'USD Coin',
+                            version: '2',
+                            chainId: BigInt(ETH_SEPOLIA.id),
+                            verifyingContract: tokenAddress,
+                        },
+                        message: {
+                            owner: account,
+                            spender,
+                            value: 1000000n,
+                            nonce: 321n,
+                            deadline: maxUint256,
+                        },
+                    },
+                    signature: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                    v: 27,
+                    r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    s: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    yParity: 0,
+                },
+            ],
+            // simulateContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    args: [
+                        account,
+                        spender,
+                        1000000n,
+                        maxUint256,
+                        27,
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    ],
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    gas: undefined,
+                },
+                {
+                    request: {
+                        address: tokenAddress,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        abi: expect.any(Array),
+                        functionName: 'permit',
+                        args: [
+                            account,
+                            spender,
+                            1000000n,
+                            maxUint256,
+                            27,
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        ],
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({ address: account }),
+                    },
+                },
+            ],
+            // writeContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    args: expect.any(Array),
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    chain: ETH_SEPOLIA,
+                },
+                '0xpermitTransactionHash',
+            ],
+        ],
+        [
+            // Permit with custom deadline
+            {
+                token: tokenAddress,
+                owner: account,
+                spender,
+                value: '1.0',
+                deadline: 1234567890n,
+            },
+            '0xpermitTransactionHash',
+            // signEIP2612Permit
+            [
+                {
+                    token: tokenAddress,
+                    owner: account,
+                    spender,
+                    value: '1.0',
+                    deadline: 1234567890n,
+                },
+                {
+                    typedData: {
+                        types: {
+                            EIP712Domain: [
+                                { name: 'name', type: 'string' },
+                                { name: 'version', type: 'string' },
+                                { name: 'chainId', type: 'uint256' },
+                                { name: 'verifyingContract', type: 'address' },
+                            ],
+                            Permit: [
+                                { name: 'owner', type: 'address' },
+                                { name: 'spender', type: 'address' },
+                                { name: 'value', type: 'uint256' },
+                                { name: 'nonce', type: 'uint256' },
+                                { name: 'deadline', type: 'uint256' },
+                            ],
+                        },
+                        primaryType: 'Permit',
+                        domain: {
+                            name: 'USD Coin',
+                            version: '2',
+                            chainId: BigInt(ETH_SEPOLIA.id),
+                            verifyingContract: tokenAddress,
+                        },
+                        message: {
+                            owner: account,
+                            spender,
+                            value: 1000000n,
+                            nonce: 321n,
+                            deadline: 1234567890n,
+                        },
+                    },
+                    signature: '0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890',
+                    v: 27,
+                    r: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    s: '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    yParity: 0,
+                },
+            ],
+            // simulateContract
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    args: [
+                        account,
+                        spender,
+                        1000000n,
+                        1234567890n,
+                        27,
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                    ],
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    gas: undefined,
+                },
+                {
+                    request: {
+                        address: tokenAddress,
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        abi: expect.any(Array),
+                        functionName: 'permit',
+                        args: [
+                            account,
+                            spender,
+                            1000000n,
+                            1234567890n,
+                            27,
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                            '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef',
+                        ],
+                        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                        account: expect.objectContaining({ address: account }),
+                        gas: undefined,
+                    },
+                },
+            ],
+            // writeContract call
+            [
+                {
+                    address: tokenAddress,
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    abi: expect.any(Array),
+                    functionName: 'permit',
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    args: expect.any(Array),
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                    account: expect.objectContaining({ address: account }),
+                    chain: ETH_SEPOLIA,
+                },
+                '0xpermitTransactionHash',
+            ],
+        ],
+    ])('should return successfully', async (params, expectedResult, [signEIP2612PermitMockInput, signEIP2612PermitMockOutput], [simulateContractMockInput, simulateContractMockOutput], [writeContractMockInput, writeContractMockOutput]) => {
+        vi.mocked(signEIP2612Permit).mockResolvedValueOnce(signEIP2612PermitMockOutput);
+        // Mock getAction for simulateContract and writeContract
+        const mockSimulateContract = vi.fn().mockResolvedValue(simulateContractMockOutput);
+        const mockWriteContract = vi.fn().mockResolvedValue(writeContractMockOutput);
+        vi.mocked(getAction)
+            .mockReturnValueOnce(mockSimulateContract) // simulateContract
+            .mockReturnValueOnce(mockWriteContract); // writeContract
+        // Execute the function
+        await expect(action(client, params)).resolves.toEqual(expectedResult);
+        // Verify signEIP2612Permit was called correctly
+        expect(signEIP2612Permit).toHaveBeenCalledWith(client, signEIP2612PermitMockInput);
+        // Verify simulateContract was called correctly
+        expect(mockSimulateContract).toHaveBeenCalledWith(simulateContractMockInput);
+        // Verify writeContract was called correctly
+        expect(mockWriteContract).toHaveBeenCalledWith(writeContractMockInput);
+    });
+});