From e4a240c70d4ad0d1a92b6622cc364af9af8651ac Mon Sep 17 00:00:00 2001 From: Agustin Armellini Fischer Date: Sun, 1 Dec 2024 01:47:10 +0100 Subject: [PATCH 1/5] Add Goat plugin --- packages/plugin-goat/README.md | 12 ++ packages/plugin-goat/package.json | 22 ++++ packages/plugin-goat/src/actions.ts | 186 ++++++++++++++++++++++++++++ packages/plugin-goat/src/index.ts | 29 +++++ packages/plugin-goat/src/wallet.ts | 31 +++++ packages/plugin-goat/tsconfig.json | 9 ++ packages/plugin-goat/tsup.config.ts | 21 ++++ 7 files changed, 310 insertions(+) create mode 100644 packages/plugin-goat/README.md create mode 100644 packages/plugin-goat/package.json create mode 100644 packages/plugin-goat/src/actions.ts create mode 100644 packages/plugin-goat/src/index.ts create mode 100644 packages/plugin-goat/src/wallet.ts create mode 100644 packages/plugin-goat/tsconfig.json create mode 100644 packages/plugin-goat/tsup.config.ts diff --git a/packages/plugin-goat/README.md b/packages/plugin-goat/README.md new file mode 100644 index 00000000000..fcac78c5737 --- /dev/null +++ b/packages/plugin-goat/README.md @@ -0,0 +1,12 @@ +# Goat Plugin +Example plugin setup of how you can integrate [Goat](https://ohmygoat.dev/) tools and plugins with Eliza. + +Adds onchain capabilities to your agent to send and check balances of ETH and USDC. Add all the capabilities you need by adding more plugins! + +## Setup +1. Configure your wallet (key pair, smart wallet, etc. see all available wallets at [https://ohmygoat.dev/wallets](https://ohmygoat.dev/wallets)) +2. Add the plugins you need (uniswap, zora, polymarket, etc. see all available plugins at [https://ohmygoat.dev/chains-wallets-plugins](https://ohmygoat.dev/chains-wallets-plugins)) +3. Select a chain (see all available chains at [https://ohmygoat.dev/chains](https://ohmygoat.dev/chains)) +4. Import and add the plugin to your Eliza agent +5. Build the project +6. Add the necessary environment variables to set up your wallet and plugins diff --git a/packages/plugin-goat/package.json b/packages/plugin-goat/package.json new file mode 100644 index 00000000000..5a68deab2cc --- /dev/null +++ b/packages/plugin-goat/package.json @@ -0,0 +1,22 @@ +{ + "name": "@ai16z/plugin-goat", + "version": "0.0.1", + "main": "dist/index.js", + "type": "module", + "types": "dist/index.d.ts", + "dependencies": { + "@ai16z/eliza": "workspace:*", + "@ai16z/plugin-trustdb": "workspace:*", + "@goat-sdk/core": "0.3.7", + "@goat-sdk/plugin-erc20": "0.1.5", + "@goat-sdk/wallet-viem": "0.1.3", + "tsup": "^8.3.5", + "viem": "^2.21.45" + }, + "scripts": { + "build": "tsup --format esm --dts" + }, + "peerDependencies": { + "whatwg-url": "7.1.0" + } +} diff --git a/packages/plugin-goat/src/actions.ts b/packages/plugin-goat/src/actions.ts new file mode 100644 index 00000000000..3be441b7a30 --- /dev/null +++ b/packages/plugin-goat/src/actions.ts @@ -0,0 +1,186 @@ +import { + type WalletClient, + type Plugin, + getDeferredTools, + parametersToJsonExample, + addParametersToDescription, + type ChainForWalletClient, + type DeferredTool, +} from "@goat-sdk/core"; +import { + type Action, + generateText, + type HandlerCallback, + type IAgentRuntime, + type Memory, + ModelClass, + type State, + composeContext, + generateObject, +} from "@ai16z/eliza"; + +type GetOnChainActionsParams = { + chain: ChainForWalletClient; + getWalletClient: (runtime: IAgentRuntime) => Promise; + plugins: Plugin[]; + supportsSmartWallets?: boolean; +}; + +/** + * Get all the on chain actions for the given wallet client and plugins + * + * @param params + * @returns + */ +export async function getOnChainActions({ + getWalletClient, + plugins, + chain, + supportsSmartWallets, +}: GetOnChainActionsParams): Promise { + const tools = await getDeferredTools({ + plugins, + wordForTool: "action", + chain, + supportsSmartWallets, + }); + + return tools + .map((action) => ({ + ...action, + name: action.name.toUpperCase(), + })) + .map((tool) => createAction(tool, getWalletClient)) +} + +function createAction( + tool: DeferredTool, + getWalletClient: (runtime: IAgentRuntime) => Promise +): Action { + return { + name: tool.name, + similes: [], + description: tool.description, + validate: async () => true, + handler: async ( + runtime: IAgentRuntime, + message: Memory, + state: State | undefined, + options?: Record, + callback?: HandlerCallback + ): Promise => { + try { + const walletClient = await getWalletClient(runtime); + let currentState = + state ?? (await runtime.composeState(message)); + currentState = + await runtime.updateRecentMessageState(currentState); + + const parameterContext = composeParameterContext( + tool, + currentState + ); + const parameters = await generateParameters( + runtime, + parameterContext + ); + + const parsedParameters = tool.parameters.safeParse(parameters); + if (!parsedParameters.success) { + callback?.({ + text: `Invalid parameters for action ${tool.name}: ${parsedParameters.error.message}`, + content: { error: parsedParameters.error.message }, + }); + return false; + } + + const result = await tool.method( + walletClient, + parsedParameters.data + ); + const responseContext = composeResponseContext( + tool, + result, + currentState + ); + const response = await generateResponse( + runtime, + responseContext + ); + + callback?.({ text: response, content: result }); + return true; + } catch (error) { + const errorMessage = + error instanceof Error ? error.message : String(error); + callback?.({ + text: `Error executing action ${tool.name}: ${errorMessage}`, + content: { error: errorMessage }, + }); + return false; + } + }, + examples: [], + }; +} + +function composeParameterContext( + tool: DeferredTool, + state: State +): string { + const contextTemplate = `Respond with a JSON markdown block containing only the extracted values for action "${ + tool.name + }". Use null for any values that cannot be determined. + +Example response: +\`\`\`json +${parametersToJsonExample(tool.parameters)} +\`\`\` + +{{recentMessages}} + +Given the recent messages, extract the following information for the action "${ + tool.name + }": +${addParametersToDescription("", tool.parameters)} +`; + return composeContext({ state, template: contextTemplate }); +} + +async function generateParameters( + runtime: IAgentRuntime, + context: string +): Promise { + return generateObject({ + runtime, + context, + modelClass: ModelClass.SMALL, + }); +} + +function composeResponseContext( + tool: DeferredTool, + result: unknown, + state: State +): string { + const responseTemplate = ` +The action "${tool.name}" was executed successfully. +Here is the result: +${JSON.stringify(result)} + +Respond to the message knowing that the action was successful and these were the previous messages: +{{recentMessages}} + `; + return composeContext({ state, template: responseTemplate }); +} + +async function generateResponse( + runtime: IAgentRuntime, + context: string +): Promise { + return generateText({ + runtime, + context, + modelClass: ModelClass.SMALL, + }); +} diff --git a/packages/plugin-goat/src/index.ts b/packages/plugin-goat/src/index.ts new file mode 100644 index 00000000000..47d0cc11108 --- /dev/null +++ b/packages/plugin-goat/src/index.ts @@ -0,0 +1,29 @@ +import type { Plugin } from '@ai16z/eliza' +import { base } from 'viem/chains'; +import { getOnChainActions } from './actions'; +import { erc20, USDC } from '@goat-sdk/plugin-erc20'; +import { getWalletClient } from './wallet'; +import { sendETH } from '@goat-sdk/core'; + +export const goatPlugin: Plugin = { + name: "[GOAT] Onchain Actions", + description: "Base integration plugin", + providers: [], + evaluators: [], + services: [], + actions: [ + ...(await getOnChainActions({ + getWalletClient, + // Add plugins here based on what actions you want to use + // See all available plugins at https://ohmygoat.dev/chains-wallets-plugins#plugins + plugins: [sendETH(), erc20({ tokens: [USDC] })], + // Add the chain you want to use + chain: { + type: "evm", + id: base.id, + }, + })), + ], +}; + +export default goatPlugin diff --git a/packages/plugin-goat/src/wallet.ts b/packages/plugin-goat/src/wallet.ts new file mode 100644 index 00000000000..df4e5483f56 --- /dev/null +++ b/packages/plugin-goat/src/wallet.ts @@ -0,0 +1,31 @@ +import { createWalletClient, http } from "viem"; +import { privateKeyToAccount } from "viem/accounts"; +import { base } from "viem/chains"; + +import { type IAgentRuntime } from "@ai16z/eliza"; +import { viem } from "@goat-sdk/wallet-viem"; + +/** + * Create a wallet client for the given runtime. + * + * You can change it to use a different wallet client such as Crossmint smart wallets or others. + * + * See all available wallet clients at https://ohmygoat.dev/wallets + * + * @param runtime + * @returns Wallet client + */ +export async function getWalletClient(runtime: IAgentRuntime) { + const privateKey = runtime.getSetting("EVM_PRIVATE_KEY"); + if (!privateKey) throw new Error("EVM_PRIVATE_KEY not configured"); + + const provider = runtime.getSetting("EVM_PROVIDER_URL"); + if (!provider) throw new Error("EVM_PROVIDER_URL not configured"); + + const walletClient = createWalletClient({ + account: privateKeyToAccount(privateKey as `0x${string}`), + chain: base, + transport: http(provider), + }); + return viem(walletClient); +} diff --git a/packages/plugin-goat/tsconfig.json b/packages/plugin-goat/tsconfig.json new file mode 100644 index 00000000000..a29f5acc13b --- /dev/null +++ b/packages/plugin-goat/tsconfig.json @@ -0,0 +1,9 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "dist", + "rootDir": "./src", + "declaration": true + }, + "include": ["src"] +} diff --git a/packages/plugin-goat/tsup.config.ts b/packages/plugin-goat/tsup.config.ts new file mode 100644 index 00000000000..b0c1a8a9f46 --- /dev/null +++ b/packages/plugin-goat/tsup.config.ts @@ -0,0 +1,21 @@ +import { defineConfig } from "tsup"; + +export default defineConfig({ + entry: ["src/index.ts"], + outDir: "dist", + sourcemap: true, + clean: true, + format: ["esm"], // Ensure you're targeting CommonJS + external: [ + "dotenv", // Externalize dotenv to prevent bundling + "fs", // Externalize fs to use Node.js built-in module + "path", // Externalize other built-ins if necessary + "@reflink/reflink", + "@node-llama-cpp", + "https", + "http", + "agentkeepalive", + "viem", + "@lifi/sdk" + ], +}); From 3a8c45af8251e7d6a60cf4b89af8af65c741e64a Mon Sep 17 00:00:00 2001 From: Agustin Armellini Fischer Date: Sun, 1 Dec 2024 03:03:43 +0100 Subject: [PATCH 2/5] Remove unnecessary dependency --- .env.example | 1 + packages/plugin-goat/package.json | 1 - 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/.env.example b/.env.example index b9a808d7564..1ad0c8ff2fa 100644 --- a/.env.example +++ b/.env.example @@ -87,6 +87,7 @@ HEURIST_IMAGE_MODEL= # EVM EVM_PRIVATE_KEY= EVM_PUBLIC_KEY= +EVM_PROVIDER_URL= # Solana SOLANA_PRIVATE_KEY= diff --git a/packages/plugin-goat/package.json b/packages/plugin-goat/package.json index 5a68deab2cc..7fb59012b73 100644 --- a/packages/plugin-goat/package.json +++ b/packages/plugin-goat/package.json @@ -6,7 +6,6 @@ "types": "dist/index.d.ts", "dependencies": { "@ai16z/eliza": "workspace:*", - "@ai16z/plugin-trustdb": "workspace:*", "@goat-sdk/core": "0.3.7", "@goat-sdk/plugin-erc20": "0.1.5", "@goat-sdk/wallet-viem": "0.1.3", From bad009906d465d6f93927be636108e0d8945a393 Mon Sep 17 00:00:00 2001 From: Agustin Armellini Fischer Date: Sun, 1 Dec 2024 09:58:23 +0100 Subject: [PATCH 3/5] Use generateObjectV2, add wallet provider, centralize chain config --- packages/plugin-goat/package.json | 4 +- packages/plugin-goat/src/actions.ts | 62 +++++++++++++------ packages/plugin-goat/src/index.ts | 8 +-- .../src/{wallet.ts => provider.ts} | 27 +++++++- 4 files changed, 72 insertions(+), 29 deletions(-) rename packages/plugin-goat/src/{wallet.ts => provider.ts} (54%) diff --git a/packages/plugin-goat/package.json b/packages/plugin-goat/package.json index 7fb59012b73..88c73c51040 100644 --- a/packages/plugin-goat/package.json +++ b/packages/plugin-goat/package.json @@ -6,8 +6,8 @@ "types": "dist/index.d.ts", "dependencies": { "@ai16z/eliza": "workspace:*", - "@goat-sdk/core": "0.3.7", - "@goat-sdk/plugin-erc20": "0.1.5", + "@goat-sdk/core": "0.3.8", + "@goat-sdk/plugin-erc20": "0.1.6", "@goat-sdk/wallet-viem": "0.1.3", "tsup": "^8.3.5", "viem": "^2.21.45" diff --git a/packages/plugin-goat/src/actions.ts b/packages/plugin-goat/src/actions.ts index 3be441b7a30..dea5da8e349 100644 --- a/packages/plugin-goat/src/actions.ts +++ b/packages/plugin-goat/src/actions.ts @@ -2,7 +2,6 @@ import { type WalletClient, type Plugin, getDeferredTools, - parametersToJsonExample, addParametersToDescription, type ChainForWalletClient, type DeferredTool, @@ -16,7 +15,7 @@ import { ModelClass, type State, composeContext, - generateObject, + generateObjectV2, } from "@ai16z/eliza"; type GetOnChainActionsParams = { @@ -50,7 +49,7 @@ export async function getOnChainActions({ ...action, name: action.name.toUpperCase(), })) - .map((tool) => createAction(tool, getWalletClient)) + .map((tool) => createAction(tool, getWalletClient)); } function createAction( @@ -82,9 +81,12 @@ function createAction( ); const parameters = await generateParameters( runtime, - parameterContext + parameterContext, + tool ); + console.log(`Parameters: ${JSON.stringify(parameters)}`); + const parsedParameters = tool.parameters.safeParse(parameters); if (!parsedParameters.success) { callback?.({ @@ -94,6 +96,12 @@ function createAction( return false; } + console.log( + `Executing action ${tool.name} with parameters: ${JSON.stringify( + parsedParameters.data + )}` + ); + const result = await tool.method( walletClient, parsedParameters.data @@ -128,34 +136,27 @@ function composeParameterContext( tool: DeferredTool, state: State ): string { - const contextTemplate = `Respond with a JSON markdown block containing only the extracted values for action "${ - tool.name - }". Use null for any values that cannot be determined. - -Example response: -\`\`\`json -${parametersToJsonExample(tool.parameters)} -\`\`\` + const contextTemplate = `{{recentMessages}} -{{recentMessages}} - -Given the recent messages, extract the following information for the action "${ - tool.name - }": +Given the recent messages, extract the following information for the action "${tool.name}": ${addParametersToDescription("", tool.parameters)} `; return composeContext({ state, template: contextTemplate }); } -async function generateParameters( +async function generateParameters( runtime: IAgentRuntime, - context: string + context: string, + tool: DeferredTool ): Promise { - return generateObject({ + const { object } = await generateObjectV2({ runtime, context, modelClass: ModelClass.SMALL, + schema: tool.parameters, }); + + return object; } function composeResponseContext( @@ -164,10 +165,31 @@ function composeResponseContext( state: State ): string { const responseTemplate = ` + # Action Examples +{{actionExamples}} +(Action examples are for reference only. Do not use the information from them in your response.) + +# Knowledge +{{knowledge}} + +# Task: Generate dialog and actions for the character {{agentName}}. +About {{agentName}}: +{{bio}} +{{lore}} + +{{providers}} + +{{attachments}} + +# Capabilities +Note that {{agentName}} is capable of reading/seeing/hearing various forms of media, including images, videos, audio, plaintext and PDFs. Recent attachments have been included above under the "Attachments" section. + The action "${tool.name}" was executed successfully. Here is the result: ${JSON.stringify(result)} +{{actions}} + Respond to the message knowing that the action was successful and these were the previous messages: {{recentMessages}} `; diff --git a/packages/plugin-goat/src/index.ts b/packages/plugin-goat/src/index.ts index 47d0cc11108..281d95a1621 100644 --- a/packages/plugin-goat/src/index.ts +++ b/packages/plugin-goat/src/index.ts @@ -1,14 +1,13 @@ import type { Plugin } from '@ai16z/eliza' -import { base } from 'viem/chains'; import { getOnChainActions } from './actions'; import { erc20, USDC } from '@goat-sdk/plugin-erc20'; -import { getWalletClient } from './wallet'; +import { chain, getWalletClient, walletProvider } from './provider'; import { sendETH } from '@goat-sdk/core'; export const goatPlugin: Plugin = { name: "[GOAT] Onchain Actions", description: "Base integration plugin", - providers: [], + providers: [walletProvider], evaluators: [], services: [], actions: [ @@ -17,10 +16,9 @@ export const goatPlugin: Plugin = { // Add plugins here based on what actions you want to use // See all available plugins at https://ohmygoat.dev/chains-wallets-plugins#plugins plugins: [sendETH(), erc20({ tokens: [USDC] })], - // Add the chain you want to use chain: { type: "evm", - id: base.id, + id: chain.id, }, })), ], diff --git a/packages/plugin-goat/src/wallet.ts b/packages/plugin-goat/src/provider.ts similarity index 54% rename from packages/plugin-goat/src/wallet.ts rename to packages/plugin-goat/src/provider.ts index df4e5483f56..20b4356b6f1 100644 --- a/packages/plugin-goat/src/wallet.ts +++ b/packages/plugin-goat/src/provider.ts @@ -2,9 +2,14 @@ import { createWalletClient, http } from "viem"; import { privateKeyToAccount } from "viem/accounts"; import { base } from "viem/chains"; -import { type IAgentRuntime } from "@ai16z/eliza"; +import { Memory, Provider, State, type IAgentRuntime } from "@ai16z/eliza"; import { viem } from "@goat-sdk/wallet-viem"; + +// Add the chain you want to use, remember to update also +// the EVM_PROVIDER_URL to the correct one for the chain +export const chain = base; + /** * Create a wallet client for the given runtime. * @@ -24,8 +29,26 @@ export async function getWalletClient(runtime: IAgentRuntime) { const walletClient = createWalletClient({ account: privateKeyToAccount(privateKey as `0x${string}`), - chain: base, + chain: chain, transport: http(provider), }); return viem(walletClient); } + +export const walletProvider: Provider = { + async get( + runtime: IAgentRuntime, + message: Memory, + state?: State + ): Promise { + try { + const walletClient = await getWalletClient(runtime); + const address = walletClient.getAddress(); + const balance = await walletClient.balanceOf(address); + return `EVM Wallet Address: ${address}\nBalance: ${balance} ETH`; + } catch (error) { + console.error("Error in EVM wallet provider:", error); + return null; + } + }, +}; From 2d7bdbf14d1442d333abb86b587a7abff69b7f9f Mon Sep 17 00:00:00 2001 From: Agustin Armellini Fischer Date: Sun, 1 Dec 2024 09:59:38 +0100 Subject: [PATCH 4/5] Remove console logs --- packages/plugin-goat/src/actions.ts | 8 -------- 1 file changed, 8 deletions(-) diff --git a/packages/plugin-goat/src/actions.ts b/packages/plugin-goat/src/actions.ts index dea5da8e349..a69ab6378e6 100644 --- a/packages/plugin-goat/src/actions.ts +++ b/packages/plugin-goat/src/actions.ts @@ -85,8 +85,6 @@ function createAction( tool ); - console.log(`Parameters: ${JSON.stringify(parameters)}`); - const parsedParameters = tool.parameters.safeParse(parameters); if (!parsedParameters.success) { callback?.({ @@ -96,12 +94,6 @@ function createAction( return false; } - console.log( - `Executing action ${tool.name} with parameters: ${JSON.stringify( - parsedParameters.data - )}` - ); - const result = await tool.method( walletClient, parsedParameters.data From 9408709dcd3859db85d046bc04fc52efa93f4a96 Mon Sep 17 00:00:00 2001 From: Agustin Armellini Fischer Date: Sun, 1 Dec 2024 10:02:10 +0100 Subject: [PATCH 5/5] Update .env.example --- .env.example | 1 - 1 file changed, 1 deletion(-) diff --git a/.env.example b/.env.example index b8954089a8c..4905550ad15 100644 --- a/.env.example +++ b/.env.example @@ -88,7 +88,6 @@ HEURIST_IMAGE_MODEL= EVM_PRIVATE_KEY= EVM_PROVIDER_URL= - # Solana SOLANA_PRIVATE_KEY= SOLANA_PUBLIC_KEY=