diff --git a/typescript/.changeset/ninety-gifts-know.md b/typescript/.changeset/ninety-gifts-know.md new file mode 100644 index 000000000..8607e82f4 --- /dev/null +++ b/typescript/.changeset/ninety-gifts-know.md @@ -0,0 +1,5 @@ +--- +"@coinbase/agentkit": patch +--- + +Add a new Messari action provider that enables AI agents to query the Messari AI toolkit for crypto market research data. diff --git a/typescript/agentkit/src/action-providers/index.ts b/typescript/agentkit/src/action-providers/index.ts index a4e9453dd..60bad1ecd 100644 --- a/typescript/agentkit/src/action-providers/index.ts +++ b/typescript/agentkit/src/action-providers/index.ts @@ -11,6 +11,7 @@ export * from "./erc20"; export * from "./erc721"; export * from "./farcaster"; export * from "./jupiter"; +export * from "./messari"; export * from "./pyth"; export * from "./moonwell"; export * from "./morpho"; diff --git a/typescript/agentkit/src/action-providers/messari/README.md b/typescript/agentkit/src/action-providers/messari/README.md new file mode 100644 index 000000000..dffeb3314 --- /dev/null +++ b/typescript/agentkit/src/action-providers/messari/README.md @@ -0,0 +1,103 @@ +# Messari Action Provider + +The Messari Action Provider enables AI agents to query the [Messari AI toolkit](https://messari.io/) for crypto market research data. This provider allows agents to ask research questions about market data, statistics, rankings, historical trends, and information about specific protocols, tokens, or platforms. + +## Getting an API Key + +To use the Messari Action Provider, you need to obtain a Messari API key by following these steps: + +1. Sign up for a Messari account at [messari.io](https://messari.io/) +2. After signing up, navigate to [messari.io/account/api](https://messari.io/account/api) +3. Generate your API key from the account dashboard + +For more detailed information about authentication, refer to the [Messari API Authentication documentation](https://docs.messari.io/reference/authentication). + +Different subscription tiers provide different levels of access to the API. See the [Rate Limiting](#rate-limiting) section for details. + +## Configuration + +Once you have your Messari API key, you can configure the provider in two ways: + +### 1. Environment Variable + +Set the `MESSARI_API_KEY` environment variable: + +```bash +MESSARI_API_KEY=your_messari_api_key +``` + +### 2. Direct Configuration + +Pass the API key directly when initializing the provider: + +```typescript +import { messariActionProvider } from "@coinbase/agentkit"; + +const provider = messariActionProvider({ + apiKey: "your_messari_api_key", +}); +``` + +## Rate Limiting + +The Messari API has rate limits based on your subscription tier: + +| Subscription Tier | Daily Request Limit | +|-------------------|---------------------| +| Free (Unpaid) | 2 requests per day | +| Lite | 10 requests per day | +| Pro | 20 requests per day | +| Enterprise | 50 requests per day | + +If you need more than 50 requests per day, you can contact Messari's sales team to discuss a custom credit allocation system for your specific needs. + +## Actions + +### `research_question` + +This action allows the agent to query the Messari AI toolkit with a research question about crypto markets, protocols, or tokens. + +#### Input Schema + +| Parameter | Type | Description | +|-----------|--------|--------------------------------------------------------------| +| question | string | The research question about crypto markets, protocols, or tokens | + +#### Example Usage + +```typescript +import { AgentKit, messariActionProvider } from "@coinbase/agentkit"; +import { getLangChainTools } from "@coinbase/agentkit-langchain"; +import { createReactAgent } from "@langchain/langgraph/prebuilt"; +import { ChatOpenAI } from "@langchain/openai"; + +// Initialize AgentKit with the Messari action provider +const agentkit = await AgentKit.from({ + actionProviders: [messariActionProvider()], +}); + +// Get LangChain tools from AgentKit +const tools = await getLangChainTools(agentkit); + +// Create a LangChain agent with the tools +const llm = new ChatOpenAI({ model: "gpt-4o-mini" }); +const agent = createReactAgent({ + llm, + tools, +}); + +// The agent can now use the Messari research_question action +// Example prompt: "What is the current price of Ethereum?" +``` + +#### Example Response + +``` +Messari Research Results: + +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. +``` + +## Network Support + +The Messari Action Provider is network-agnostic, meaning it supports all networks. The research capabilities are not tied to any specific blockchain network. \ No newline at end of file diff --git a/typescript/agentkit/src/action-providers/messari/index.ts b/typescript/agentkit/src/action-providers/messari/index.ts new file mode 100644 index 000000000..d01209430 --- /dev/null +++ b/typescript/agentkit/src/action-providers/messari/index.ts @@ -0,0 +1,2 @@ +export * from "./messariActionProvider"; +export * from "./schemas"; diff --git a/typescript/agentkit/src/action-providers/messari/messariActionProvider.test.ts b/typescript/agentkit/src/action-providers/messari/messariActionProvider.test.ts new file mode 100644 index 000000000..c78aa811a --- /dev/null +++ b/typescript/agentkit/src/action-providers/messari/messariActionProvider.test.ts @@ -0,0 +1,200 @@ +import { messariActionProvider, MessariActionProvider } from "./messariActionProvider"; + +const MOCK_API_KEY = "messari-test-key"; + +// Sample response for the research question action +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.", + }, + ], + }, +}; + +// Sample error response in Messari format +const MOCK_ERROR_RESPONSE = { + error: "Internal server error, please try again. If the problem persists, please contact support", + data: null, +}; + +describe("MessariActionProvider", () => { + let provider: MessariActionProvider; + + beforeEach(() => { + process.env.MESSARI_API_KEY = MOCK_API_KEY; + provider = 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 = 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 = messariActionProvider(); + expect(envProvider["apiKey"]).toBe("env-key"); + }); + + it("should throw error if API key is not provided", () => { + delete process.env.MESSARI_API_KEY; + expect(() => messariActionProvider()).toThrow("MESSARI_API_KEY is not configured."); + }); + }); + + describe("researchQuestion", () => { + it("should successfully fetch research results", async () => { + const fetchMock = jest.spyOn(global, "fetch").mockResolvedValue({ + ok: true, + json: async () => MOCK_RESEARCH_RESPONSE, + } as Response); + + const question = "What is the current price of Ethereum?"; + const response = await provider.researchQuestion({ question }); + + // Verify the API was called with the correct parameters + expect(fetchMock).toHaveBeenCalled(); + const [url, options] = fetchMock.mock.calls[0]; + + // Check URL + expect(url).toBe("https://api.messari.io/ai/v1/chat/completions"); + + // Check request options + 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, + }, + ], + }), + }), + ); + + // Check response formatting + 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, + } as Response); + + const response = await provider.researchQuestion({ + question: "What is the current price of Bitcoin?", + }); + + // Should use the structured error message from the response + expect(response).toContain("Messari API Error: Internal server error"); + expect(response).not.toContain("500"); // Should not include technical details when we have a structured error + }); + + 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, + } as Response); + + const response = await provider.researchQuestion({ + question: "What is the current price of Bitcoin?", + }); + + // Should fall back to detailed error format + 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"); + }, + } as unknown as Response); + + 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: [] } }), // Empty messages array + } as Response); + + 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 () => { + // This simulates a case where an error might be stringified JSON + 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?", + }); + + // Should parse the JSON string and extract the error message + 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); + }); + }); +}); diff --git a/typescript/agentkit/src/action-providers/messari/messariActionProvider.ts b/typescript/agentkit/src/action-providers/messari/messariActionProvider.ts new file mode 100644 index 000000000..3d956bb2a --- /dev/null +++ b/typescript/agentkit/src/action-providers/messari/messariActionProvider.ts @@ -0,0 +1,226 @@ +import { z } from "zod"; +import { ActionProvider } from "../actionProvider"; +import { CreateAction } from "../actionDecorator"; +import { Network } from "../../network"; +import { MessariResearchQuestionSchema } from "./schemas"; + +/** + * Configuration options for the MessariActionProvider. + */ +export interface MessariActionProviderConfig { + /** + * Messari API Key + */ + apiKey?: string; +} + +/** + * Types for API responses and errors + */ +interface MessariAPIResponse { + data: { + messages: Array<{ + content: string; + role: string; + }>; + }; +} + +interface MessariErrorResponse { + error?: string; + data?: null | unknown; +} + +interface MessariError extends Error { + status?: number; + statusText?: string; + responseText?: string; + errorResponse?: { + error?: string; + data?: null | unknown; + }; +} + +/** + * 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 class MessariActionProvider extends ActionProvider { + private readonly apiKey: string; + private readonly baseUrl = "https://api.messari.io/ai/v1"; + + /** + * Constructor for the MessariActionProvider class. + * + * @param config - The configuration options for the MessariActionProvider + */ + constructor(config: MessariActionProviderConfig = {}) { + super("messari", []); + + config.apiKey ||= process.env.MESSARI_API_KEY; + + if (!config.apiKey) { + throw new Error("MESSARI_API_KEY is not configured."); + } + + 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 + */ + @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: MessariResearchQuestionSchema, + }) + async researchQuestion(args: z.infer): Promise { + try { + // Make API request + const response = await fetch(`${this.baseUrl}/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 this.createMessariError(response); + } + + // Parse and validate response + let data: MessariAPIResponse; + try { + data = (await response.json()) as MessariAPIResponse; + } 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: unknown) { + if (error instanceof Error && "responseText" in error) { + return this.formatMessariApiError(error as MessariError); + } + + return this.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(_: Network): boolean { + return true; // Messari research is network-agnostic + } + + /** + * Creates a MessariError from an HTTP response + * + * @param response - The fetch Response object + * @returns A MessariError with response details + */ + private async createMessariError(response: Response): Promise { + const error = new Error( + `Messari API returned ${response.status} ${response.statusText}`, + ) as MessariError; + error.status = response.status; + error.statusText = response.statusText; + + const responseText = await response.text(); + error.responseText = responseText; + try { + const errorJson = JSON.parse(responseText) as MessariErrorResponse; + 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 + */ + private formatMessariApiError(error: MessariError): string { + 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 + */ + private formatGenericError(error: unknown): string { + // Check if this might be a JSON string containing an error message + if (typeof error === "string") { + try { + const parsedError = JSON.parse(error) as MessariErrorResponse; + 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)}`; + } +} + +/** + * Factory function to create a new MessariActionProvider instance. + * + * @param config - The configuration options for the MessariActionProvider + * @returns A new instance of MessariActionProvider + */ +export const messariActionProvider = (config: MessariActionProviderConfig = {}) => + new MessariActionProvider(config); diff --git a/typescript/agentkit/src/action-providers/messari/schemas.ts b/typescript/agentkit/src/action-providers/messari/schemas.ts new file mode 100644 index 000000000..24f17fd69 --- /dev/null +++ b/typescript/agentkit/src/action-providers/messari/schemas.ts @@ -0,0 +1,14 @@ +import { z } from "zod"; + +/** + * Input schema for submitting a research question to Messari AI. + */ +export const MessariResearchQuestionSchema = z + .object({ + question: 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");