@circle-fin/usdckit 0.21.1 → 0.23.0

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

@@ -1,11 +1,18 @@
 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';
-import type { Account, Chain } from '../types.js';
+import type { Chain } from '../chains.js';
+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';
@@ -14,6 +21,8 @@ export * from './transfer.js';
 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> = {
@@ -29,6 +38,12 @@ export type Actions<transport extends Transport = Transport, chain extends ViemC
     getSwapQuote: (params: Parameters<typeof getSwapExactInQuote>[1]) => ReturnType<typeof getSwapExactInQuote>;
     /** See {@link getSwapExactInQuote} action */
     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 */
@@ -53,6 +68,65 @@ export declare function actions(client: Client): {
     getSwapQuote: (params: GetSwapExactInQuoteParams) => Promise<import("./getSwapExactInQuote.js").GetSwapExactInQuoteReturnType>;
     /** See {@link getSwapExactInQuote} action */
     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/cjs/actions/index.js

@@ -28,6 +28,9 @@ exports.FEE_LEVEL_WITH_PREPARE = void 0;
 exports.actions = actions;
 const generateTransferLink_js_1 = require("./generateTransferLink.js");
 const getSwapExactInQuote_js_1 = require("./getSwapExactInQuote.js");
+const getTokenBalance_js_1 = require("./getTokenBalance.js");
+const permit_js_1 = require("./permit.js");
+const signEIP2612Permit_js_1 = require("./signEIP2612Permit.js");
 const swapExactIn_js_1 = require("./swapExactIn.js");
 const sweep_js_1 = require("./sweep.js");
 const transfer_js_1 = require("./transfer.js");
@@ -35,6 +38,8 @@ __exportStar(require("./transfer.js"), exports);
 __exportStar(require("./sweep.js"), exports);
 __exportStar(require("./generateTransferLink.js"), exports);
 __exportStar(require("./getSwapExactInQuote.js"), exports);
+__exportStar(require("./getTokenBalance.js"), exports);
+__exportStar(require("./permit.js"), exports);
 __exportStar(require("./swapExactIn.js"), exports);
 var index_js_1 = require("../providers/circle-wallets/actions/index.js");
 Object.defineProperty(exports, "FEE_LEVEL_WITH_PREPARE", { enumerable: true, get: function () { return index_js_1.FEE_LEVEL_WITH_PREPARE; } });
@@ -45,23 +50,28 @@ Object.defineProperty(exports, "FEE_LEVEL_WITH_PREPARE", { enumerable: true, get
  * @returns An object containing the bound action functions.
  */
 function actions(client) {
-    const _client = client;
     return {
         /** See {@link sweep} action */
-        sweep: (params) => (0, sweep_js_1.sweep)(_client, params),
+        sweep: (params) => (0, sweep_js_1.sweep)(client, params),
         /** See {@link sweep} action */
-        drainFrom: (params) => (0, sweep_js_1.sweep)(_client, params),
+        drainFrom: (params) => (0, sweep_js_1.sweep)(client, params),
         /** See {@link transfer} action */
-        transfer: (params) => (0, transfer_js_1.transfer)(_client, params),
+        transfer: (params) => (0, transfer_js_1.transfer)(client, params),
         /** See {@link generateTransferLink} action */
-        generateTransferLink: (params) => (0, generateTransferLink_js_1.generateTransferLink)(_client, params),
+        generateTransferLink: (params) => (0, generateTransferLink_js_1.generateTransferLink)(client, params),
         /** See {@link getSwapExactInQuote} action */
-        getSwapQuote: (params) => (0, getSwapExactInQuote_js_1.getSwapExactInQuote)(_client, params),
+        getSwapQuote: (params) => (0, getSwapExactInQuote_js_1.getSwapExactInQuote)(client, params),
         /** See {@link getSwapExactInQuote} action */
-        getSwapExactInQuote: (params) => (0, getSwapExactInQuote_js_1.getSwapExactInQuote)(_client, params),
+        getSwapExactInQuote: (params) => (0, getSwapExactInQuote_js_1.getSwapExactInQuote)(client, params),
+        /** See {@link getTokenBalance} action */
+        getTokenBalance: (params) => (0, getTokenBalance_js_1.getTokenBalance)(client, params),
+        /** See {@link signEIP2612Permit} action */
+        signEIP2612Permit: (params) => (0, signEIP2612Permit_js_1.signEIP2612Permit)(client, params),
+        /** See {@link permit} action */
+        permit: (params) => (0, permit_js_1.permit)(client, params),
         /** See {@link swapExactIn} action */
-        swap: (params) => (0, swapExactIn_js_1.swapExactIn)(_client, params),
+        swap: (params) => (0, swapExactIn_js_1.swapExactIn)(client, params),
         /** See {@link swapExactIn} action */
-        swapExactIn: (params) => (0, swapExactIn_js_1.swapExactIn)(_client, params),
+        swapExactIn: (params) => (0, swapExactIn_js_1.swapExactIn)(client, params),
     };
 }

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

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

package/dist/cjs/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/cjs/actions/permit.js

@@ -0,0 +1,50 @@
+"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.permit = permit;
+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 signEIP2612Permit_js_1 = require("./signEIP2612Permit.js");
+/**
+ * Signs and executes an EIP-2612 permit
+ *
+ * @param client - The client instance.
+ * @param params - The permit parameters.
+ * @returns A transaction hash (`Hash`).
+ */
+async function permit(client, params) {
+    const { token: _token, owner: _owner, chain = client.chain, gas, fees } = params;
+    const { address: verifyingContractAddress } = (0, parseAddress_js_1.parseAddress)(_token);
+    const ownerAccount = (0, parseAccount_js_1.parseAccount)(_owner, { chain });
+    const _client = (0, getClient_js_1.getClient)(client, chain);
+    const simulateContract = (0, utils_1.getAction)(_client, actions_1.simulateContract, 'simulateContract');
+    const writeContract = (0, utils_1.getAction)(_client, actions_1.writeContract, 'writeContract');
+    const result = await (0, signEIP2612Permit_js_1.signEIP2612Permit)(_client, params);
+    const { typedData: { message }, v, r, s, } = result;
+    const { request } = await simulateContract({
+        address: verifyingContractAddress,
+        abi: EIP2612_js_1.default,
+        functionName: 'permit',
+        args: [message.owner, message.spender, message.value, message.deadline, v, r, s],
+        account: ownerAccount,
+        gas,
+        ...fees,
+    });
+    return await writeContract({ ...request, chain });
+}