@coinbase/agentkit 0.4.0 → 0.5.0

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

@@ -0,0 +1,5 @@
+export * from "./messariActionProvider";
+export * from "./schemas";
+export * from "./types";
+export * from "./constants";
+export * from "./utils";

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

@@ -0,0 +1,21 @@
+"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("./messariActionProvider"), exports);
+__exportStar(require("./schemas"), exports);
+__exportStar(require("./types"), exports);
+__exportStar(require("./constants"), exports);
+__exportStar(require("./utils"), exports);

package/dist/action-providers/messari/messariActionProvider.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+import { ActionProvider } from "../actionProvider";
+import { Network } from "../../network";
+import { MessariResearchQuestionSchema } from "./schemas";
+import { MessariActionProviderConfig } from "./types";
+/**
+ * MessariActionProvider is an action provider for Messari AI toolkit interactions.
+ * It enables AI agents to ask research questions about crypto markets, protocols, and tokens.
+ *
+ * @augments ActionProvider
+ */
+export declare class MessariActionProvider extends ActionProvider {
+    private readonly apiKey;
+    /**
+     * Constructor for the MessariActionProvider class.
+     *
+     * @param config - The configuration options for the MessariActionProvider
+     */
+    constructor(config?: MessariActionProviderConfig);
+    /**
+     * Makes a request to the Messari AI API with a research question
+     *
+     * @param args - The arguments containing the research question
+     * @returns A string containing the research results or an error message
+     */
+    researchQuestion(args: z.infer<typeof MessariResearchQuestionSchema>): Promise<string>;
+    /**
+     * Checks if the action provider supports the given network.
+     * Messari research is network-agnostic, so it supports all networks.
+     *
+     * @param _ - The network to check
+     * @returns Always returns true as Messari research is network-agnostic
+     */
+    supportsNetwork(_: Network): boolean;
+}
+/**
+ * Factory function to create a new MessariActionProvider instance.
+ *
+ * @param config - The configuration options for the MessariActionProvider
+ * @returns A new instance of MessariActionProvider
+ */
+export declare const messariActionProvider: (config?: MessariActionProviderConfig) => MessariActionProvider;

package/dist/action-providers/messari/messariActionProvider.js

@@ -0,0 +1,128 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messariActionProvider = exports.MessariActionProvider = void 0;
+const zod_1 = require("zod");
+const actionProvider_1 = require("../actionProvider");
+const actionDecorator_1 = require("../actionDecorator");
+const schemas_1 = require("./schemas");
+const constants_1 = require("./constants");
+const utils_1 = require("./utils");
+/**
+ * MessariActionProvider is an action provider for Messari AI toolkit interactions.
+ * It enables AI agents to ask research questions about crypto markets, protocols, and tokens.
+ *
+ * @augments ActionProvider
+ */
+class MessariActionProvider extends actionProvider_1.ActionProvider {
+    /**
+     * Constructor for the MessariActionProvider class.
+     *
+     * @param config - The configuration options for the MessariActionProvider
+     */
+    constructor(config = {}) {
+        super("messari", []);
+        config.apiKey || (config.apiKey = process.env.MESSARI_API_KEY);
+        if (!config.apiKey) {
+            throw new Error(constants_1.API_KEY_MISSING_ERROR);
+        }
+        this.apiKey = config.apiKey;
+    }
+    /**
+     * Makes a request to the Messari AI API with a research question
+     *
+     * @param args - The arguments containing the research question
+     * @returns A string containing the research results or an error message
+     */
+    async researchQuestion(args) {
+        try {
+            // Make API request
+            const response = await fetch(`${constants_1.MESSARI_BASE_URL}/chat/completions`, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    "x-messari-api-key": this.apiKey,
+                },
+                body: JSON.stringify({
+                    messages: [
+                        {
+                            role: "user",
+                            content: args.question,
+                        },
+                    ],
+                }),
+            });
+            if (!response.ok) {
+                throw await (0, utils_1.createMessariError)(response);
+            }
+            // Parse and validate response
+            let data;
+            try {
+                data = (await response.json());
+            }
+            catch (jsonError) {
+                throw new Error(`Failed to parse API response: ${jsonError instanceof Error ? jsonError.message : String(jsonError)}`);
+            }
+            if (!data.data?.messages?.[0]?.content) {
+                throw new Error("Received invalid response format from Messari API");
+            }
+            const result = data.data.messages[0].content;
+            return `Messari Research Results:\n\n${result}`;
+        }
+        catch (error) {
+            if (error instanceof Error && "responseText" in error) {
+                return (0, utils_1.formatMessariApiError)(error);
+            }
+            return (0, utils_1.formatGenericError)(error);
+        }
+    }
+    /**
+     * Checks if the action provider supports the given network.
+     * Messari research is network-agnostic, so it supports all networks.
+     *
+     * @param _ - The network to check
+     * @returns Always returns true as Messari research is network-agnostic
+     */
+    supportsNetwork(_) {
+        return true; // Messari research is network-agnostic
+    }
+}
+exports.MessariActionProvider = MessariActionProvider;
+__decorate([
+    (0, actionDecorator_1.CreateAction)({
+        name: "research_question",
+        description: `
+This tool queries Messari AI for comprehensive crypto research across these datasets:
+1. News/Content - Latest crypto news, blogs, podcasts
+2. Exchanges - CEX/DEX volumes, market share, assets listed
+3. Onchain Data - Active addresses, transaction fees, total transactions.
+4. Token Unlocks - Upcoming supply unlocks, vesting schedules, and token emission details
+5. Market Data - Asset prices, trading volume, market cap, TVL, and historical performance
+6. Fundraising - Investment data, funding rounds, venture capital activity.
+7. Protocol Research - Technical analysis of how protocols work, tokenomics, and yield mechanisms
+8. Social Data - Twitter followers and Reddit subscribers metrics, growth trends
+
+Examples: "Which DEXs have the highest trading volume this month?", "When is Arbitrum's next major token unlock?", "How does Morpho generate yield for users?", "Which cryptocurrency has gained the most Twitter followers in 2023?", "What did Vitalik Buterin say about rollups in his recent blog posts?"
+    `,
+        schema: schemas_1.MessariResearchQuestionSchema,
+    }),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [void 0]),
+    __metadata("design:returntype", Promise)
+], MessariActionProvider.prototype, "researchQuestion", null);
+/**
+ * Factory function to create a new MessariActionProvider instance.
+ *
+ * @param config - The configuration options for the MessariActionProvider
+ * @returns A new instance of MessariActionProvider
+ */
+const messariActionProvider = (config = {}) => new MessariActionProvider(config);
+exports.messariActionProvider = messariActionProvider;

package/dist/action-providers/messari/messariActionProvider.test.d.ts

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

package/dist/action-providers/messari/messariActionProvider.test.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const messariActionProvider_1 = require("./messariActionProvider");
+const constants_1 = require("./constants");
+const MOCK_API_KEY = "messari-test-key";
+const MOCK_RESEARCH_RESPONSE = {
+    data: {
+        messages: [
+            {
+                role: "assistant",
+                content: "Ethereum (ETH) has shown strong performance over the past month with a 15% price increase. The current price is approximately $3,500, up from $3,000 at the beginning of the month. Trading volume has also increased by 20% in the same period.",
+            },
+        ],
+    },
+};
+const MOCK_ERROR_RESPONSE = {
+    error: "Internal server error, please try again. If the problem persists, please contact support",
+    data: null,
+};
+describe("MessariActionProvider", () => {
+    let provider;
+    beforeEach(() => {
+        process.env.MESSARI_API_KEY = MOCK_API_KEY;
+        provider = (0, messariActionProvider_1.messariActionProvider)({ apiKey: MOCK_API_KEY });
+        jest.restoreAllMocks();
+    });
+    afterEach(() => {
+        jest.clearAllMocks();
+        delete process.env.MESSARI_API_KEY;
+    });
+    describe("constructor", () => {
+        it("should initialize with API key from constructor", () => {
+            const customProvider = (0, messariActionProvider_1.messariActionProvider)({ apiKey: "custom-key" });
+            expect(customProvider["apiKey"]).toBe("custom-key");
+        });
+        it("should initialize with API key from environment variable", () => {
+            process.env.MESSARI_API_KEY = "env-key";
+            const envProvider = (0, messariActionProvider_1.messariActionProvider)();
+            expect(envProvider["apiKey"]).toBe("env-key");
+        });
+        it("should throw error if API key is not provided", () => {
+            delete process.env.MESSARI_API_KEY;
+            expect(() => (0, messariActionProvider_1.messariActionProvider)()).toThrow(constants_1.API_KEY_MISSING_ERROR);
+        });
+    });
+    describe("researchQuestion", () => {
+        it("should successfully fetch research results", async () => {
+            const fetchMock = jest.spyOn(global, "fetch").mockResolvedValue({
+                ok: true,
+                json: async () => MOCK_RESEARCH_RESPONSE,
+            });
+            const question = "What is the current price of Ethereum?";
+            const response = await provider.researchQuestion({ question });
+            expect(fetchMock).toHaveBeenCalled();
+            const [url, options] = fetchMock.mock.calls[0];
+            expect(url).toBe("https://api.messari.io/ai/v1/chat/completions");
+            expect(options).toEqual(expect.objectContaining({
+                method: "POST",
+                headers: expect.objectContaining({
+                    "Content-Type": "application/json",
+                    "x-messari-api-key": MOCK_API_KEY,
+                }),
+                body: JSON.stringify({
+                    messages: [
+                        {
+                            role: "user",
+                            content: question,
+                        },
+                    ],
+                }),
+            }));
+            expect(response).toContain("Messari Research Results:");
+            expect(response).toContain(MOCK_RESEARCH_RESPONSE.data.messages[0].content);
+        });
+        it("should handle non-ok response with structured error format", async () => {
+            const errorResponseText = JSON.stringify(MOCK_ERROR_RESPONSE);
+            jest.spyOn(global, "fetch").mockResolvedValue({
+                ok: false,
+                status: 500,
+                statusText: "Internal Server Error",
+                text: async () => errorResponseText,
+            });
+            const response = await provider.researchQuestion({
+                question: "What is the current price of Bitcoin?",
+            });
+            expect(response).toContain("Messari API Error: Internal server error");
+            expect(response).not.toContain("500");
+        });
+        it("should handle non-ok response with non-JSON error format", async () => {
+            const plainTextError = "Rate limit exceeded";
+            jest.spyOn(global, "fetch").mockResolvedValue({
+                ok: false,
+                status: 429,
+                statusText: "Too Many Requests",
+                text: async () => plainTextError,
+            });
+            const response = await provider.researchQuestion({
+                question: "What is the current price of Bitcoin?",
+            });
+            expect(response).toContain("Messari API Error:");
+            expect(response).toContain("429");
+            expect(response).toContain("Too Many Requests");
+            expect(response).toContain(plainTextError);
+        });
+        it("should handle JSON parsing error in successful response", async () => {
+            jest.spyOn(global, "fetch").mockResolvedValue({
+                ok: true,
+                json: async () => {
+                    throw new Error("Invalid JSON");
+                },
+            });
+            const response = await provider.researchQuestion({
+                question: "What is the market cap of Solana?",
+            });
+            expect(response).toContain("Unexpected error: Failed to parse API response");
+            expect(response).toContain("Invalid JSON");
+        });
+        it("should handle invalid response format", async () => {
+            jest.spyOn(global, "fetch").mockResolvedValue({
+                ok: true,
+                json: async () => ({ data: { messages: [] } }),
+            });
+            const response = await provider.researchQuestion({
+                question: "What is the market cap of Solana?",
+            });
+            expect(response).toContain("Unexpected error: Received invalid response format from Messari API");
+        });
+        it("should handle fetch error", async () => {
+            const error = new Error("Network error");
+            jest.spyOn(global, "fetch").mockRejectedValue(error);
+            const response = await provider.researchQuestion({
+                question: "What is the market cap of Solana?",
+            });
+            expect(response).toContain("Unexpected error: Network error");
+        });
+        it("should handle string error with JSON content", async () => {
+            const stringifiedError = JSON.stringify(MOCK_ERROR_RESPONSE);
+            jest.spyOn(global, "fetch").mockRejectedValue(stringifiedError);
+            const response = await provider.researchQuestion({
+                question: "What is the market cap of Solana?",
+            });
+            expect(response).toContain("Messari API Error: Internal server error");
+        });
+    });
+    describe("supportsNetwork", () => {
+        it("should always return true as research is network-agnostic", () => {
+            expect(provider.supportsNetwork({ protocolFamily: "evm" })).toBe(true);
+            expect(provider.supportsNetwork({ protocolFamily: "solana" })).toBe(true);
+            expect(provider.supportsNetwork({ protocolFamily: "unknown" })).toBe(true);
+        });
+    });
+});

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

@@ -0,0 +1,11 @@
+import { z } from "zod";
+/**
+ * Input schema for submitting a research question to Messari AI.
+ */
+export declare const MessariResearchQuestionSchema: z.ZodObject<{
+    question: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    question: string;
+}, {
+    question: string;
+}>;

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessariResearchQuestionSchema = void 0;
+const zod_1 = require("zod");
+/**
+ * Input schema for submitting a research question to Messari AI.
+ */
+exports.MessariResearchQuestionSchema = zod_1.z
+    .object({
+    question: zod_1.z
+        .string()
+        .min(1, "Research question is required.")
+        .describe("The research question about crypto markets, protocols, or tokens"),
+})
+    .strip()
+    .describe("Input schema for submitting a research question to Messari AI");

package/dist/action-providers/messari/types.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Configuration options for the MessariActionProvider.
+ */
+export interface MessariActionProviderConfig {
+    /**
+     * Messari API Key
+     */
+    apiKey?: string;
+}
+/**
+ * Message format in Messari API responses
+ */
+export interface MessariMessage {
+    content: string;
+    role: string;
+}
+/**
+ * Response format from Messari API
+ */
+export interface MessariAPIResponse {
+    data: {
+        messages: MessariMessage[];
+    };
+}
+/**
+ * Error response format from Messari API
+ */
+export interface MessariErrorResponse {
+    error?: string;
+    data?: null | unknown;
+}
+/**
+ * Extended Error interface for Messari API errors
+ */
+export interface MessariError extends Error {
+    status?: number;
+    statusText?: string;
+    responseText?: string;
+    errorResponse?: MessariErrorResponse;
+}

package/dist/action-providers/messari/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,22 @@
+import { MessariError } from "./types";
+/**
+ * Creates a MessariError from an HTTP response
+ *
+ * @param response - The fetch Response object
+ * @returns A MessariError with response details
+ */
+export declare function createMessariError(response: Response): Promise<MessariError>;
+/**
+ * Formats error details for API errors
+ *
+ * @param error - The MessariError to format
+ * @returns Formatted error message
+ */
+export declare function formatMessariApiError(error: MessariError): string;
+/**
+ * Formats generic errors
+ *
+ * @param error - The error to format
+ * @returns Formatted error message
+ */
+export declare function formatGenericError(error: unknown): string;

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

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMessariError = createMessariError;
+exports.formatMessariApiError = formatMessariApiError;
+exports.formatGenericError = formatGenericError;
+/**
+ * Creates a MessariError from an HTTP response
+ *
+ * @param response - The fetch Response object
+ * @returns A MessariError with response details
+ */
+async function createMessariError(response) {
+    const error = new Error(`Messari API returned ${response.status} ${response.statusText}`);
+    error.status = response.status;
+    error.statusText = response.statusText;
+    const responseText = await response.text();
+    error.responseText = responseText;
+    try {
+        const errorJson = JSON.parse(responseText);
+        error.errorResponse = errorJson;
+    }
+    catch {
+        // If parsing fails, just use the raw text
+    }
+    return error;
+}
+/**
+ * Formats error details for API errors
+ *
+ * @param error - The MessariError to format
+ * @returns Formatted error message
+ */
+function formatMessariApiError(error) {
+    if (error.errorResponse?.error) {
+        return `Messari API Error: ${error.errorResponse.error}`;
+    }
+    const errorDetails = {
+        status: error.status,
+        statusText: error.statusText,
+        responseText: error.responseText,
+        message: error.message,
+    };
+    return `Messari API Error: ${JSON.stringify(errorDetails, null, 2)}`;
+}
+/**
+ * Formats generic errors
+ *
+ * @param error - The error to format
+ * @returns Formatted error message
+ */
+function formatGenericError(error) {
+    // Check if this might be a JSON string containing an error message
+    if (typeof error === "string") {
+        try {
+            const parsedError = JSON.parse(error);
+            if (parsedError.error) {
+                return `Messari API Error: ${parsedError.error}`;
+            }
+        }
+        catch {
+            // Not valid JSON, continue with normal handling
+        }
+    }
+    return `Unexpected error: ${error instanceof Error ? error.message : String(error)}`;
+}

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

@@ -1,7 +1,7 @@
-import { ReadContractParameters, ReadContractReturnType, TransactionRequest, TransactionSerializable, Abi, ContractFunctionName, ContractFunctionArgs } from "viem";
+import { ReadContractParameters, ReadContractReturnType, TransactionRequest, TransactionSerializable, Abi, ContractFunctionName, ContractFunctionArgs, Address, Hex } from "viem";
 import { EvmWalletProvider } from "./evmWalletProvider";
 import { Network } from "../network";
-import { CreateERC20Options, CreateTradeOptions, SmartContract, Trade, Wallet, WalletData } from "@coinbase/coinbase-sdk";
+import { Coinbase, CreateERC20Options, CreateTradeOptions, SmartContract, Trade, Wallet, WalletData } from "@coinbase/coinbase-sdk";
 /**
  * Configuration options for the CDP Providers.
  */
@@ -233,5 +233,14 @@ export declare class CdpWalletProvider extends EvmWalletProvider {
      * @returns The wallet.
      */
     getWallet(): Wallet;
+    /**
+     * ERC20 transfer method
+     *
+     * @param assetId - The asset ID to transfer. Either USDC, CBBTC or EURC
+     * @param destination - The destination address
+     * @param amount - The amount to transfer
+     * @returns The transaction hash
+     */
+    gaslessERC20Transfer(assetId: typeof Coinbase.assets.Usdc | typeof Coinbase.assets.Cbbtc | typeof Coinbase.assets.Eurc, destination: Address, amount: bigint): Promise<Hex>;
 }
 export {};

package/dist/wallet-providers/cdpWalletProvider.js

@@ -392,6 +392,30 @@ class CdpWalletProvider extends evmWalletProvider_1.EvmWalletProvider {
         }
         return __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f");
     }
+    /**
+     * ERC20 transfer method
+     *
+     * @param assetId - The asset ID to transfer. Either USDC, CBBTC or EURC
+     * @param destination - The destination address
+     * @param amount - The amount to transfer
+     * @returns The transaction hash
+     */
+    async gaslessERC20Transfer(assetId, destination, amount) {
+        if (!__classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f")) {
+            throw new Error("Wallet not initialized");
+        }
+        const transferResult = await __classPrivateFieldGet(this, _CdpWalletProvider_cdpWallet, "f").createTransfer({
+            amount,
+            assetId,
+            destination,
+            gasless: true,
+        });
+        const result = await transferResult.wait();
+        if (!result.getTransactionHash()) {
+            throw new Error("Transaction hash not found");
+        }
+        return result.getTransactionHash();
+    }
 }
 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/dist/wallet-providers/cdpWalletProvider.test.d.ts

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