chore: dynamic plugin imports

agent/src/index.ts

@@ -25,36 +25,14 @@ import {
     stringToUuid,
     validateCharacterConfig,
     CacheStore,
+    Plugin,
 } 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";
@@ -495,6 +473,18 @@ export async function createAgent(
         );
     }
 
+    async function loadPlugin(
+        keys: string | string[],
+        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();
+    }
+
     return new AgentRuntime({
         databaseAdapter: db,
         token,
@@ -504,73 +494,104 @@ export async function createAgent(
         // 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,
+            await loadPlugin(["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"], () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.coinbaseMassPaymentsPlugin
+                )
+            ),
+            await loadPlugin(["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"], () =>
+                import("@elizaos/plugin-coinbase").then((m) => m.tradePlugin)
+            ),
+            await loadPlugin(["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"], () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.tokenContractPlugin
+                )
+            ),
+            await loadPlugin(["COINBASE_API_KEY", "COINBASE_PRIVATE_KEY"], () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.advancedTradePlugin
+                )
+            ),
+            await loadPlugin("CONFLUX_CORE_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-conflux").then((m) => m.confluxPlugin)
+            ),
+            await loadPlugin("SOLANA_PUBLIC_KEY", () =>
+                import("@elizaos/plugin-solana").then((m) => m.solanaPlugin)
+            ),
+            await loadPlugin(
+                [
+                    "NEAR_ADDRESS",
+                    "NEAR_WALLET_PUBLIC_KEY",
+                    "NEAR_WALLET_SECRET_KEY",
+                ],
+                () => import("@elizaos/plugin-near").then((m) => m.nearPlugin)
+            ),
+            await loadPlugin("EVM_PUBLIC_KEY", () =>
+                import("@ai16z/plugin-evm").then((m) => m.evmPlugin)
+            ),
+            await loadPlugin(
+                [
+                    "SOLANA_PUBLIC_KEY",
+                    "SOLANA_ADMIN_PUBLIC_KEY",
+                    "SOLANA_PRIVATE_KEY",
+                    "SOLANA_ADMIN_PRIVATE_KEY",
+                ],
+                () =>
+                    import("@elizaos/plugin-nft-generation").then(
+                        (m) => m.nftGenerationPlugin
+                    )
+            ),
+            await loadPlugin("ZEROG_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-0g").then((m) => m.zgPlugin)
+            ),
+            await loadPlugin("COINBASE_COMMERCE_KEY", () =>
+                import("@elizaos/plugin-coinbase").then(
+                    (m) => m.coinbaseCommercePlugin
+                )
+            ),
+            await loadPlugin(
+                [
+                    "FAL_API_KEY",
+                    "OPENAI_API_KEY",
+                    "VENICE_API_KEY",
+                    "HEURIST_API_KEY",
+                ],
+                () =>
+                    import("@elizaos/plugin-image-generation").then(
+                        (m) => m.imageGenerationPlugin
+                    )
+            ),
+            await loadPlugin(["ALCHEMY_API_KEY"], () =>
+                import("@elizaos/plugin-goat").then((m) =>
+                    m.default((secret: string) => getSecret(character, secret))
+                )
+            ),
+            await loadPlugin("FLOW_ADDRESS", () =>
+                import("@elizaos/plugin-flow").then((m) => m.flowPlugin)
+            ),
+            await loadPlugin("APTOS_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-aptos").then((m) => m.aptosPlugin)
+            ),
+            await loadPlugin("MVX_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-multiversx").then(
+                    (m) => m.multiversxPlugin
+                )
+            ),
+            await loadPlugin("ZKSYNC_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-zksync-era").then(
+                    (m) => m.zksyncEraPlugin
+                )
+            ),
+            await loadPlugin("TON_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-ton").then((m) => m.tonPlugin)
+            ),
+            await loadPlugin("SUI_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-sui").then((m) => m.suiPlugin)
+            ),
+            await loadPlugin("STORY_PRIVATE_KEY", () =>
+                import("@elizaos/plugin-story").then((m) => m.storyPlugin)
+            ),
         ].filter(Boolean),
         providers: [],
         actions: [],

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 `await loadPlugin` function to dynamically import your plugin: *
+*                                                       *
+*      await loadPlugin(                                             *
+*        "YOUR_PLUGIN_SECRET_KEY",                                   *
+*        () => import("path/to/your-plugin"),                        *
+*        "yourPluginName"                                            *
+*      )                                                             *
+*                                                                    *
+*   b. Add this call in the `plugins` array.                         *
+*                                                                    *
 * This will ensure that your plugin's development server runs        *
 * alongside others when you execute this script.                     *
 ***********************************************************************