chore: dynamic plugin imports

agent/src/index.ts

@@ -25,36 +25,14 @@ import {
     stringToUuid,
     validateCharacterConfig,
     CacheStore,
+    getSecret,
+    loadPlugins,
 } from "@elizaos/core";
 import { RedisClient } from "@elizaos/adapter-redis";
-import { zgPlugin } from "@elizaos/plugin-0g";
 import { bootstrapPlugin } from "@elizaos/plugin-bootstrap";
-import createGoatPlugin from "@elizaos/plugin-goat";
-// import { intifacePlugin } from "@elizaos/plugin-intiface";
 import { DirectClient } from "@elizaos/client-direct";
-import { aptosPlugin } from "@elizaos/plugin-aptos";
-import {
-    advancedTradePlugin,
-    coinbaseCommercePlugin,
-    coinbaseMassPaymentsPlugin,
-    tokenContractPlugin,
-    tradePlugin,
-    webhookPlugin,
-} from "@elizaos/plugin-coinbase";
-import { confluxPlugin } from "@elizaos/plugin-conflux";
-import { evmPlugin } from "@elizaos/plugin-evm";
-import { storyPlugin } from "@elizaos/plugin-story";
-import { flowPlugin } from "@elizaos/plugin-flow";
-import { imageGenerationPlugin } from "@elizaos/plugin-image-generation";
-import { multiversxPlugin } from "@elizaos/plugin-multiversx";
-import { nearPlugin } from "@elizaos/plugin-near";
-import { nftGenerationPlugin } from "@elizaos/plugin-nft-generation";
 import { createNodePlugin } from "@elizaos/plugin-node";
-import { solanaPlugin } from "@elizaos/plugin-solana";
-import { suiPlugin } from "@elizaos/plugin-sui";
-import { TEEMode, teePlugin } from "@elizaos/plugin-tee";
-import { tonPlugin } from "@elizaos/plugin-ton";
-import { zksyncEraPlugin } from "@elizaos/plugin-zksync-era";
+import { TEEMode } from "@elizaos/plugin-tee";
 import Database from "better-sqlite3";
 import fs from "fs";
 import path from "path";
@@ -457,10 +435,6 @@ function isFalsish(input: any): boolean {
     return falsishValues.includes(value.trim().toLowerCase());
 }
 
-function getSecret(character: Character, secret: string) {
-    return character.settings?.secrets?.[secret] || process.env[secret];
-}
-
 let nodePlugin: any | undefined;
 
 export async function createAgent(
@@ -488,12 +462,133 @@ export async function createAgent(
         throw new Error("Invalid TEE configuration");
     }
 
-    let goatPlugin: any | undefined;
-    if (getSecret(character, "ALCHEMY_API_KEY")) {
-        goatPlugin = await createGoatPlugin((secret) =>
-            getSecret(character, secret)
-        );
-    }
+    const dynamicPlugins = await loadPlugins(character, [
+        {
+            secrets: ["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"],
+            importFn: () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.coinbaseMassPaymentsPlugin
+                ),
+        },
+        {
+            secrets: ["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"],
+            importFn: () =>
+                import("@elizaos/plugin-coinbase").then((m) => m.tradePlugin),
+        },
+        {
+            secrets: ["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"],
+            importFn: () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.tokenContractPlugin
+                ),
+        },
+        {
+            secrets: ["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"],
+            importFn: () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.advancedTradePlugin
+                ),
+        },
+        {
+            secrets: "CONFLUX_CORE_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-conflux").then((m) => m.confluxPlugin),
+        },
+        {
+            secrets: "SOLANA_PUBLIC_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-solana").then((m) => m.solanaPlugin),
+        },
+        {
+            secrets: [
+                "NEAR_ADDRESS",
+                "NEAR_WALLET_PUBLIC_KEY",
+                "NEAR_WALLET_SECRET_KEY",
+            ],
+            importFn: () =>
+                import("@elizaos/plugin-near").then((m) => m.nearPlugin),
+        },
+        {
+            secrets: "EVM_PUBLIC_KEY",
+            importFn: () =>
+                import("@ai16z/plugin-evm").then((m) => m.evmPlugin),
+        },
+        {
+            secrets: [
+                "SOLANA_PUBLIC_KEY",
+                "SOLANA_ADMIN_PUBLIC_KEY",
+                "SOLANA_PRIVATE_KEY",
+                "SOLANA_ADMIN_PRIVATE_KEY",
+            ],
+            importFn: () =>
+                import("@elizaos/plugin-nft-generation").then(
+                    (m) => m.nftGenerationPlugin
+                ),
+        },
+        {
+            secrets: "ZEROG_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-0g").then((m) => m.zgPlugin),
+        },
+        {
+            secrets: "COINBASE_COMMERCE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.coinbaseCommercePlugin
+                ),
+        },
+        {
+            secrets: [
+                "FAL_API_KEY",
+                "OPENAI_API_KEY",
+                "VENICE_API_KEY",
+                "HEURIST_API_KEY",
+            ],
+            importFn: () =>
+                import("@elizaos/plugin-image-generation").then(
+                    (m) => m.imageGenerationPlugin
+                ),
+        },
+        {
+            secrets: ["FLOW_ADDRESS"],
+            importFn: () =>
+                import("@elizaos/plugin-flow").then((m) => m.flowPlugin),
+        },
+        {
+            secrets: "APTOS_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-aptos").then((m) => m.aptosPlugin),
+        },
+        {
+            secrets: "MVX_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-multiversx").then(
+                    (m) => m.multiversxPlugin
+                ),
+        },
+        {
+            secrets: "ZKSYNC_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-zksync-era").then(
+                    (m) => m.zksyncEraPlugin
+                ),
+        },
+        {
+            secrets: "TON_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-ton").then((m) => m.tonPlugin),
+        },
+        {
+            secrets: "SUI_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-sui").then((m) => m.suiPlugin),
+        },
+        {
+            secrets: "STORY_PRIVATE_KEY",
+            importFn: () =>
+                import("@elizaos/plugin-story").then((m) => m.storyPlugin),
+        },
+    ]);
 
     return new AgentRuntime({
         databaseAdapter: db,
@@ -502,76 +597,9 @@ export async function createAgent(
         evaluators: [],
         character,
         // character.plugins are handled when clients are added
-        plugins: [
-            bootstrapPlugin,
-            getSecret(character, "CONFLUX_CORE_PRIVATE_KEY")
-                ? confluxPlugin
-                : null,
-            nodePlugin,
-            getSecret(character, "SOLANA_PUBLIC_KEY") ||
-            (getSecret(character, "WALLET_PUBLIC_KEY") &&
-                !getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x"))
-                ? solanaPlugin
-                : null,
-            (getSecret(character, "NEAR_ADDRESS") ||
-                getSecret(character, "NEAR_WALLET_PUBLIC_KEY")) &&
-            getSecret(character, "NEAR_WALLET_SECRET_KEY")
-                ? nearPlugin
-                : null,
-            getSecret(character, "EVM_PUBLIC_KEY") ||
-            (getSecret(character, "WALLET_PUBLIC_KEY") &&
-                getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x"))
-                ? evmPlugin
-                : null,
-            (getSecret(character, "SOLANA_PUBLIC_KEY") ||
-                (getSecret(character, "WALLET_PUBLIC_KEY") &&
-                    !getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith(
-                        "0x"
-                    ))) &&
-            getSecret(character, "SOLANA_ADMIN_PUBLIC_KEY") &&
-            getSecret(character, "SOLANA_PRIVATE_KEY") &&
-            getSecret(character, "SOLANA_ADMIN_PRIVATE_KEY")
-                ? nftGenerationPlugin
-                : null,
-            getSecret(character, "ZEROG_PRIVATE_KEY") ? zgPlugin : null,
-            getSecret(character, "COINBASE_COMMERCE_KEY")
-                ? coinbaseCommercePlugin
-                : null,
-            getSecret(character, "FAL_API_KEY") ||
-            getSecret(character, "OPENAI_API_KEY") ||
-            getSecret(character, "VENICE_API_KEY") ||
-            getSecret(character, "HEURIST_API_KEY")
-                ? imageGenerationPlugin
-                : null,
-            ...(getSecret(character, "COINBASE_API_KEY") &&
-            getSecret(character, "COINBASE_PRIVATE_KEY")
-                ? [
-                      coinbaseMassPaymentsPlugin,
-                      tradePlugin,
-                      tokenContractPlugin,
-                      advancedTradePlugin,
-                  ]
-                : []),
-            ...(teeMode !== TEEMode.OFF && walletSecretSalt
-                ? [teePlugin, solanaPlugin]
-                : []),
-            getSecret(character, "COINBASE_API_KEY") &&
-            getSecret(character, "COINBASE_PRIVATE_KEY") &&
-            getSecret(character, "COINBASE_NOTIFICATION_URI")
-                ? webhookPlugin
-                : null,
-            getSecret(character, "ALCHEMY_API_KEY") ? goatPlugin : null,
-            getSecret(character, "FLOW_ADDRESS") &&
-            getSecret(character, "FLOW_PRIVATE_KEY")
-                ? flowPlugin
-                : null,
-            getSecret(character, "APTOS_PRIVATE_KEY") ? aptosPlugin : null,
-            getSecret(character, "MVX_PRIVATE_KEY") ? multiversxPlugin : null,
-            getSecret(character, "ZKSYNC_PRIVATE_KEY") ? zksyncEraPlugin : null,
-            getSecret(character, "TON_PRIVATE_KEY") ? tonPlugin : null,
-            getSecret(character, "SUI_PRIVATE_KEY") ? suiPlugin : null,
-            getSecret(character, "STORY_PRIVATE_KEY") ? storyPlugin : null,
-        ].filter(Boolean),
+        plugins: [bootstrapPlugin, nodePlugin, ...dynamicPlugins].filter(
+            Boolean
+        ),
         providers: [],
         actions: [],
         services: [],

packages/core/src/index.ts

@@ -22,5 +22,6 @@ export * from "./parsing.ts";
 export * from "./uuid.ts";
 export * from "./environment.ts";
 export * from "./cache.ts";
+export * from "./plugins.ts";
 export { default as knowledge } from "./knowledge.ts";
 export * from "./utils.ts";

packages/core/src/plugins.ts

@@ -0,0 +1,50 @@
+import { Character, DynamicPlugin, Plugin } from "./types";
+
+/**
+ * Gets a secret from the character settings or environment variables
+ * @param {Character} character - The character object
+ * @param {string} secret - The secret key
+ * @returns {string|undefined} The secret value or undefined if not found
+ */
+export function getSecret(
+    character: Character,
+    secret: string
+): string | undefined {
+    return character.settings?.secrets?.[secret] || process.env[secret];
+}
+
+/**
+ * Loads a plugin if all secrets are available
+ * @param {string|string[]} keys - The secret keys required for the plugin
+ * @param {Character} character - The character object
+ * @param {() => Promise<Plugin>} importFn - The function to import the plugin
+ * @returns {Promise<Plugin|null>} The plugin or null if secrets are missing
+ */
+export async function loadPlugin(
+    keys: string | string[],
+    character: Character,
+    importFn: () => Promise<Plugin>
+): Promise<Plugin | null> {
+    const keyArray = Array.isArray(keys) ? keys : [keys];
+    const hasAllSecrets = keyArray.every((key) => getSecret(character, key));
+    if (!hasAllSecrets) return null;
+    return importFn();
+}
+
+/**
+ * Loads multiple plugins if all secrets are available
+ * @param {Character} character - The character object
+ * @param {DynamicPlugin[]} definitions - The plugin definitions
+ * @returns {Promise<Plugin[]>} The loaded plugins
+ */
+export async function loadPlugins(
+    character: Character,
+    definitions: DynamicPlugin[]
+): Promise<Plugin[]> {
+    const plugins: Plugin[] = [];
+    for (const def of definitions) {
+        const p = await loadPlugin(def.secrets, character, def.importFn);
+        if (p) plugins.push(p);
+    }
+    return plugins;
+}

packages/core/src/types.ts

@@ -605,6 +605,11 @@ export type Plugin = {
     clients?: Client[];
 };
 
+export interface DynamicPlugin {
+    secrets: string | string[];
+    importFn: () => Promise<Plugin>;
+}
+
 /**
  * Available client platforms
  */

scripts/dev.sh

@@ -42,19 +42,17 @@ cat << "EOF"
 *                                                                     *
 *        "@elizaos/your-plugin-name": "workspace:*"                    *
 *                                                                     *
-*  5. Edit the 'index.ts' file in 'agent/src':                       *
-*                                                                     *
-*     a. Import your plugin:                                         *
-*                                                                     *
-*        import yourPlugin from '@elizaos/your-plugin-name';           *
-*                                                                     *
-*     b. Add your plugin to the `plugins` array:                     *
-*                                                                     *
-*        const plugins = [                                           *
-*          existingPlugin,                                           *
-*          yourPlugin,                                               *
-*        ];                                                          *
-*                                                                     *
+*  5. Edit the 'index.ts' file in 'agent/src':                        *
+*                                                                     *                  
+*   a. Use the `loadPlugins` function to dynamically import your plugin: *
+*                                                                    *
+*      {                                                             *
+*          secrets: ["YOUR_PLUGIN_SECRET_KEY"],                      *
+*          importFn: () => import("path/to/your-plugin").then((m) => m.yourPluginExport), *
+*      },                                                            *
+*                                                                    *
+*   b. Add this object to the array passed to the `loadPlugins` function. *
+*                                                                    *
 * This will ensure that your plugin's development server runs        *
 * alongside others when you execute this script.                     *
 ***********************************************************************