@coinbase/agentkit 0.0.0-nightly-20250904210426 → 0.0.0-nightly-20250906210355

package/dist/action-providers/clanker/clankerActionProvider.test.js

@@ -0,0 +1,119 @@
+"use strict";
+/**
+ * Clanker Action Provider tests
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+const clankerActionProvider_1 = require("./clankerActionProvider");
+const schemas_1 = require("./schemas");
+const utils_1 = require("./utils");
+jest.mock("./utils", () => ({
+    createClankerClient: jest.fn(),
+}));
+const createClankerClientMock = utils_1.createClankerClient;
+const DEPLOYED_HASH = "0xdeadbeef";
+const DEPLOYED_TOKEN_ADDRESS = "0xabc123abc123abc123abc123abc123abc123abc1";
+describe("Clanker action provider tests", () => {
+    const provider = (0, clankerActionProvider_1.clankerActionProvider)();
+    let mockWalletProvider;
+    beforeEach(() => {
+        mockWalletProvider = {
+            getAddress: jest.fn(),
+            getBalance: jest.fn(),
+            getName: jest.fn(),
+            getNetwork: jest.fn().mockReturnValue({
+                protocolFamily: "evm",
+                networkId: "base-mainnet",
+            }),
+            nativeTransfer: jest.fn(),
+        };
+        const fakeClanker = {
+            deploy: jest.fn(async (_tokenCfg) => ({
+                txHash: DEPLOYED_HASH,
+                waitForTransaction: async () => ({ address: DEPLOYED_TOKEN_ADDRESS }),
+            })),
+        };
+        createClankerClientMock.mockResolvedValue(fakeClanker);
+    });
+    describe("network validation", () => {
+        it("should support the protocol family and network", () => {
+            expect(provider.supportsNetwork({
+                protocolFamily: "evm",
+                networkId: "base-mainnet",
+            })).toBe(true);
+        });
+        it("should not support other protocol families", () => {
+            expect(provider.supportsNetwork({
+                protocolFamily: "other-protocol-family",
+            })).toBe(false);
+        });
+        it("should handle invalid network objects", () => {
+            expect(provider.supportsNetwork({ protocolFamily: "invalid-protocol" })).toBe(false);
+            expect(provider.supportsNetwork({})).toBe(false);
+        });
+    });
+    describe("schema validation", () => {
+        it("should validate example action schema", () => {
+            const validInput = {
+                tokenName: "testTokenName",
+                tokenSymbol: "TTN",
+                image: "https://test.com",
+                vaultPercentage: 10,
+                vestingDuration_Days: 30,
+                lockDuration_Days: 30,
+                interface: "CDP AgentKit",
+                id: "test-id",
+            };
+            const parseResult = schemas_1.ClankTokenSchema.safeParse(validInput);
+            expect(parseResult.success).toBe(true);
+            if (parseResult.success) {
+                expect(parseResult.data.tokenName).toBe("testTokenName");
+                expect(parseResult.data.tokenSymbol).toBe("TTN");
+                expect(parseResult.data.image).toBe("https://test.com");
+                expect(parseResult.data.vaultPercentage).toBe(10);
+                expect(parseResult.data.vestingDuration_Days).toBe(30);
+                expect(parseResult.data.lockDuration_Days).toBe(30);
+            }
+        });
+        it("should reject invalid example action input", () => {
+            const invalidInput = {
+                fieldName: "",
+                amount: "invalid",
+            };
+            const parseResult = schemas_1.ClankTokenSchema.safeParse(invalidInput);
+            expect(parseResult.success).toBe(false);
+        });
+    });
+    describe("clanker action execution", () => {
+        it("should execute the clanker action with wallet provider", async () => {
+            const args = {
+                tokenName: "testTokenName",
+                tokenSymbol: "TTN",
+                image: "https://test.com",
+                vaultPercentage: 10,
+                vestingDuration_Days: 30,
+                lockDuration_Days: 30,
+                interface: "CDP AgentKit",
+                id: "test-id",
+            };
+            const result = await provider.clankToken(mockWalletProvider, args);
+            expect(result).toContain(`Clanker token deployed at ${DEPLOYED_TOKEN_ADDRESS}`);
+            expect(result).toContain(`View the transaction at ${DEPLOYED_HASH}`);
+            expect(mockWalletProvider.getNetwork).toHaveBeenCalled();
+            expect(createClankerClientMock).toHaveBeenCalledWith(expect.any(Object), expect.any(String));
+        });
+    });
+    describe("supportsNetwork", () => {
+        it("should return true for base-mainnet with evm protocol", () => {
+            expect(provider.supportsNetwork({
+                protocolFamily: "evm",
+                networkId: "base-mainnet",
+            })).toBe(true);
+        });
+        it("should return false for non-base networks", () => {
+            expect(provider.supportsNetwork({
+                protocolFamily: "evm",
+                networkId: "ethereum-mainnet",
+            })).toBe(false);
+        });
+    });
+});

package/dist/action-providers/clanker/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./clankerActionProvider";
+export * from "./schemas";

package/dist/action-providers/clanker/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./clankerActionProvider"), exports);
+__exportStar(require("./schemas"), exports);

package/dist/action-providers/clanker/schemas.d.ts

@@ -0,0 +1,56 @@
+import { z } from "zod";
+/**
+ * Action schemas for the clanker action provider.
+ *
+ * This file contains the Zod schemas that define the shape and validation
+ * rules for action parameters in the clanker action provider.
+ */
+export declare const ClankTokenSchema: z.ZodObject<{
+    tokenName: z.ZodString;
+    tokenSymbol: z.ZodString;
+    image: z.ZodString;
+    vaultPercentage: z.ZodNumber;
+    lockDuration_Days: z.ZodNumber;
+    vestingDuration_Days: z.ZodNumber;
+    description: z.ZodOptional<z.ZodString>;
+    socialMediaUrls: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        platform: z.ZodString;
+        url: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        platform: string;
+    }, {
+        url: string;
+        platform: string;
+    }>, "many">>;
+    interface: z.ZodDefault<z.ZodString>;
+    id: z.ZodDefault<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    tokenSymbol: string;
+    image: string;
+    tokenName: string;
+    vaultPercentage: number;
+    lockDuration_Days: number;
+    vestingDuration_Days: number;
+    interface: string;
+    description?: string | undefined;
+    socialMediaUrls?: {
+        url: string;
+        platform: string;
+    }[] | undefined;
+}, {
+    tokenSymbol: string;
+    image: string;
+    tokenName: string;
+    vaultPercentage: number;
+    lockDuration_Days: number;
+    vestingDuration_Days: number;
+    id?: string | undefined;
+    description?: string | undefined;
+    socialMediaUrls?: {
+        url: string;
+        platform: string;
+    }[] | undefined;
+    interface?: string | undefined;
+}>;

package/dist/action-providers/clanker/schemas.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClankTokenSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Action schemas for the clanker action provider.
+ *
+ * This file contains the Zod schemas that define the shape and validation
+ * rules for action parameters in the clanker action provider.
+ */
+exports.ClankTokenSchema = zod_1.z
+    .object({
+    tokenName: zod_1.z.string().min(1).max(100).describe("The name of the token (max 100 characters)"),
+    tokenSymbol: zod_1.z.string().min(1).max(10).describe("The symbol of the token (max 10 characters)"),
+    image: zod_1.z.string().url().describe("Normal or ipfs URL pointing to the token image"),
+    vaultPercentage: zod_1.z
+        .number()
+        .min(0)
+        .max(90)
+        .describe("Percentage of token supply allocated to a vault that can be claimed by deployer after lockup period with optional vesting"),
+    lockDuration_Days: zod_1.z
+        .number()
+        .min(7)
+        .describe("Lockup duration of token (in days), minimum 7 days"),
+    vestingDuration_Days: zod_1.z
+        .number()
+        .min(0)
+        .describe("Vesting duration of token after lockup has passed (in days). Vesting is linear over the duration"),
+    description: zod_1.z
+        .string()
+        .optional()
+        .describe("Description of the token or token project (optional)"),
+    socialMediaUrls: zod_1.z
+        .array(zod_1.z.object({ platform: zod_1.z.string(), url: zod_1.z.string() }))
+        .optional()
+        .describe("Socials for the token. These may be displayed on aggregators."),
+    interface: zod_1.z
+        .string()
+        .default("CDP AgentKit")
+        .describe('System the token was deployed via. Defaults to "CDP AgentKit".'),
+    id: zod_1.z
+        .string()
+        .default("")
+        .describe("User id of the poster on the social platform the token was deployed from. Used for provenance and will be verified by aggregators."),
+})
+    .strip()
+    .describe("Instructions for deploying a Clanker token");

package/dist/action-providers/clanker/utils.d.ts

@@ -0,0 +1,9 @@
+import { EvmWalletProvider } from "../../wallet-providers";
+/**
+ * Creates the client Clanker expects from the EvmWalletProvider
+ *
+ * @param walletProvider - The wallet provider instance for blockchain interactions
+ * @param networkId - The network to Clank on
+ * @returns The Clanker implementation
+ */
+export declare function createClankerClient(walletProvider: EvmWalletProvider, networkId: string): Promise<import("clanker-sdk/v4", { with: { "resolution-mode": "import" } }).Clanker>;

package/dist/action-providers/clanker/utils.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createClankerClient = createClankerClient;
+const viem_1 = require("viem");
+const network_1 = require("../../network");
+/**
+ * Creates the client Clanker expects from the EvmWalletProvider
+ *
+ * @param walletProvider - The wallet provider instance for blockchain interactions
+ * @param networkId - The network to Clank on
+ * @returns The Clanker implementation
+ */
+async function createClankerClient(walletProvider, networkId) {
+    const { Clanker } = await import("clanker-sdk/v4");
+    const account = walletProvider.toSigner();
+    const publicClient = walletProvider.getPublicClient();
+    const wallet = (0, viem_1.createWalletClient)({
+        account,
+        chain: network_1.NETWORK_ID_TO_VIEM_CHAIN[networkId],
+        transport: (0, viem_1.http)(publicClient.transport.url),
+    });
+    return new Clanker({ wallet, publicClient });
+}

package/dist/action-providers/compound/constants.d.ts

@@ -1,5 +1,5 @@
 import { Address } from "viem";
-import { abi as ERC20_ABI } from "../erc20/constants";
+import { erc20Abi as ERC20_ABI } from "viem";
 export declare const SUPPORTED_NETWORKS: string[];
 export declare const COMET_ADDRESSES: Record<string, Address>;
 export declare const ASSET_ADDRESSES: Record<string, Record<string, Address>>;

package/dist/action-providers/compound/constants.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PRICE_FEED_ABI = exports.COMET_ABI = exports.ERC20_ABI = exports.ASSET_ADDRESSES = exports.COMET_ADDRESSES = exports.SUPPORTED_NETWORKS = void 0;
-const constants_1 = require("../erc20/constants");
-Object.defineProperty(exports, "ERC20_ABI", { enumerable: true, get: function () { return constants_1.abi; } });
+const viem_1 = require("viem");
+Object.defineProperty(exports, "ERC20_ABI", { enumerable: true, get: function () { return viem_1.erc20Abi; } });
 exports.SUPPORTED_NETWORKS = ["base-mainnet", "base-sepolia"];
 exports.COMET_ADDRESSES = {
     "base-mainnet": "0xb125E6687d4313864e53df431d5425969c15Eb2F",

package/dist/action-providers/erc20/constants.d.ts

@@ -1,137 +1,37 @@
-export declare const abi: readonly [{
-    readonly type: "event";
-    readonly name: "Approval";
-    readonly inputs: readonly [{
-        readonly indexed: true;
-        readonly name: "owner";
-        readonly type: "address";
-    }, {
-        readonly indexed: true;
-        readonly name: "spender";
-        readonly type: "address";
-    }, {
-        readonly indexed: false;
-        readonly name: "value";
-        readonly type: "uint256";
-    }];
-}, {
-    readonly type: "event";
-    readonly name: "Transfer";
-    readonly inputs: readonly [{
-        readonly indexed: true;
-        readonly name: "from";
-        readonly type: "address";
-    }, {
-        readonly indexed: true;
-        readonly name: "to";
-        readonly type: "address";
-    }, {
-        readonly indexed: false;
-        readonly name: "value";
-        readonly type: "uint256";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "allowance";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly name: "owner";
-        readonly type: "address";
-    }, {
-        readonly name: "spender";
-        readonly type: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "uint256";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "approve";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly name: "spender";
-        readonly type: "address";
-    }, {
-        readonly name: "amount";
-        readonly type: "uint256";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "bool";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "balanceOf";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [{
-        readonly name: "account";
-        readonly type: "address";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "uint256";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "decimals";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "uint8";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "name";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "string";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "symbol";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "string";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "totalSupply";
-    readonly stateMutability: "view";
-    readonly inputs: readonly [];
-    readonly outputs: readonly [{
-        readonly type: "uint256";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "transfer";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly name: "recipient";
-        readonly type: "address";
-    }, {
-        readonly name: "amount";
-        readonly type: "uint256";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "bool";
-    }];
-}, {
-    readonly type: "function";
-    readonly name: "transferFrom";
-    readonly stateMutability: "nonpayable";
-    readonly inputs: readonly [{
-        readonly name: "sender";
-        readonly type: "address";
-    }, {
-        readonly name: "recipient";
-        readonly type: "address";
-    }, {
-        readonly name: "amount";
-        readonly type: "uint256";
-    }];
-    readonly outputs: readonly [{
-        readonly type: "bool";
-    }];
-}];
 export declare const BaseTokenToAssetId: Map<string, string>;
 export declare const BaseSepoliaTokenToAssetId: Map<string, string>;
+export declare const TOKEN_ADDRESSES_BY_SYMBOLS: {
+    readonly "base-mainnet": {
+        readonly USDC: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913";
+        readonly EURC: "0x60a3E35Cc302bFA44Cb288Bc5a4F316Fdb1adb42";
+        readonly CBBTC: "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf";
+        readonly CBETH: "0x2Ae3F1Ec7F1F5012CFEab0185bfc7aa3cf0DEc22";
+        readonly WETH: "0x4200000000000000000000000000000000000006";
+        readonly ZORA: "0x1111111111166b7FE7bd91427724B487980aFc69";
+        readonly AERO: "0x940181a94a35a4569e4529a3cdfb74e38fd98631";
+        readonly BNKR: "0x22af33fe49fd1fa80c7149773dde5890d3c76f3b";
+        readonly CLANKER: "0x1bc0c42215582d5a085795f4badbac3ff36d1bcb";
+    };
+    readonly "base-sepolia": {
+        readonly USDC: "0x036CbD53842c5426634e7929541eC2318f3dCF7e";
+        readonly EURC: "0x808456652fdb597867f38412077A9182bf77359F";
+        readonly CBBTC: "0xcbB7C0006F23900c38EB856149F799620fcb8A4a";
+        readonly WETH: "0x4200000000000000000000000000000000000006";
+    };
+    readonly "ethereum-mainnet": {
+        readonly USDC: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48";
+        readonly EURC: "0x1abaea1f7c830bd89acc67ec4af516284b1bc33c";
+        readonly CBBTC: "0xcbB7C0000aB88B473b1f5aFd9ef808440eed33Bf";
+        readonly WETH: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2";
+        readonly CBETH: "0xBe9895146f7AF43049ca1c1AE358B0541Ea49704";
+    };
+    readonly "polygon-mainnet": {
+        readonly USDC: "0x3c499c542cef5e3811e1192ce70d8cc03d5c3359";
+    };
+    readonly "arbitrum-mainnet": {
+        readonly USDC: "0xaf88d065e77c8cc2239327c5edb3a432268e5831";
+    };
+    readonly "optimism-mainnet": {
+        readonly USDC: "0x0b2c639c533813f4aa9d7837caf62653d097ff85";
+    };
+};