@coinbase/agentkit 0.2.3 → 0.4.0

package/dist/action-providers/opensea/openseaActionProvider.test.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const opensea_js_1 = require("opensea-js");
+const openseaActionProvider_1 = require("./openseaActionProvider");
+jest.mock("opensea-js");
+describe("OpenSea Action Provider", () => {
+    const MOCK_API_KEY = "test-api-key";
+    const MOCK_PRIVATE_KEY = "1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef";
+    const MOCK_CONTRACT = "0x1234567890123456789012345678901234567890";
+    const MOCK_TOKEN_ID = "1";
+    const MOCK_PRICE = 0.1;
+    const MOCK_EXPIRATION_DAYS = 90;
+    const MOCK_OPENSEA_BASE_URL = "https://testnets.opensea.io";
+    const MOCK_OPENSEA_CHAIN = "base_sepolia";
+    let actionProvider;
+    beforeEach(() => {
+        jest.clearAllMocks();
+        // Mock OpenSeaSDK constructor
+        opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+            createListing: jest.fn(),
+            api: {
+                apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                getNFTsByAccount: jest.fn(),
+            },
+            chain: MOCK_OPENSEA_CHAIN,
+        }));
+        actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+            apiKey: MOCK_API_KEY,
+            privateKey: MOCK_PRIVATE_KEY,
+            networkId: "base-sepolia",
+        });
+    });
+    describe("listNft", () => {
+        it("should successfully list an NFT", async () => {
+            const mockListing = {};
+            const mockCreateListing = jest.fn().mockResolvedValue(mockListing);
+            // Update the mock implementation with the mock function
+            opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+                createListing: mockCreateListing,
+                api: {
+                    apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                },
+                chain: MOCK_OPENSEA_CHAIN,
+            }));
+            // Re-create provider with new mock
+            actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+                apiKey: MOCK_API_KEY,
+                privateKey: MOCK_PRIVATE_KEY,
+                networkId: "base-sepolia",
+            });
+            const args = {
+                contractAddress: MOCK_CONTRACT,
+                tokenId: MOCK_TOKEN_ID,
+                price: MOCK_PRICE,
+                expirationDays: MOCK_EXPIRATION_DAYS,
+            };
+            const response = await actionProvider.listNft(args);
+            expect(mockCreateListing).toHaveBeenCalledWith(expect.objectContaining({
+                asset: {
+                    tokenId: MOCK_TOKEN_ID,
+                    tokenAddress: MOCK_CONTRACT,
+                },
+                startAmount: MOCK_PRICE,
+                quantity: 1,
+            }));
+            expect(response).toBe(`Successfully listed NFT ${MOCK_CONTRACT} token ${MOCK_TOKEN_ID} for ${MOCK_PRICE} ETH, expiring in ${MOCK_EXPIRATION_DAYS} days. Listing on OpenSea: ${MOCK_OPENSEA_BASE_URL}/assets/${MOCK_OPENSEA_CHAIN}/${MOCK_CONTRACT}/${MOCK_TOKEN_ID}.`);
+        });
+        it("should handle listing errors", async () => {
+            const error = new Error("Listing failed");
+            const mockCreateListing = jest.fn().mockRejectedValue(error);
+            // Update the mock implementation with the mock function
+            opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+                createListing: mockCreateListing,
+                api: {
+                    apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                },
+                chain: MOCK_OPENSEA_CHAIN,
+            }));
+            // Re-create provider with new mock
+            actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+                apiKey: MOCK_API_KEY,
+                privateKey: MOCK_PRIVATE_KEY,
+                networkId: "base-sepolia",
+            });
+            const args = {
+                contractAddress: MOCK_CONTRACT,
+                tokenId: MOCK_TOKEN_ID,
+                price: MOCK_PRICE,
+                expirationDays: MOCK_EXPIRATION_DAYS,
+            };
+            const response = await actionProvider.listNft(args);
+            expect(response).toContain(`Error listing NFT ${MOCK_CONTRACT} token ${MOCK_TOKEN_ID}`);
+            expect(response).toContain(error.message);
+        });
+    });
+    describe("getNftsByAccount", () => {
+        const MOCK_WALLET_ADDRESS = "0xabcdef1234567890abcdef1234567890abcdef12";
+        const MOCK_NFTS = [
+            {
+                identifier: "1",
+                contract: MOCK_CONTRACT,
+                name: "Test NFT 1",
+            },
+            {
+                identifier: "2",
+                contract: MOCK_CONTRACT,
+                name: "Test NFT 2",
+            },
+        ];
+        it("should successfully fetch NFTs for the specified account", async () => {
+            const mockGetNFTsByAccount = jest.fn().mockResolvedValue({ nfts: MOCK_NFTS });
+            // Update the mock implementation with the mock function
+            opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+                createListing: jest.fn(),
+                api: {
+                    apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                    getNFTsByAccount: mockGetNFTsByAccount,
+                },
+                chain: MOCK_OPENSEA_CHAIN,
+            }));
+            // Re-create provider with new mock
+            actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+                apiKey: MOCK_API_KEY,
+                privateKey: MOCK_PRIVATE_KEY,
+                networkId: "base-sepolia",
+            });
+            const args = {
+                accountAddress: MOCK_WALLET_ADDRESS,
+            };
+            const response = await actionProvider.getNftsByAccount(args);
+            expect(mockGetNFTsByAccount).toHaveBeenCalledWith(MOCK_WALLET_ADDRESS);
+            expect(response).toBe(JSON.stringify(MOCK_NFTS));
+        });
+        it("should use connected wallet address when no account is specified", async () => {
+            const mockGetNFTsByAccount = jest.fn().mockResolvedValue({ nfts: MOCK_NFTS });
+            // Update the mock implementation with the mock function
+            opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+                createListing: jest.fn(),
+                api: {
+                    apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                    getNFTsByAccount: mockGetNFTsByAccount,
+                },
+                chain: MOCK_OPENSEA_CHAIN,
+            }));
+            // Re-create provider with new mock
+            actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+                apiKey: MOCK_API_KEY,
+                privateKey: MOCK_PRIVATE_KEY,
+                networkId: "base-sepolia",
+            });
+            const args = {}; // No accountAddress provided
+            const response = await actionProvider.getNftsByAccount(args);
+            // Should use the wallet address from the provider
+            expect(mockGetNFTsByAccount).toHaveBeenCalled();
+            expect(response).toBe(JSON.stringify(MOCK_NFTS));
+        });
+        it("should handle errors when fetching NFTs", async () => {
+            const error = new Error("Failed to fetch NFTs");
+            const mockGetNFTsByAccount = jest.fn().mockRejectedValue(error);
+            // Update the mock implementation with the mock function
+            opensea_js_1.OpenSeaSDK.mockImplementation(() => ({
+                createListing: jest.fn(),
+                api: {
+                    apiBaseUrl: MOCK_OPENSEA_BASE_URL,
+                    getNFTsByAccount: mockGetNFTsByAccount,
+                },
+                chain: MOCK_OPENSEA_CHAIN,
+            }));
+            // Re-create provider with new mock
+            actionProvider = (0, openseaActionProvider_1.openseaActionProvider)({
+                apiKey: MOCK_API_KEY,
+                privateKey: MOCK_PRIVATE_KEY,
+                networkId: "base-sepolia",
+            });
+            const args = {
+                accountAddress: MOCK_WALLET_ADDRESS,
+            };
+            const response = await actionProvider.getNftsByAccount(args);
+            expect(mockGetNFTsByAccount).toHaveBeenCalledWith(MOCK_WALLET_ADDRESS);
+            expect(response).toContain(`Error fetching NFTs for account ${MOCK_WALLET_ADDRESS}`);
+            expect(response).toContain(error.message);
+        });
+    });
+    describe("supportsNetwork", () => {
+        it("should return true for supported networks", () => {
+            const baseSepoliaNetwork = {
+                protocolFamily: "evm",
+                networkId: "base-sepolia",
+                chainId: "84532",
+            };
+            expect(actionProvider.supportsNetwork(baseSepoliaNetwork)).toBe(true);
+        });
+        it("should return false for unsupported networks", () => {
+            const fantomNetwork = {
+                protocolFamily: "bitcoin",
+                networkId: "any",
+            };
+            expect(actionProvider.supportsNetwork(fantomNetwork)).toBe(false);
+        });
+    });
+});

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

@@ -0,0 +1,30 @@
+import { z } from "zod";
+/**
+ * Input schema for listing an NFT on OpenSea.
+ */
+export declare const ListNftSchema: z.ZodObject<{
+    contractAddress: z.ZodString;
+    tokenId: z.ZodString;
+    price: z.ZodNumber;
+    expirationDays: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    contractAddress: string;
+    price: number;
+    tokenId: string;
+    expirationDays: number;
+}, {
+    contractAddress: string;
+    price: number;
+    tokenId: string;
+    expirationDays?: number | undefined;
+}>;
+/**
+ * Input schema for getting NFTs from a specific wallet address.
+ */
+export declare const GetNftsByAccountSchema: z.ZodObject<{
+    accountAddress: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    accountAddress?: string | undefined;
+}, {
+    accountAddress?: string | undefined;
+}>;

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

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GetNftsByAccountSchema = exports.ListNftSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Input schema for listing an NFT on OpenSea.
+ */
+exports.ListNftSchema = zod_1.z
+    .object({
+    contractAddress: zod_1.z.string().nonempty().describe("The NFT contract address to list"),
+    tokenId: zod_1.z.string().nonempty().describe("The tokenID of the NFT to list"),
+    price: zod_1.z.number().positive().describe("The price in ETH to list the NFT for"),
+    expirationDays: zod_1.z
+        .number()
+        .positive()
+        .optional()
+        .default(90)
+        .describe("Number of days the listing should be active for (default: 90)"),
+})
+    .strip()
+    .describe("Input schema for listing an NFT on OpenSea");
+/**
+ * Input schema for getting NFTs from a specific wallet address.
+ */
+exports.GetNftsByAccountSchema = zod_1.z
+    .object({
+    accountAddress: zod_1.z
+        .string()
+        .optional()
+        .describe("The wallet address to fetch NFTs for (defaults to connected wallet if not provided)"),
+})
+    .strip()
+    .describe("Input schema for fetching NFTs by account");

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

@@ -0,0 +1,12 @@
+import { Chain } from "opensea-js";
+/**
+ * Supported Opensea chains
+ */
+export declare const supportedChains: Record<string, Chain>;
+/**
+ * Maps EVM chain IDs to Opensea chain
+ *
+ * @param chainId - The EVM chain ID to map
+ * @returns The corresponding OpenSea Chain enum value
+ */
+export declare const chainIdToOpenseaChain: (chainId: string) => Chain;

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

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chainIdToOpenseaChain = exports.supportedChains = void 0;
+const opensea_js_1 = require("opensea-js");
+/**
+ * Supported Opensea chains
+ */
+exports.supportedChains = {
+    "1": opensea_js_1.Chain.Mainnet,
+    "137": opensea_js_1.Chain.Polygon,
+    "80002": opensea_js_1.Chain.Amoy,
+    "11155111": opensea_js_1.Chain.Sepolia,
+    "8217": opensea_js_1.Chain.Klaytn,
+    "1001": opensea_js_1.Chain.Baobab,
+    "43114": opensea_js_1.Chain.Avalanche,
+    "43113": opensea_js_1.Chain.Fuji,
+    "42161": opensea_js_1.Chain.Arbitrum,
+    "42170": opensea_js_1.Chain.ArbitrumNova,
+    "421614": opensea_js_1.Chain.ArbitrumSepolia,
+    "238": opensea_js_1.Chain.Blast,
+    "168587773": opensea_js_1.Chain.BlastSepolia,
+    "8453": opensea_js_1.Chain.Base,
+    "84532": opensea_js_1.Chain.BaseSepolia,
+    "10": opensea_js_1.Chain.Optimism,
+    "11155420": opensea_js_1.Chain.OptimismSepolia,
+    "7777777": opensea_js_1.Chain.Zora,
+    "999999999": opensea_js_1.Chain.ZoraSepolia,
+    "1329": opensea_js_1.Chain.Sei,
+    "1328": opensea_js_1.Chain.SeiTestnet,
+    "8333": opensea_js_1.Chain.B3,
+    "1993": opensea_js_1.Chain.B3Sepolia,
+    "80094": opensea_js_1.Chain.BeraChain,
+};
+/**
+ * Maps EVM chain IDs to Opensea chain
+ *
+ * @param chainId - The EVM chain ID to map
+ * @returns The corresponding OpenSea Chain enum value
+ */
+const chainIdToOpenseaChain = (chainId) => {
+    const chain = exports.supportedChains[chainId];
+    if (!chain) {
+        throw new Error(`Unsupported chain ID on Opensea: ${chainId}`);
+    }
+    return chain;
+};
+exports.chainIdToOpenseaChain = chainIdToOpenseaChain;

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

@@ -227,5 +227,11 @@ export declare class CdpWalletProvider extends EvmWalletProvider {
      * @returns The wallet's data.
      */
     exportWallet(): Promise<WalletData>;
+    /**
+     * Gets the wallet.
+     *
+     * @returns The wallet.
+     */
+    getWallet(): Wallet;
 }
 export {};

package/dist/wallet-providers/cdpWalletProvider.js

@@ -381,6 +381,17 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         }
         return __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f").export();
     }
+    /**
+     * Gets the wallet.
+     *
+     * @returns The wallet.
+     */
+    getWallet() {
+        if (!__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f")) {
+            throw new Error("Wallet not initialized");
+        }
+        return __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f");
+    }
 }
 exports.CdpWalletProvider = CdpWalletProvider;
 _CdpWalletProvider_cdpWallet = new WeakMap(), _CdpWalletProvider_address = new WeakMap(), _CdpWalletProvider_network = new WeakMap(), _CdpWalletProvider_publicClient = new WeakMap(), _CdpWalletProvider_gasLimitMultiplier = new WeakMap(), _CdpWalletProvider_feePerGasMultiplier = new WeakMap();

package/package.json

@@ -2,7 +2,7 @@
   "name": "@coinbase/agentkit",
   "description": "Coinbase AgentKit core primitives",
   "repository": "https://github.com/coinbase/agentkit",
-  "version": "0.2.3",
+  "version": "0.4.0",
   "author": "Coinbase Inc.",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -25,7 +25,8 @@
     "prepack": "tsc",
     "docs": "typedoc --entryPoints ./src --entryPointStrategy expand --exclude ./src/tests/**/*.ts",
     "docs:serve": "http-server ./docs",
-    "dev": "tsc --watch"
+    "dev": "tsc --watch",
+    "generate:action-provider": "tsx ./scripts/generate-action-provider/main.ts"
   },
   "keywords": [
     "coinbase",
@@ -39,12 +40,14 @@
     "typescript"
   ],
   "dependencies": {
+    "@alloralabs/allora-sdk": "^0.1.0",
     "@coinbase/coinbase-sdk": "^0.20.0",
     "@jup-ag/api": "^6.0.39",
     "@privy-io/server-auth": "^1.18.4",
     "@solana/spl-token": "^0.4.12",
     "@solana/web3.js": "^1.98.0",
     "md5": "^2.3.0",
+    "opensea-js": "^7.1.18",
     "reflect-metadata": "^0.2.2",
     "twitter-api-v2": "^1.18.2",
     "viem": "^2.22.16",
@@ -52,12 +55,20 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
+    "@types/nunjucks": "^3.2.6",
+    "@types/ora": "^3.2.0",
+    "@types/prompts": "^2.4.9",
     "@types/secp256k1": "^4.0.6",
     "http-server": "^14.1.1",
     "jest": "^29.7.0",
     "mock-fs": "^5.2.0",
+    "nunjucks": "^3.2.4",
+    "ora": "^7.0.1",
+    "picocolors": "^1.0.0",
+    "prompts": "^2.4.2",
     "ts-jest": "^29.2.5",
     "tsd": "^0.31.2",
+    "tsx": "^4.7.1",
     "typescript": "^5.7.2"
   },
   "exports": {