@coinbase/agentkit 0.6.1 → 0.7.0

package/dist/action-providers/zerodev/zeroDevWalletActionProvider.test.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const zeroDevWalletActionProvider_1 = require("./zeroDevWalletActionProvider");
+const schemas_1 = require("./schemas");
+describe("ZeroDev Wallet Action Provider Input Schemas", () => {
+    describe("Get CAB Schema", () => {
+        it("should successfully parse valid input with network type", () => {
+            const validInput = {
+                type: "networkType",
+                tokenTickers: ["ETH", "USDC"],
+                networkType: "mainnet",
+            };
+            const result = schemas_1.GetCABSchema.safeParse(validInput);
+            expect(result.success).toBe(true);
+            expect(result.data).toEqual(validInput);
+        });
+        it("should successfully parse valid input with network filter", () => {
+            const validInput = {
+                type: "networkFilter",
+                tokenTickers: ["ETH", "USDC"],
+                networks: [1, 8453], // ethereum and base network IDs
+            };
+            const result = schemas_1.GetCABSchema.safeParse(validInput);
+            expect(result.success).toBe(true);
+            expect(result.data).toEqual(validInput);
+        });
+        it("should successfully parse input with optional tokenTickers omitted", () => {
+            const validInput = {
+                type: "networkType",
+                networkType: "mainnet",
+            };
+            const result = schemas_1.GetCABSchema.safeParse(validInput);
+            expect(result.success).toBe(true);
+            expect(result.data).toEqual(validInput);
+        });
+        it("should fail parsing empty input", () => {
+            const emptyInput = {};
+            const result = schemas_1.GetCABSchema.safeParse(emptyInput);
+            expect(result.success).toBe(false);
+        });
+    });
+});
+describe("ZeroDev Wallet Action Provider", () => {
+    let actionProvider;
+    let mockWallet;
+    beforeEach(() => {
+        // Reset all mocks before each test
+        jest.clearAllMocks();
+        actionProvider = new zeroDevWalletActionProvider_1.ZeroDevWalletActionProvider();
+        mockWallet = {
+            getCAB: jest.fn(),
+            getAddress: jest.fn().mockReturnValue("0xe6b2af36b3bb8d47206a129ff11d5a2de2a63c83"),
+            getNetwork: jest.fn().mockReturnValue({ networkId: "ethereum-mainnet" }),
+        };
+    });
+    describe("getCAB", () => {
+        const MOCK_BALANCES = {
+            balance: BigInt(1000000000000000000),
+            tokenAddress: "0x1234567890123456789012345678901234567890",
+            tokens: {
+                ETH: {
+                    ethereum: "1.5",
+                    base: "0.5",
+                },
+                USDC: {
+                    ethereum: "1000",
+                    base: "500",
+                },
+            },
+        };
+        beforeEach(() => {
+            mockWallet.getCAB.mockResolvedValue(MOCK_BALANCES);
+        });
+        it("should successfully get chain abstracted balances with network type", async () => {
+            const args = {
+                type: "networkType",
+                tokenTickers: ["ETH", "USDC"],
+                networkType: "mainnet",
+            };
+            const result = await actionProvider.getCAB(mockWallet, args);
+            expect(mockWallet.getCAB).toHaveBeenCalledWith(args);
+            expect(result).toEqual(MOCK_BALANCES);
+        });
+        it("should successfully get chain abstracted balances with network filter", async () => {
+            const args = {
+                type: "networkFilter",
+                tokenTickers: ["ETH", "USDC"],
+                networks: [1, 8453], // ethereum and base network IDs
+            };
+            const result = await actionProvider.getCAB(mockWallet, args);
+            expect(mockWallet.getCAB).toHaveBeenCalledWith(args);
+            expect(result).toEqual(MOCK_BALANCES);
+        });
+        it("should handle errors when getting balances", async () => {
+            const args = {
+                type: "networkType",
+                networkType: "mainnet",
+            };
+            const error = new Error("Failed to get balances");
+            mockWallet.getCAB.mockRejectedValue(error);
+            await expect(actionProvider.getCAB(mockWallet, args)).rejects.toThrow(error);
+        });
+    });
+    describe("supportsNetwork", () => {
+        it("should return true when protocolFamily is evm", () => {
+            expect(actionProvider.supportsNetwork({ protocolFamily: "evm" })).toBe(true);
+        });
+        it("should return false when protocolFamily is not evm", () => {
+            expect(actionProvider.supportsNetwork({ protocolFamily: "solana" })).toBe(false);
+        });
+    });
+});

package/dist/network/svm.d.ts

@@ -3,6 +3,7 @@ export declare const SOLANA_MAINNET_NETWORK_ID = "solana-mainnet";
 export declare const SOLANA_TESTNET_NETWORK_ID = "solana-testnet";
 export declare const SOLANA_DEVNET_NETWORK_ID = "solana-devnet";
 export type SOLANA_NETWORK_ID = typeof SOLANA_MAINNET_NETWORK_ID | typeof SOLANA_TESTNET_NETWORK_ID | typeof SOLANA_DEVNET_NETWORK_ID;
+export declare const SOLANA_NETWORK_IDS: SOLANA_NETWORK_ID[];
 export declare const SOLANA_PROTOCOL_FAMILY = "svm";
 export declare const SOLANA_MAINNET_GENESIS_BLOCK_HASH = "5eykt4UsFv8P8NJdTREpY1vzqKqZKvdpKuc147dw2N9d";
 export declare const SOLANA_TESTNET_GENESIS_BLOCK_HASH = "4uhcVJyU9pJkvQyS88uRDiswHXSCkY3zQawwpjk2NsNY";

package/dist/network/svm.js

@@ -1,10 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SOLANA_CLUSTER_ID_BY_NETWORK_ID = exports.SOLANA_NETWORKS = exports.SOLANA_DEVNET_NETWORK = exports.SOLANA_TESTNET_NETWORK = exports.SOLANA_MAINNET_NETWORK = exports.SOLANA_DEVNET_GENESIS_BLOCK_HASH = exports.SOLANA_TESTNET_GENESIS_BLOCK_HASH = exports.SOLANA_MAINNET_GENESIS_BLOCK_HASH = exports.SOLANA_PROTOCOL_FAMILY = exports.SOLANA_DEVNET_NETWORK_ID = exports.SOLANA_TESTNET_NETWORK_ID = exports.SOLANA_MAINNET_NETWORK_ID = void 0;
+exports.SOLANA_CLUSTER_ID_BY_NETWORK_ID = exports.SOLANA_NETWORKS = exports.SOLANA_DEVNET_NETWORK = exports.SOLANA_TESTNET_NETWORK = exports.SOLANA_MAINNET_NETWORK = exports.SOLANA_DEVNET_GENESIS_BLOCK_HASH = exports.SOLANA_TESTNET_GENESIS_BLOCK_HASH = exports.SOLANA_MAINNET_GENESIS_BLOCK_HASH = exports.SOLANA_PROTOCOL_FAMILY = exports.SOLANA_NETWORK_IDS = exports.SOLANA_DEVNET_NETWORK_ID = exports.SOLANA_TESTNET_NETWORK_ID = exports.SOLANA_MAINNET_NETWORK_ID = void 0;
 // CDP Network IDs
 exports.SOLANA_MAINNET_NETWORK_ID = "solana-mainnet";
 exports.SOLANA_TESTNET_NETWORK_ID = "solana-testnet";
 exports.SOLANA_DEVNET_NETWORK_ID = "solana-devnet";
+exports.SOLANA_NETWORK_IDS = [
+    exports.SOLANA_MAINNET_NETWORK_ID,
+    exports.SOLANA_TESTNET_NETWORK_ID,
+    exports.SOLANA_DEVNET_NETWORK_ID,
+];
 // AgentKit Protocol Family
 exports.SOLANA_PROTOCOL_FAMILY = "svm";
 // Chain IDs - Genesis Block Hashes

package/dist/wallet-providers/cdpV2EvmWalletProvider.d.ts

@@ -0,0 +1,105 @@
+import { CdpClient } from "@coinbase/cdp-sdk";
+import { Abi, Address, ContractFunctionArgs, ContractFunctionName, Hex, ReadContractParameters, ReadContractReturnType, TransactionRequest } from "viem";
+import { Network } from "../network";
+import { EvmWalletProvider } from "./evmWalletProvider";
+import { WalletProviderWithClient, CdpV2WalletProviderConfig } from "./cdpV2Shared";
+/**
+ * A wallet provider that uses the Coinbase SDK.
+ */
+export declare class CdpV2EvmWalletProvider extends EvmWalletProvider implements WalletProviderWithClient {
+    #private;
+    /**
+     * Constructs a new CdpWalletProvider.
+     *
+     * @param config - The configuration options for the CdpWalletProvider.
+     */
+    private constructor();
+    /**
+     * Configures a new CdpWalletProvider with a wallet.
+     *
+     * @param config - Optional configuration parameters
+     * @returns A Promise that resolves to a new CdpWalletProvider instance
+     * @throws Error if required environment variables are missing or wallet initialization fails
+     */
+    static configureWithWallet(config?: CdpV2WalletProviderConfig): Promise<CdpV2EvmWalletProvider>;
+    /**
+     * Signs a message.
+     *
+     * @param message - The message to sign.
+     * @returns The signed message.
+     */
+    signMessage(message: string): Promise<Hex>;
+    /**
+     * Signs a typed data object.
+     *
+     * @param typedData - The typed data object to sign.
+     * @returns The signed typed data object.
+     */
+    signTypedData(typedData: any): Promise<Hex>;
+    /**
+     * Signs a transaction.
+     *
+     * @param transaction - The transaction to sign.
+     * @returns The signed transaction.
+     */
+    signTransaction(transaction: TransactionRequest): Promise<Hex>;
+    /**
+     * Sends a transaction.
+     *
+     * @param transaction - The transaction to send.
+     * @returns The hash of the transaction.
+     */
+    sendTransaction(transaction: TransactionRequest): Promise<Hex>;
+    /**
+     * Gets the address of the wallet.
+     *
+     * @returns The address of the wallet.
+     */
+    getAddress(): string;
+    /**
+     * Gets the network of the wallet.
+     *
+     * @returns The network of the wallet.
+     */
+    getNetwork(): Network;
+    /**
+     * Gets the name of the wallet provider.
+     *
+     * @returns The name of the wallet provider.
+     */
+    getName(): string;
+    /**
+     * Gets the CDP client.
+     *
+     * @returns The CDP client.
+     */
+    getClient(): CdpClient;
+    /**
+     * Gets the balance of the wallet.
+     *
+     * @returns The balance of the wallet in wei
+     */
+    getBalance(): Promise<bigint>;
+    /**
+     * Waits for a transaction receipt.
+     *
+     * @param txHash - The hash of the transaction to wait for.
+     * @returns The transaction receipt.
+     */
+    waitForTransactionReceipt(txHash: Hex): Promise<any>;
+    /**
+     * Reads a contract.
+     *
+     * @param params - The parameters to read the contract.
+     * @returns The response from the contract.
+     */
+    readContract<const abi extends Abi | readonly unknown[], functionName extends ContractFunctionName<abi, "pure" | "view">, const args extends ContractFunctionArgs<abi, "pure" | "view", functionName>>(params: ReadContractParameters<abi, functionName, args>): Promise<ReadContractReturnType<abi, functionName, args>>;
+    /**
+     * Transfer the native asset of the network.
+     *
+     * @param to - The destination address.
+     * @param value - The amount to transfer in Wei.
+     * @returns The transaction hash.
+     */
+    nativeTransfer(to: Address, value: string): Promise<Hex>;
+}

package/dist/wallet-providers/cdpV2EvmWalletProvider.js

@@ -0,0 +1,212 @@
+"use strict";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+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 _CdpV2EvmWalletProvider_instances, _CdpV2EvmWalletProvider_publicClient, _CdpV2EvmWalletProvider_serverAccount, _CdpV2EvmWalletProvider_cdp, _CdpV2EvmWalletProvider_network, _CdpV2EvmWalletProvider_getCdpSdkNetwork;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CdpV2EvmWalletProvider = void 0;
+const cdp_sdk_1 = require("@coinbase/cdp-sdk");
+const viem_1 = require("viem");
+const network_1 = require("../network");
+const evmWalletProvider_1 = require("./evmWalletProvider");
+/**
+ * A wallet provider that uses the Coinbase SDK.
+ */
+class CdpV2EvmWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
+    /**
+     * Constructs a new CdpWalletProvider.
+     *
+     * @param config - The configuration options for the CdpWalletProvider.
+     */
+    constructor(config) {
+        super();
+        _CdpV2EvmWalletProvider_instances.add(this);
+        _CdpV2EvmWalletProvider_publicClient.set(this, void 0);
+        _CdpV2EvmWalletProvider_serverAccount.set(this, void 0);
+        _CdpV2EvmWalletProvider_cdp.set(this, void 0);
+        _CdpV2EvmWalletProvider_network.set(this, void 0);
+        __classPrivateFieldSet(this, _CdpV2EvmWalletProvider_serverAccount, config.serverAccount, "f");
+        __classPrivateFieldSet(this, _CdpV2EvmWalletProvider_cdp, config.cdp, "f");
+        __classPrivateFieldSet(this, _CdpV2EvmWalletProvider_publicClient, config.publicClient, "f");
+        __classPrivateFieldSet(this, _CdpV2EvmWalletProvider_network, config.network, "f");
+    }
+    /**
+     * Configures a new CdpWalletProvider with a wallet.
+     *
+     * @param config - Optional configuration parameters
+     * @returns A Promise that resolves to a new CdpWalletProvider instance
+     * @throws Error if required environment variables are missing or wallet initialization fails
+     */
+    static async configureWithWallet(config = {}) {
+        const apiKeyId = config.apiKeyId || process.env.CDP_API_KEY_ID;
+        const apiKeySecret = config.apiKeySecret || process.env.CDP_API_KEY_SECRET;
+        const walletSecret = config.walletSecret || process.env.CDP_WALLET_SECRET;
+        const idempotencyKey = config.idempotencyKey || process.env.IDEMPOTENCY_KEY;
+        if (!apiKeyId || !apiKeySecret || !walletSecret) {
+            throw new Error("Missing required environment variables. CDP_API_KEY_ID, CDP_API_KEY_SECRET, CDP_WALLET_SECRET are required.");
+        }
+        const networkId = config.networkId || process.env.NETWORK_ID || "base-sepolia";
+        const network = {
+            protocolFamily: "evm",
+            chainId: network_1.NETWORK_ID_TO_CHAIN_ID[networkId],
+            networkId: networkId,
+        };
+        const cdpClient = new cdp_sdk_1.CdpClient({
+            apiKeyId,
+            apiKeySecret,
+            walletSecret,
+        });
+        const serverAccount = await (config.address
+            ? cdpClient.evm.getAccount({ address: config.address })
+            : cdpClient.evm.createAccount({ idempotencyKey }));
+        const publicClient = (0, viem_1.createPublicClient)({
+            chain: network_1.NETWORK_ID_TO_VIEM_CHAIN[networkId],
+            transport: (0, viem_1.http)(),
+        });
+        return new CdpV2EvmWalletProvider({
+            publicClient,
+            cdp: cdpClient,
+            serverAccount,
+            network,
+        });
+    }
+    /**
+     * Signs a message.
+     *
+     * @param message - The message to sign.
+     * @returns The signed message.
+     */
+    async signMessage(message) {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").signMessage({ message });
+    }
+    /**
+     * Signs a typed data object.
+     *
+     * @param typedData - The typed data object to sign.
+     * @returns The signed typed data object.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async signTypedData(typedData) {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").signTypedData(typedData);
+    }
+    /**
+     * Signs a transaction.
+     *
+     * @param transaction - The transaction to sign.
+     * @returns The signed transaction.
+     */
+    async signTransaction(transaction) {
+        const serializedTx = (0, viem_1.serializeTransaction)(transaction);
+        const signedTx = await __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_cdp, "f").evm.signTransaction({
+            address: __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").address,
+            transaction: serializedTx,
+        });
+        return signedTx.signature;
+    }
+    /**
+     * Sends a transaction.
+     *
+     * @param transaction - The transaction to send.
+     * @returns The hash of the transaction.
+     */
+    async sendTransaction(transaction) {
+        const result = await __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_cdp, "f").evm.sendTransaction({
+            address: __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").address,
+            transaction: (0, viem_1.serializeTransaction)(transaction),
+            network: __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_instances, "m", _CdpV2EvmWalletProvider_getCdpSdkNetwork).call(this),
+        });
+        return result.transactionHash;
+    }
+    /**
+     * Gets the address of the wallet.
+     *
+     * @returns The address of the wallet.
+     */
+    getAddress() {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").address;
+    }
+    /**
+     * Gets the network of the wallet.
+     *
+     * @returns The network of the wallet.
+     */
+    getNetwork() {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_network, "f");
+    }
+    /**
+     * Gets the name of the wallet provider.
+     *
+     * @returns The name of the wallet provider.
+     */
+    getName() {
+        return "cdp_v2_wallet_provider";
+    }
+    /**
+     * Gets the CDP client.
+     *
+     * @returns The CDP client.
+     */
+    getClient() {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_cdp, "f");
+    }
+    /**
+     * Gets the balance of the wallet.
+     *
+     * @returns The balance of the wallet in wei
+     */
+    async getBalance() {
+        return await __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_publicClient, "f").getBalance({ address: __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_serverAccount, "f").address });
+    }
+    /**
+     * Waits for a transaction receipt.
+     *
+     * @param txHash - The hash of the transaction to wait for.
+     * @returns The transaction receipt.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async waitForTransactionReceipt(txHash) {
+        return await __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_publicClient, "f").waitForTransactionReceipt({ hash: txHash });
+    }
+    /**
+     * Reads a contract.
+     *
+     * @param params - The parameters to read the contract.
+     * @returns The response from the contract.
+     */
+    async readContract(params) {
+        return __classPrivateFieldGet(this, _CdpV2EvmWalletProvider_publicClient, "f").readContract(params);
+    }
+    /**
+     * Transfer the native asset of the network.
+     *
+     * @param to - The destination address.
+     * @param value - The amount to transfer in Wei.
+     * @returns The transaction hash.
+     */
+    async nativeTransfer(to, value) {
+        return this.sendTransaction({
+            to: to,
+            value: BigInt(value),
+            data: "0x",
+        });
+    }
+}
+exports.CdpV2EvmWalletProvider = CdpV2EvmWalletProvider;
+_CdpV2EvmWalletProvider_publicClient = new WeakMap(), _CdpV2EvmWalletProvider_serverAccount = new WeakMap(), _CdpV2EvmWalletProvider_cdp = new WeakMap(), _CdpV2EvmWalletProvider_network = new WeakMap(), _CdpV2EvmWalletProvider_instances = new WeakSet(), _CdpV2EvmWalletProvider_getCdpSdkNetwork = function _CdpV2EvmWalletProvider_getCdpSdkNetwork() {
+    switch (__classPrivateFieldGet(this, _CdpV2EvmWalletProvider_network, "f").networkId) {
+        case "base-sepolia":
+            return "base-sepolia";
+        case "base-mainnet":
+            return "base";
+        default:
+            throw new Error(`Unsupported network: ${__classPrivateFieldGet(this, _CdpV2EvmWalletProvider_network, "f").networkId}`);
+    }
+};

package/dist/wallet-providers/cdpV2EvmWalletProvider.test.d.ts

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