@circle-fin/usdckit 0.22.0 → 0.23.1

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

@@ -0,0 +1,130 @@
+import { signTypedData as _signTypedData } from 'viem/actions';
+import type { Account, Address, BaseUnits, NativeUnits } from '../types.js';
+import type { Chain, Client } from 'viem';
+/**
+ * Parameters for the {@link signEIP2612Permit} function.
+ */
+export type SignEIP2612PermitParams = {
+    /**
+     * The token contract address or contract object that supports EIP-2612 permit functionality.
+     */
+    token: Address | {
+        address: Address;
+    };
+    /**
+     * The account that owns the tokens and will sign the permit.
+     */
+    owner: Address | Account;
+    /**
+     * The account that will be granted permission to spend the tokens.
+     */
+    spender: Address | Account;
+    /**
+     * The amount of tokens to permit for spending.
+     */
+    value: NativeUnits | BaseUnits;
+    /**
+     * The deadline timestamp for the permit. Defaults to maximum uint256 value.
+     */
+    deadline?: bigint;
+    /**
+     * The blockchain network on which the permit will be created.
+     */
+    chain?: Chain;
+    /**
+     * The name of the token. Defaults to the name of the token contract.
+     */
+    name?: string;
+    /**
+     * The version of the token. Defaults to the version of the token contract. If the token contract does not have a version, defaults to '1'.
+     */
+    version?: string;
+};
+/**
+ * Return type for the signEIP2612Permit function.
+ */
+export type SignEIP2612PermitReturnType = ReturnType<typeof _signTypedData>;
+/**
+ * Creates a signed EIP-2612 permit
+ *
+ * @param client - The client instance.
+ * @param params - The permit parameters.
+ * @returns An object containing the typed data structure and signature.
+ *
+ * @example
+ * Creating a permit for USDC spending
+ * ```typescript
+ * const permit = await client.signEIP2612Permit({
+ *   token: client.chain.contracts.USDC,
+ *   owner: '0x0000000000000000000000000000000000000000',
+ *   spender: '0x1111111111111111111111111111111111111111',
+ *   value: 1000000n, // 1 USDC (6 decimals)
+ * })
+ * ```
+ *
+ * @example
+ * Creating a permit with custom deadline
+ * ```typescript
+ * const permit = await client.signEIP2612Permit({
+ *   token: '0x...',
+ *   owner: account1,
+ *   spender: account2,
+ *   value: '100',
+ *   deadline: BigInt(Math.floor(Date.now() / 1000) + 3600), // 1 hour from now
+ * })
+ * ```
+ */
+export declare function signEIP2612Permit(client: Client, 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;
+}>;

package/dist/cjs/actions/signEIP2612Permit.js

@@ -0,0 +1,128 @@
+"use strict";
+// Copyright (c) 2025, Circle Internet Group, Inc.
+// All rights reserved.
+//
+// Circle Internet Group, Inc. CONFIDENTIAL
+//
+// This file includes unpublished proprietary source code of Circle Internet
+// Group, Inc. The copyright notice above does not
+// evidence any actual or intended publication of such source code. Disclosure
+// of this source code or any related proprietary information is strictly
+// prohibited without the express written permission of Circle Internet Group, Inc.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.signEIP2612Permit = signEIP2612Permit;
+const viem_1 = require("viem");
+const actions_1 = require("viem/actions");
+const utils_1 = require("viem/utils");
+const EIP2612_js_1 = __importDefault(require("../abis/EIP2612.js"));
+const getClient_js_1 = require("../utils/getClient.js");
+const parseAccount_js_1 = require("../utils/parseAccount.js");
+const parseAddress_js_1 = require("../utils/parseAddress.js");
+const parseUnits_js_1 = require("../utils/parseUnits.js");
+const raise_js_1 = require("../utils/raise.js");
+/**
+ * Creates a signed EIP-2612 permit
+ *
+ * @param client - The client instance.
+ * @param params - The permit parameters.
+ * @returns An object containing the typed data structure and signature.
+ *
+ * @example
+ * Creating a permit for USDC spending
+ * ```typescript
+ * const permit = await client.signEIP2612Permit({
+ *   token: client.chain.contracts.USDC,
+ *   owner: '0x0000000000000000000000000000000000000000',
+ *   spender: '0x1111111111111111111111111111111111111111',
+ *   value: 1000000n, // 1 USDC (6 decimals)
+ * })
+ * ```
+ *
+ * @example
+ * Creating a permit with custom deadline
+ * ```typescript
+ * const permit = await client.signEIP2612Permit({
+ *   token: '0x...',
+ *   owner: account1,
+ *   spender: account2,
+ *   value: '100',
+ *   deadline: BigInt(Math.floor(Date.now() / 1000) + 3600), // 1 hour from now
+ * })
+ * ```
+ */
+async function signEIP2612Permit(client, params) {
+    const { token: _token, owner: _owner, spender: _spender, value: _value, deadline = viem_1.maxUint256, chain = client.chain, name: _name, version: _version, } = params;
+    const _client = (0, getClient_js_1.getClient)(client, chain);
+    const signTypedData = (0, utils_1.getAction)(_client, actions_1.signTypedData, 'signTypedData');
+    // Parse addresses and accounts
+    const { address: verifyingContractAddress } = (0, parseAddress_js_1.parseAddress)(_token);
+    const owner = (0, parseAccount_js_1.parseAccount)(_owner, { chain });
+    const spender = (0, parseAccount_js_1.parseAccount)(_spender, { chain });
+    // Create contract instance with EIP-2612 ABI
+    const verifyingContract = (0, viem_1.getContract)({
+        address: verifyingContractAddress,
+        abi: EIP2612_js_1.default,
+        client,
+    });
+    // Fetch token metadata and owner's nonce
+    const [name, version, nonce, decimals] = await Promise.all([
+        _name ?? verifyingContract.read.name(),
+        // Default version to '1' if `version()` fails
+        _version ?? verifyingContract.read.version().catch(() => '1'),
+        verifyingContract.read.nonces([owner.address]),
+        verifyingContract.read.decimals(),
+    ]);
+    const value = (0, parseUnits_js_1.parseUnits)(_value, decimals);
+    const 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,
+            version,
+            chainId: BigInt(chain.id),
+            verifyingContract: verifyingContract.address,
+        },
+        message: {
+            owner: owner.address,
+            spender: spender.address,
+            value,
+            nonce,
+            deadline,
+        },
+    };
+    const signature = await signTypedData({
+        ...typedData,
+        account: owner,
+    });
+    const { r, s, v, yParity } = (0, viem_1.parseSignature)(signature);
+    return {
+        typedData,
+        signature,
+        r,
+        s,
+        yParity,
+        // Backfill `v` from `yParity` if not present
+        // REF: https://github.com/ethereum/go-ethereum/blob/1487a8577d1566497e161a04f8cee3204d4b3d36/core/types/transaction_marshalling.go#L63-L79
+        v: Number(v ??
+            (yParity === 0 ? 27n : undefined) ??
+            (yParity === 1 ? 28n : undefined) ??
+            (0, raise_js_1.raise)(new Error('v is missing and yParity must be 0 or 1'))),
+    };
+}

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

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