@coinbase/agentkit 0.10.0 → 0.10.1

package/README.md

@@ -182,6 +182,14 @@ const agent = createReactAgent({
     <td width="200"><code>use_spend_permission</code></td>
     <td width="768">Uses a spend permission to spend tokens on behalf of a smart account that the current EVM wallet has permission to spend.</td>
 </tr>
+<tr>
+    <td width="200"><code>get_swap_price</code></td>
+    <td width="768">Fetches a price quote for swapping between two tokens using the CDP Swap API (does not execute swap).</td>
+</tr>
+<tr>
+    <td width="200"><code>swap</code></td>
+    <td width="768">Executes a token swap using the CDP Swap API with automatic token approvals.</td>
+</tr>
 </table>
 </details>
 <details>
@@ -195,6 +203,14 @@ const agent = createReactAgent({
     <td width="200"><code>use_spend_permission</code></td>
     <td width="768">Uses a spend permission to spend tokens on behalf of a smart account that the current smart wallet has permission to spend.</td>
 </tr>
+<tr>
+    <td width="200"><code>get_swap_price</code></td>
+    <td width="768">Fetches a price quote for swapping between two tokens using the CDP Swap API (does not execute swap).</td>
+</tr>
+<tr>
+    <td width="200"><code>swap</code></td>
+    <td width="768">Executes a token swap using the CDP Swap API with automatic token approvals.</td>
+</tr>
 </table>
 </details>
 <details>
@@ -220,6 +236,15 @@ const agent = createReactAgent({
 </table>
 </details>
 <details>
+<summary><strong>Clanker</strong></summary>
+<table width="100%">
+<tr>
+    <td width="200"><code>clank_token</code></td>
+    <td width="768">Deploys an ERC20 Clanker token based on the supplied config.</td>
+</tr>
+</table>
+</details>
+<details>
 <summary><strong>Compound</strong></summary>
 <table width="100%">
 <tr>
@@ -272,6 +297,10 @@ const agent = createReactAgent({
     <td width="200"><code>transfer</code></td>
     <td width="768">Transfers a specified amount of ERC-20 tokens to a destination address.</td>
 </tr>
+<tr>
+    <td width="200"><code>get_erc20_token_address</code></td>
+    <td width="768">Gets the contract address for frequently used ERC20 tokens on different networks by token symbol.</td>
+</tr>
 </table>
 </details>
 <details>
@@ -383,6 +412,43 @@ const agent = createReactAgent({
 </table>
 </details>
 <details>
+<summary><strong>Superfluid</strong></summary>
+<table width="100%">
+<tr>
+    <td width="200"><code>create_pool</code></td>
+    <td width="768">Creates a new Superfluid pool for a Supertoken.</td>
+</tr>
+<tr>
+    <td width="200"><code>update_pool</code></td>
+    <td width="768">Updates an existing Superfluid pool with recipients and flow rates.</td>
+</tr>
+<tr>
+    <td width="200"><code>query_streams</code></td>
+    <td width="768">Queries existing Superfluid streams using Graphql.</td>
+</tr>
+<tr>
+    <td width="200"><code>create_stream</code></td>
+    <td width="768">Creates a new Superfluid stream to an address with a given flow rate.</td>
+</tr>
+<tr>
+    <td width="200"><code>update_stream</code></td>
+    <td width="768">Updates an existing Superfluid stream with a new flow rate.</td>
+</tr>
+<tr>
+    <td width="200"><code>delete_stream</code></td>
+    <td width="768">Stops an existing Superfluid stream.</td>
+</tr>
+<tr>
+    <td width="200"><code>create_super_token</code></td>
+    <td width="768">Creates a new Supertoken implementation for an existing ERC20 token.</td>
+</tr>
+<tr>
+    <td width="200"><code>wrap_superfluid_token</code></td>
+    <td width="768">Wraps an ERC20 token into its Superfluid Super token implementation.</td>
+</tr>
+</table>
+</details>
+<details>
 <summary><strong>Twitter</strong></summary>
 <table width="100%">
 <tr>
@@ -487,6 +553,15 @@ it will return payment details that can be used on retry.</td>
 <tr>
     <td width="200"><code>make_http_request_with_x402</code></td>
     <td width="768">Combines make_http_request and retry_http_request_with_x402 into a single step.</td>
+<summary><strong>ZeroX</strong></summary>
+<table width="100%">
+<tr>
+    <td width="200"><code>get_swap_price_quote_from_0x</code></td>
+    <td width="768">Fetches a price quote for swapping between two tokens using the 0x API.</td>
+</tr>
+<tr>
+    <td width="200"><code>execute_swap_on_0x</code></td>
+    <td width="768">Executes a token swap between two tokens using the 0x API.</td>
 </tr>
 </table>
 </details>

package/dist/action-providers/across/acrossActionProvider.js

@@ -31,7 +31,7 @@ const schemas_1 = require("./schemas");
 const wallet_providers_1 = require("../../wallet-providers");
 const utils_1 = require("./utils");
 const accounts_1 = require("viem/accounts");
-const constants_1 = require("../erc20/constants");
+const viem_2 = require("viem");
 /**
  * AcrossActionProvider provides actions for cross-chain bridging via Across Protocol.
  */
@@ -141,7 +141,7 @@ class AcrossActionProvider extends actionProvider_1.ActionProvider {
                 // Check ERC20 token balance
                 const tokenBalance = (await walletProvider.readContract({
                     address: inputToken,
-                    abi: constants_1.abi,
+                    abi: viem_2.erc20Abi,
                     functionName: "balanceOf",
                     args: [address],
                 }));
@@ -194,7 +194,7 @@ class AcrossActionProvider extends actionProvider_1.ActionProvider {
                 approvalTxHash = await walletProvider.sendTransaction({
                     to: inputToken,
                     data: (0, viem_1.encodeFunctionData)({
-                        abi: constants_1.abi,
+                        abi: viem_2.erc20Abi,
                         functionName: "approve",
                         args: [quote.deposit.spokePoolAddress, quote.deposit.inputAmount],
                     }),

package/dist/action-providers/cdp/cdpApiActionProvider.d.ts

@@ -2,14 +2,13 @@ import { z } from "zod";
 import { Network } from "../../network";
 import { WalletProvider } from "../../wallet-providers";
 import { ActionProvider } from "../actionProvider";
-import { RequestFaucetFundsV2Schema, SwapSchema } from "./schemas";
+import { RequestFaucetFundsV2Schema } from "./schemas";
 /**
  * CdpApiActionProvider is an action provider for CDP API.
  *
  * This provider is used for any action that uses the CDP API, but does not require a CDP Wallet.
  */
 export declare class CdpApiActionProvider extends ActionProvider<WalletProvider> {
-    #private;
     /**
      * Constructor for the CdpApiActionProvider class.
      */
@@ -23,20 +22,12 @@ export declare class CdpApiActionProvider extends ActionProvider<WalletProvider>
      */
     faucet(walletProvider: WalletProvider, args: z.infer<typeof RequestFaucetFundsV2Schema>): Promise<string>;
     /**
-     * Swaps tokens using the CDP client.
-     *
-     * @param walletProvider - The wallet provider to perform the swap with.
-     * @param args - The input arguments for the swap action.
-     * @returns A confirmation message with transaction details.
-     */
-    swap(walletProvider: WalletProvider, args: z.infer<typeof SwapSchema>): Promise<string>;
-    /**
-     * Checks if the Cdp action provider supports the given network.
+     * Checks if the CDP action provider supports the given network.
      *
      * NOTE: Network scoping is done at the action implementation level
      *
      * @param _ - The network to check.
-     * @returns True if the Cdp action provider supports the network, false otherwise.
+     * @returns True if the CDP action provider supports the network, false otherwise.
      */
     supportsNetwork: (_: Network) => boolean;
 }

package/dist/action-providers/cdp/cdpApiActionProvider.js

@@ -8,12 +8,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
 var __metadata = (this && this.__metadata) || function (k, v) {
     if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _CdpApiActionProvider_instances, _CdpApiActionProvider_getCdpSdkNetwork;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cdpApiActionProvider = exports.CdpApiActionProvider = void 0;
 const zod_1 = require("zod");
@@ -33,14 +27,13 @@ class CdpApiActionProvider extends actionProvider_1.ActionProvider {
      */
     constructor() {
         super("cdp_api", []);
-        _CdpApiActionProvider_instances.add(this);
         /**
-         * Checks if the Cdp action provider supports the given network.
+         * Checks if the CDP action provider supports the given network.
          *
          * NOTE: Network scoping is done at the action implementation level
          *
          * @param _ - The network to check.
-         * @returns True if the Cdp action provider supports the network, false otherwise.
+         * @returns True if the CDP action provider supports the network, false otherwise.
          */
         this.supportsNetwork = (_) => true;
     }
@@ -84,66 +77,8 @@ class CdpApiActionProvider extends actionProvider_1.ActionProvider {
             throw new Error("Wallet provider is not a CDP Wallet Provider.");
         }
     }
-    /**
-     * Swaps tokens using the CDP client.
-     *
-     * @param walletProvider - The wallet provider to perform the swap with.
-     * @param args - The input arguments for the swap action.
-     * @returns A confirmation message with transaction details.
-     */
-    async swap(walletProvider, args) {
-        const network = walletProvider.getNetwork();
-        const networkId = network.networkId;
-        if ((0, cdpShared_1.isWalletProviderWithClient)(walletProvider)) {
-            if (network.protocolFamily === "evm") {
-                try {
-                    const cdpNetwork = __classPrivateFieldGet(this, _CdpApiActionProvider_instances, "m", _CdpApiActionProvider_getCdpSdkNetwork).call(this, networkId);
-                    // Get the account for the wallet address
-                    const account = await walletProvider.getClient().evm.getAccount({
-                        address: walletProvider.getAddress(),
-                    });
-                    // Execute swap using the all-in-one pattern
-                    const swapResult = await account.swap({
-                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        network: cdpNetwork,
-                        from: args.fromAssetId,
-                        to: args.toAssetId,
-                        amount: args.amount,
-                        slippageBps: 100, // 1% slippage tolerance
-                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                        paymasterUrl: walletProvider.getPaymasterUrl?.(),
-                        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    });
-                    return `Successfully swapped ${args.amount} ${args.fromAssetId.toUpperCase()} to ${args.toAssetId.toUpperCase()}. Transaction hash: ${swapResult.transactionHash}`;
-                }
-                catch (error) {
-                    throw new Error(`Swap failed: ${error}`);
-                }
-            }
-            else {
-                throw new Error("Swap is currently only supported on EVM networks.");
-            }
-        }
-        else {
-            throw new Error("Wallet provider is not a CDP Wallet Provider.");
-        }
-    }
 }
 exports.CdpApiActionProvider = CdpApiActionProvider;
-_CdpApiActionProvider_instances = new WeakSet(), _CdpApiActionProvider_getCdpSdkNetwork = function _CdpApiActionProvider_getCdpSdkNetwork(networkId) {
-    switch (networkId) {
-        case "base-sepolia":
-            return "base-sepolia";
-        case "base-mainnet":
-            return "base";
-        case "ethereum-sepolia":
-            return "ethereum-sepolia";
-        case "ethereum-mainnet":
-            return "ethereum";
-        default:
-            return networkId; // For other networks, use as-is
-    }
-};
 __decorate([
     (0, actionDecorator_1.CreateAction)({
         name: "request_faucet_funds",
@@ -159,19 +94,5 @@ from another wallet and provide the user with your wallet details.`,
     __metadata("design:paramtypes", [wallet_providers_1.WalletProvider, void 0]),
     __metadata("design:returntype", Promise)
 ], CdpApiActionProvider.prototype, "faucet", null);
-__decorate([
-    (0, actionDecorator_1.CreateAction)({
-        name: "swap",
-        description: `This tool swaps tokens using the CDP API. It takes the wallet, from asset ID, to asset ID, and amount as input.
-Swaps are currently supported on EVM networks like Base and Ethereum.
-Example usage:
-- Swap 0.1 ETH to USDC: { fromAssetId: "eth", toAssetId: "usdc", amount: "0.1" }
-- Swap 100 USDC to ETH: { fromAssetId: "usdc", toAssetId: "eth", amount: "100" }`,
-        schema: schemas_1.SwapSchema,
-    }),
-    __metadata("design:type", Function),
-    __metadata("design:paramtypes", [wallet_providers_1.WalletProvider, void 0]),
-    __metadata("design:returntype", Promise)
-], CdpApiActionProvider.prototype, "swap", null);
 const cdpApiActionProvider = () => new CdpApiActionProvider();
 exports.cdpApiActionProvider = cdpApiActionProvider;

package/dist/action-providers/cdp/cdpApiActionProvider.test.js

@@ -10,20 +10,14 @@ describe("CDP API Action Provider", () => {
     let mockCdpClient;
     beforeEach(() => {
         jest.clearAllMocks();
-        const mockAccount = {
-            swap: jest.fn(),
-        };
         mockCdpClient = {
             evm: {
                 requestFaucet: jest.fn(),
-                getAccount: jest.fn(),
             },
             solana: {
                 requestFaucet: jest.fn(),
             },
         };
-        // Set up default mock behavior
-        mockCdpClient.evm.getAccount.mockResolvedValue(mockAccount);
         mockWalletProvider = {
             getNetwork: jest.fn(),
             getAddress: jest.fn(),
@@ -93,94 +87,6 @@ describe("CDP API Action Provider", () => {
             await expect(actionProvider.faucet(mockWalletWithoutClient, { assetId: "eth" })).rejects.toThrow("Wallet provider is not a CDP Wallet Provider");
         });
     });
-    describe("swap", () => {
-        it("should perform swap on base-sepolia", async () => {
-            const mockNetwork = { protocolFamily: "evm", networkId: "base-sepolia" };
-            mockWalletProvider.getNetwork.mockReturnValue(mockNetwork);
-            mockWalletProvider.getAddress.mockReturnValue("0x123456789");
-            mockWalletProvider.getClient.mockReturnValue(mockCdpClient);
-            const mockAccount = { swap: jest.fn() };
-            mockCdpClient.evm.getAccount.mockResolvedValue(mockAccount);
-            mockAccount.swap.mockResolvedValue({
-                transactionHash: "0xswap123456",
-            });
-            const result = await actionProvider.swap(mockWalletProvider, {
-                fromAssetId: "eth",
-                toAssetId: "usdc",
-                amount: "0.1",
-            });
-            expect(mockCdpClient.evm.getAccount).toHaveBeenCalledWith({
-                address: "0x123456789",
-            });
-            expect(mockAccount.swap).toHaveBeenCalledWith({
-                network: "base-sepolia",
-                from: "eth",
-                to: "usdc",
-                amount: "0.1",
-                slippageBps: 100,
-            });
-            expect(result).toContain("Successfully swapped 0.1 ETH to USDC");
-            expect(result).toContain("0xswap123456");
-        });
-        it("should perform swap on base-mainnet", async () => {
-            const mockNetwork = { protocolFamily: "evm", networkId: "base-mainnet" };
-            mockWalletProvider.getNetwork.mockReturnValue(mockNetwork);
-            mockWalletProvider.getAddress.mockReturnValue("0x123456789");
-            mockWalletProvider.getClient.mockReturnValue(mockCdpClient);
-            const mockAccount = { swap: jest.fn() };
-            mockCdpClient.evm.getAccount.mockResolvedValue(mockAccount);
-            mockAccount.swap.mockResolvedValue({
-                transactionHash: "0xswap789",
-            });
-            const result = await actionProvider.swap(mockWalletProvider, {
-                fromAssetId: "usdc",
-                toAssetId: "eth",
-                amount: "100",
-            });
-            expect(mockAccount.swap).toHaveBeenCalledWith({
-                network: "base", // Should convert base-mainnet to base
-                from: "usdc",
-                to: "eth",
-                amount: "100",
-                slippageBps: 100,
-            });
-            expect(result).toContain("Successfully swapped 100 USDC to ETH");
-        });
-        it("should throw error for non-EVM networks", async () => {
-            const mockNetwork = { protocolFamily: "svm", networkId: "solana-devnet" };
-            mockWalletProvider.getNetwork.mockReturnValue(mockNetwork);
-            mockWalletProvider.getClient.mockReturnValue(mockCdpClient);
-            await expect(actionProvider.swap(mockWalletProvider, {
-                fromAssetId: "sol",
-                toAssetId: "usdc",
-                amount: "1",
-            })).rejects.toThrow("Swap is currently only supported on EVM networks");
-        });
-        it("should throw error for wallet provider without client", async () => {
-            const mockWalletWithoutClient = {
-                getNetwork: jest.fn().mockReturnValue({ protocolFamily: "evm", networkId: "base-sepolia" }),
-            };
-            await expect(actionProvider.swap(mockWalletWithoutClient, {
-                fromAssetId: "eth",
-                toAssetId: "usdc",
-                amount: "0.1",
-            })).rejects.toThrow("Wallet provider is not a CDP Wallet Provider");
-        });
-        it("should handle swap errors", async () => {
-            const mockNetwork = { protocolFamily: "evm", networkId: "base-sepolia" };
-            mockWalletProvider.getNetwork.mockReturnValue(mockNetwork);
-            mockWalletProvider.getAddress.mockReturnValue("0x123456789");
-            mockWalletProvider.getClient.mockReturnValue(mockCdpClient);
-            const mockAccount = { swap: jest.fn() };
-            mockCdpClient.evm.getAccount.mockResolvedValue(mockAccount);
-            mockAccount.swap.mockRejectedValue(new Error("Insufficient liquidity"));
-            await expect(actionProvider.swap(mockWalletProvider, {
-                fromAssetId: "eth",
-                toAssetId: "usdc",
-                amount: "1000",
-            })).rejects.toThrow("Swap failed: Error: Insufficient liquidity");
-        });
-    });
     describe("RequestFaucetFundsV2Schema", () => {
         it("should validate correct input", () => {
             const validInput = { assetId: "eth" };
@@ -193,35 +99,4 @@ describe("CDP API Action Provider", () => {
             expect(result.success).toBe(true);
         });
     });
-    describe("SwapSchema", () => {
-        it("should validate correct swap input", () => {
-            const validInput = {
-                fromAssetId: "eth",
-                toAssetId: "usdc",
-                amount: "0.1",
-            };
-            const result = schemas_1.SwapSchema.safeParse(validInput);
-            expect(result.success).toBe(true);
-            expect(result.data).toEqual(validInput);
-        });
-        it("should validate swap input with network", () => {
-            const validInput = {
-                fromAssetId: "usdc",
-                toAssetId: "eth",
-                amount: "100",
-                network: "base-sepolia",
-            };
-            const result = schemas_1.SwapSchema.safeParse(validInput);
-            expect(result.success).toBe(true);
-            expect(result.data).toEqual(validInput);
-        });
-        it("should fail validation when missing required fields", () => {
-            const invalidInput = {
-                fromAssetId: "eth",
-                // missing toAssetId and amount
-            };
-            const result = schemas_1.SwapSchema.safeParse(invalidInput);
-            expect(result.success).toBe(false);
-        });
-    });
 });

package/dist/action-providers/cdp/cdpEvmWalletActionProvider.d.ts

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { WalletProvider } from "../../wallet-providers";
 import { CdpEvmWalletProvider } from "../../wallet-providers/cdpEvmWalletProvider";
 import { ActionProvider } from "../actionProvider";
-import { UseSpendPermissionSchema, ListSpendPermissionsSchema } from "./schemas";
+import { UseSpendPermissionSchema, ListSpendPermissionsSchema, SwapSchema } from "./schemas";
 import type { Network } from "../../network";
 /**
  * CdpEvmWalletActionProvider is an action provider for CDP EVM Wallet specific actions.
@@ -11,7 +11,6 @@ import type { Network } from "../../network";
  * that are optimized for EVM functionality, including spend permission usage.
  */
 export declare class CdpEvmWalletActionProvider extends ActionProvider<CdpEvmWalletProvider> {
-    #private;
     /**
      * Constructor for the CdpEvmWalletActionProvider class.
      */
@@ -31,7 +30,23 @@ export declare class CdpEvmWalletActionProvider extends ActionProvider<CdpEvmWal
      * @param args - The input arguments for using the spend permission.
      * @returns A confirmation message with transaction details.
      */
-    useSpendPermission(walletProvider: WalletProvider, args: z.infer<typeof UseSpendPermissionSchema>): Promise<string>;
+    useSpendPermission(walletProvider: CdpEvmWalletProvider, args: z.infer<typeof UseSpendPermissionSchema>): Promise<string>;
+    /**
+     * Gets a price quote for swapping tokens using the CDP Swap API.
+     *
+     * @param walletProvider - The EVM wallet provider to get the quote for.
+     * @param args - The input arguments for the swap price action.
+     * @returns A JSON string with detailed swap price quote information.
+     */
+    getSwapPrice(walletProvider: CdpEvmWalletProvider, args: z.infer<typeof SwapSchema>): Promise<string>;
+    /**
+     * Swaps tokens using the CDP client.
+     *
+     * @param walletProvider - The EVM wallet provider to perform the swap with.
+     * @param args - The input arguments for the swap action.
+     * @returns A JSON string with detailed swap execution information.
+     */
+    swap(walletProvider: CdpEvmWalletProvider, args: z.infer<typeof SwapSchema>): Promise<string>;
     /**
      * Checks if the EVM wallet action provider supports the given network.
      *