@coinbase/agentkit 0.1.0

package/dist/wallet-providers/viemWalletProvider.js

@@ -0,0 +1,187 @@
+"use strict";
+// TODO: Improve type safety
+/* eslint-disable @typescript-eslint/no-explicit-any */
+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 _ViemWalletProvider_walletClient, _ViemWalletProvider_publicClient;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ViemWalletProvider = void 0;
+const viem_1 = require("viem");
+const evmWalletProvider_1 = require("./evmWalletProvider");
+const network_1 = require("../network/network");
+/**
+ * A wallet provider that uses the Viem library.
+ */
+class ViemWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
+    /**
+     * Constructs a new ViemWalletProvider.
+     *
+     * @param walletClient - The wallet client.
+     */
+    constructor(walletClient) {
+        super();
+        _ViemWalletProvider_walletClient.set(this, void 0);
+        _ViemWalletProvider_publicClient.set(this, void 0);
+        __classPrivateFieldSet(this, _ViemWalletProvider_walletClient, walletClient, "f");
+        __classPrivateFieldSet(this, _ViemWalletProvider_publicClient, (0, viem_1.createPublicClient)({
+            chain: walletClient.chain,
+            transport: (0, viem_1.http)(),
+        }), "f");
+    }
+    /**
+     * Signs a message.
+     *
+     * @param message - The message to sign.
+     * @returns The signed message.
+     */
+    async signMessage(message) {
+        const account = __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account;
+        if (!account) {
+            throw new Error("Account not found");
+        }
+        return __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").signMessage({ account, message });
+    }
+    /**
+     * Signs a typed data object.
+     *
+     * @param typedData - The typed data object to sign.
+     * @returns The signed typed data object.
+     */
+    async signTypedData(typedData) {
+        return __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").signTypedData({
+            account: __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account,
+            domain: typedData.domain,
+            types: typedData.types,
+            primaryType: typedData.primaryType,
+            message: typedData.message,
+        });
+    }
+    /**
+     * Signs a transaction.
+     *
+     * @param transaction - The transaction to sign.
+     * @returns The signed transaction.
+     */
+    async signTransaction(transaction) {
+        const txParams = {
+            account: __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account,
+            to: transaction.to,
+            value: transaction.value,
+            data: transaction.data,
+            chain: __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").chain,
+        };
+        return __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").signTransaction(txParams);
+    }
+    /**
+     * Sends a transaction.
+     *
+     * @param transaction - The transaction to send.
+     * @returns The hash of the transaction.
+     */
+    async sendTransaction(transaction) {
+        const account = __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account;
+        if (!account) {
+            throw new Error("Account not found");
+        }
+        const chain = __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").chain;
+        if (!chain) {
+            throw new Error("Chain not found");
+        }
+        const txParams = {
+            account: account,
+            chain: chain,
+            data: transaction.data,
+            to: transaction.to,
+            value: transaction.value,
+        };
+        return __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").sendTransaction(txParams);
+    }
+    /**
+     * Gets the address of the wallet.
+     *
+     * @returns The address of the wallet.
+     */
+    getAddress() {
+        return __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account?.address ?? "";
+    }
+    /**
+     * Gets the network of the wallet.
+     *
+     * @returns The network of the wallet.
+     */
+    getNetwork() {
+        return {
+            protocolFamily: "evm",
+            chainId: __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").chain.id,
+            networkId: network_1.CHAIN_ID_TO_NETWORK_ID[__classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").chain.id],
+        };
+    }
+    /**
+     * Gets the name of the wallet provider.
+     *
+     * @returns The name of the wallet provider.
+     */
+    getName() {
+        return "viem_wallet_provider";
+    }
+    /**
+     * Gets the balance of the wallet.
+     *
+     * @returns The balance of the wallet.
+     */
+    async getBalance() {
+        const account = __classPrivateFieldGet(this, _ViemWalletProvider_walletClient, "f").account;
+        if (!account) {
+            throw new Error("Account not found");
+        }
+        return __classPrivateFieldGet(this, _ViemWalletProvider_publicClient, "f").getBalance({ address: account.address });
+    }
+    /**
+     * Waits for a transaction receipt.
+     *
+     * @param txHash - The hash of the transaction to wait for.
+     * @returns The transaction receipt.
+     */
+    async waitForTransactionReceipt(txHash) {
+        return await __classPrivateFieldGet(this, _ViemWalletProvider_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, _ViemWalletProvider_publicClient, "f").readContract(params);
+    }
+    /**
+     * Transfer the native asset of the network.
+     *
+     * @param to - The destination address.
+     * @param value - The amount to transfer in whole units (e.g. ETH)
+     * @returns The transaction hash.
+     */
+    async nativeTransfer(to, value) {
+        const atomicAmount = (0, viem_1.parseEther)(value);
+        const tx = await this.sendTransaction({
+            to: to,
+            value: atomicAmount,
+        });
+        const receipt = await this.waitForTransactionReceipt(tx);
+        if (!receipt) {
+            throw new Error("Transaction failed");
+        }
+        return receipt.transactionHash;
+    }
+}
+exports.ViemWalletProvider = ViemWalletProvider;
+_ViemWalletProvider_walletClient = new WeakMap(), _ViemWalletProvider_publicClient = new WeakMap();

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

@@ -0,0 +1,48 @@
+import { Network } from "../network";
+/**
+ * WalletProvider is the abstract base class for all wallet providers.
+ *
+ * @abstract
+ */
+export declare abstract class WalletProvider {
+    /**
+     * Initializes the wallet provider.
+     */
+    constructor();
+    /**
+     * Tracks the initialization of the wallet provider.
+     */
+    private trackInitialization;
+    /**
+     * Get the address of the wallet provider.
+     *
+     * @returns The address of the wallet provider.
+     */
+    abstract getAddress(): string;
+    /**
+     * Get the network of the wallet provider.
+     *
+     * @returns The network of the wallet provider.
+     */
+    abstract getNetwork(): Network;
+    /**
+     * Get the name of the wallet provider.
+     *
+     * @returns The name of the wallet provider.
+     */
+    abstract getName(): string;
+    /**
+     * Get the balance of the native asset of the network.
+     *
+     * @returns The balance of the native asset of the network.
+     */
+    abstract getBalance(): Promise<bigint>;
+    /**
+     * Transfer the native asset of the network.
+     *
+     * @param to - The destination address.
+     * @param value - The amount to transfer in whole units (e.g. ETH)
+     * @returns The transaction hash.
+     */
+    abstract nativeTransfer(to: `0x${string}`, value: string): Promise<`0x${string}`>;
+}

package/dist/wallet-providers/walletProvider.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WalletProvider = void 0;
+const analytics_1 = require("../analytics");
+/**
+ * WalletProvider is the abstract base class for all wallet providers.
+ *
+ * @abstract
+ */
+class WalletProvider {
+    /**
+     * Initializes the wallet provider.
+     */
+    constructor() {
+        // Wait for the next tick to ensure child class is initialized
+        Promise.resolve().then(() => {
+            this.trackInitialization();
+        });
+    }
+    /**
+     * Tracks the initialization of the wallet provider.
+     */
+    trackInitialization() {
+        try {
+            (0, analytics_1.sendAnalyticsEvent)({
+                name: "agent_initialization",
+                action: "initialize_wallet_provider",
+                component: "wallet_provider",
+                wallet_provider: this.getName(),
+                wallet_address: this.getAddress(),
+                network_id: this.getNetwork().networkId,
+                chain_id: this.getNetwork().chainId,
+                protocol_family: this.getNetwork().protocolFamily,
+            });
+        }
+        catch (error) {
+            console.warn("Failed to track wallet provider initialization:", error);
+        }
+    }
+}
+exports.WalletProvider = WalletProvider;

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@coinbase/agentkit",
+  "description": "Coinbase AgentKit core primitives",
+  "repository": "https://github.com/coinbase/agentkit",
+  "version": "0.1.0",
+  "author": "Coinbase Inc.",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint -c .eslintrc.json \"src/**/*.ts\"",
+    "lint:fix": "eslint -c .eslintrc.json \"src/**/*.ts\" --fix",
+    "format": "prettier -c .prettierrc --write \"**/*.{ts,js,cjs,json,md}\"",
+    "format:check": "prettier -c .prettierrc --check \"**/*.{ts,js,cjs,json,md}\"",
+    "check": "tsc --noEmit",
+    "test": "npx jest --no-cache --testMatch='**/*.test.ts'",
+    "test:dry-run": "npm install && npm ci && npm publish --dry-run",
+    "test:e2e": "npx jest --no-cache --testMatch=**/e2e.ts --coverageThreshold '{}'",
+    "test:types": "tsd --files src/tests/types.test-d.ts",
+    "clean": "rm -rf dist/*",
+    "prepack": "tsc",
+    "docs": "typedoc --entryPoints ./src --entryPointStrategy expand --exclude ./src/tests/**/*.ts",
+    "docs:serve": "http-server ./docs",
+    "dev": "tsc --watch"
+  },
+  "keywords": [
+    "coinbase",
+    "sdk",
+    "crypto",
+    "cdp",
+    "agentkit",
+    "ai",
+    "agent",
+    "nodejs",
+    "typescript"
+  ],
+  "dependencies": {
+    "@coinbase/coinbase-sdk": "^0.17.0",
+    "md5": "^2.3.0",
+    "reflect-metadata": "^0.2.2",
+    "twitter-api-v2": "^1.18.2",
+    "viem": "^2.22.16",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/secp256k1": "^4.0.6",
+    "http-server": "^14.1.1",
+    "jest": "^29.7.0",
+    "mock-fs": "^5.2.0",
+    "ts-jest": "^29.2.5",
+    "tsd": "^0.31.2",
+    "typescript": "^5.7.2"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  }
+}