@circle-fin/usdckit 0.22.0 → 0.23.0

package/dist/esm/abis/EIP2612.js

@@ -0,0 +1,76 @@
+import { erc20Abi } from 'viem';
+/**
+ * EIP-2612 ABI extension
+ */
+export default [
+    ...erc20Abi,
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'owner',
+                type: 'address',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+        name: 'nonces',
+        outputs: [
+            {
+                internalType: 'uint256',
+                name: '',
+                type: 'uint256',
+            },
+        ],
+    },
+    {
+        inputs: [],
+        name: 'version',
+        outputs: [{ internalType: 'string', name: '', type: 'string' }],
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'owner',
+                type: 'address',
+            },
+            {
+                internalType: 'address',
+                name: 'spender',
+                type: 'address',
+            },
+            {
+                internalType: 'uint256',
+                name: 'value',
+                type: 'uint256',
+            },
+            {
+                internalType: 'uint256',
+                name: 'deadline',
+                type: 'uint256',
+            },
+            {
+                internalType: 'uint8',
+                name: 'v',
+                type: 'uint8',
+            },
+            {
+                internalType: 'bytes32',
+                name: 'r',
+                type: 'bytes32',
+            },
+            {
+                internalType: 'bytes32',
+                name: 's',
+                type: 'bytes32',
+            },
+        ],
+        name: 'permit',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+];

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

@@ -1,6 +1,8 @@
 import { generateTransferLink } from './generateTransferLink.js';
 import { getSwapExactInQuote } from './getSwapExactInQuote.js';
 import { getTokenBalance } from './getTokenBalance.js';
+import { permit } from './permit.js';
+import { signEIP2612Permit } from './signEIP2612Permit.js';
 import { swapExactIn } from './swapExactIn.js';
 import { sweep } from './sweep.js';
 import { transfer } from './transfer.js';
@@ -9,6 +11,8 @@ import type { Account } from '../types.js';
 import type { GenerateTransferLinkParams } from './generateTransferLink.js';
 import type { GetSwapExactInQuoteParams } from './getSwapExactInQuote.js';
 import type { GetTokenBalanceInput } from './getTokenBalance.js';
+import type { PermitParams } from './permit.js';
+import type { SignEIP2612PermitParams } from './signEIP2612Permit.js';
 import type { SwapExactInParams } from './swapExactIn.js';
 import type { SweepParams } from './sweep.js';
 import type { TransferParams } from './transfer.js';
@@ -18,6 +22,7 @@ export * from './sweep.js';
 export * from './generateTransferLink.js';
 export * from './getSwapExactInQuote.js';
 export * from './getTokenBalance.js';
+export * from './permit.js';
 export * from './swapExactIn.js';
 export { FEE_LEVEL_WITH_PREPARE } from '../providers/circle-wallets/actions/index.js';
 export type Actions<transport extends Transport = Transport, chain extends ViemChain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = {
@@ -35,6 +40,10 @@ export type Actions<transport extends Transport = Transport, chain extends ViemC
     getSwapExactInQuote: (params: Parameters<typeof getSwapExactInQuote>[1]) => ReturnType<typeof getSwapExactInQuote>;
     /** See {@link getTokenBalance} action */
     getTokenBalance: (params: Parameters<typeof getTokenBalance>[1]) => ReturnType<typeof getTokenBalance>;
+    /** See {@link signEIP2612Permit} action */
+    signEIP2612Permit: (params: Parameters<typeof signEIP2612Permit>[1]) => ReturnType<typeof signEIP2612Permit>;
+    /** See {@link permit} action */
+    permit: (params: Parameters<typeof permit>[1]) => ReturnType<typeof permit>;
     /** See {@link swapExactIn} action */
     swap: (params: Parameters<typeof swapExactIn>[1]) => ReturnType<typeof swapExactIn>;
     /** See {@link swapExactIn} action */
@@ -61,6 +70,63 @@ export declare function actions(client: Client): {
     getSwapExactInQuote: (params: GetSwapExactInQuoteParams) => Promise<import("./getSwapExactInQuote.js").GetSwapExactInQuoteReturnType>;
     /** See {@link getTokenBalance} action */
     getTokenBalance: (params: GetTokenBalanceInput) => Promise<import("./getTokenBalance.js").GetTokenBalanceReturnType>;
+    /** See {@link signEIP2612Permit} action */
+    signEIP2612Permit: (params: SignEIP2612PermitParams) => Promise<{
+        typedData: {
+            readonly types: {
+                readonly EIP712Domain: readonly [{
+                    readonly name: "name";
+                    readonly type: "string";
+                }, {
+                    readonly name: "version";
+                    readonly type: "string";
+                }, {
+                    readonly name: "chainId";
+                    readonly type: "uint256";
+                }, {
+                    readonly name: "verifyingContract";
+                    readonly type: "address";
+                }];
+                readonly Permit: readonly [{
+                    readonly name: "owner";
+                    readonly type: "address";
+                }, {
+                    readonly name: "spender";
+                    readonly type: "address";
+                }, {
+                    readonly name: "value";
+                    readonly type: "uint256";
+                }, {
+                    readonly name: "nonce";
+                    readonly type: "uint256";
+                }, {
+                    readonly name: "deadline";
+                    readonly type: "uint256";
+                }];
+            };
+            readonly primaryType: "Permit";
+            readonly domain: {
+                readonly name: string;
+                readonly version: string;
+                readonly chainId: bigint;
+                readonly verifyingContract: `0x${string}`;
+            };
+            readonly message: {
+                readonly owner: `0x${string}`;
+                readonly spender: `0x${string}`;
+                readonly value: bigint;
+                readonly nonce: bigint;
+                readonly deadline: bigint;
+            };
+        };
+        signature: `0x${string}`;
+        r: `0x${string}`;
+        s: `0x${string}`;
+        yParity: number;
+        v: number;
+    }>;
+    /** See {@link permit} action */
+    permit: (params: PermitParams) => Promise<`0x${string}`>;
     /** See {@link swapExactIn} action */
     swap: (params: SwapExactInParams) => Promise<`0x${string}`>;
     /** See {@link swapExactIn} action */

package/dist/esm/actions/index.js

@@ -11,6 +11,8 @@
 import { generateTransferLink } from './generateTransferLink.js';
 import { getSwapExactInQuote } from './getSwapExactInQuote.js';
 import { getTokenBalance } from './getTokenBalance.js';
+import { permit } from './permit.js';
+import { signEIP2612Permit } from './signEIP2612Permit.js';
 import { swapExactIn } from './swapExactIn.js';
 import { sweep } from './sweep.js';
 import { transfer } from './transfer.js';
@@ -19,6 +21,7 @@ export * from './sweep.js';
 export * from './generateTransferLink.js';
 export * from './getSwapExactInQuote.js';
 export * from './getTokenBalance.js';
+export * from './permit.js';
 export * from './swapExactIn.js';
 export { FEE_LEVEL_WITH_PREPARE } from '../providers/circle-wallets/actions/index.js';
 /**
@@ -43,6 +46,10 @@ export function actions(client) {
         getSwapExactInQuote: (params) => getSwapExactInQuote(client, params),
         /** See {@link getTokenBalance} action */
         getTokenBalance: (params) => getTokenBalance(client, params),
+        /** See {@link signEIP2612Permit} action */
+        signEIP2612Permit: (params) => signEIP2612Permit(client, params),
+        /** See {@link permit} action */
+        permit: (params) => permit(client, params),
         /** See {@link swapExactIn} action */
         swap: (params) => swapExactIn(client, params),
         /** See {@link swapExactIn} action */

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

@@ -36,6 +36,10 @@ describe.concurrent('actions', () => {
             swapExactIn: expect.any(Function),
             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
             getTokenBalance: expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            signEIP2612Permit: expect.any(Function),
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+            permit: expect.any(Function),
         });
     });
 });

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

@@ -0,0 +1,19 @@
+import type { ControlFlowOptions } from '../types.js';
+import type { SignEIP2612PermitParams } from './signEIP2612Permit.js';
+import type { Client, FeeValuesEIP1559, Hash } from 'viem';
+/**
+ * Parameters for the {@link permit} function.
+ */
+export type PermitParams = SignEIP2612PermitParams & {
+    gas?: bigint;
+    fees?: FeeValuesEIP1559;
+};
+export type PermitReturnType = Hash;
+/**
+ * Signs and executes an EIP-2612 permit
+ *
+ * @param client - The client instance.
+ * @param params - The permit parameters.
+ * @returns A transaction hash (`Hash`).
+ */
+export declare function permit(client: Client, params: PermitParams & ControlFlowOptions): Promise<`0x${string}`>;

package/dist/esm/actions/permit.js

@@ -0,0 +1,44 @@
+// 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 { simulateContract as _simulateContract, writeContract as _writeContract } from 'viem/actions';
+import { getAction } from 'viem/utils';
+import EIP2612 from '../abis/EIP2612.js';
+import { getClient } from '../utils/getClient.js';
+import { parseAccount } from '../utils/parseAccount.js';
+import { parseAddress } from '../utils/parseAddress.js';
+import { signEIP2612Permit } from './signEIP2612Permit.js';
+/**
+ * Signs and executes an EIP-2612 permit
+ *
+ * @param client - The client instance.
+ * @param params - The permit parameters.
+ * @returns A transaction hash (`Hash`).
+ */
+export async function permit(client, params) {
+    const { token: _token, owner: _owner, chain = client.chain, gas, fees } = params;
+    const { address: verifyingContractAddress } = parseAddress(_token);
+    const ownerAccount = parseAccount(_owner, { chain });
+    const _client = getClient(client, chain);
+    const simulateContract = getAction(_client, _simulateContract, 'simulateContract');
+    const writeContract = getAction(_client, _writeContract, 'writeContract');
+    const result = await signEIP2612Permit(_client, params);
+    const { typedData: { message }, v, r, s, } = result;
+    const { request } = await simulateContract({
+        address: verifyingContractAddress,
+        abi: EIP2612,
+        functionName: 'permit',
+        args: [message.owner, message.spender, message.value, message.deadline, v, r, s],
+        account: ownerAccount,
+        gas,
+        ...fees,
+    });
+    return await writeContract({ ...request, chain });
+}

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

@@ -0,0 +1 @@
+export {};