feat: metaplex bubblegum plugin

.env.example

@@ -178,6 +178,10 @@ SOLANA_ADMIN_PRIVATE_KEY= # This wallet is used to verify NFTs
 SOLANA_ADMIN_PUBLIC_KEY= # This wallet is used to verify NFTs
 SOLANA_VERIFY_TOKEN= # Authentication token for calling the verification API
 
+# Metaplex Bubblegum
+MPL_BUBBLEGUM_PRIVATE_KEY= # Metaplex Bubblegum private key
+MPL_BUBBLEGUM_RPC_URL= # Metaplex Bubblegum RPC URL (Needs support for DAS API)
+
 # Fallback Wallet Configuration (deprecated)
 WALLET_PRIVATE_KEY=
 WALLET_PUBLIC_KEY=

agent/src/index.ts

@@ -54,6 +54,7 @@ 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 { mplBubblegumPlugin } from "@elizaos/plugin-mpl-bubblegum";
 import { suiPlugin } from "@elizaos/plugin-sui";
 import { TEEMode, teePlugin } from "@elizaos/plugin-tee";
 import { tonPlugin } from "@elizaos/plugin-ton";
@@ -530,6 +531,10 @@ export async function createAgent(
                 !getSecret(character, "WALLET_PUBLIC_KEY")?.startsWith("0x"))
                 ? solanaPlugin
                 : null,
+            getSecret(character, "MPL_BUBBLEGUM_PRIVATE_KEY") &&
+            getSecret(character, "MPL_BUBBLEGUM_RPC_URL")
+                ? mplBubblegumPlugin
+                : null,
             (getSecret(character, "NEAR_ADDRESS") ||
                 getSecret(character, "NEAR_WALLET_PUBLIC_KEY")) &&
             getSecret(character, "NEAR_WALLET_SECRET_KEY")

packages/plugin-mpl-bubblegum/.npmignore

@@ -0,0 +1,6 @@
+*
+
+!dist/**
+!package.json
+!readme.md
+!tsup.config.ts

packages/plugin-mpl-bubblegum/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintGlobalConfig from "../../eslint.config.mjs";
+
+export default [...eslintGlobalConfig];

packages/plugin-mpl-bubblegum/package.json

@@ -0,0 +1,27 @@
+{
+    "name": "@elizaos/plugin-mpl-bubblegum",
+    "version": "0.1.5-alpha.5",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "@elizaos/plugin-tee": "workspace:*",
+        "@metaplex-foundation/digital-asset-standard-api": "1.0.4",
+        "@metaplex-foundation/mpl-bubblegum": "4.2.1",
+        "@metaplex-foundation/umi-bundle-defaults": "0.9.2",
+        "@metaplex-foundation/umi-web3js-adapters": "0.9.2",
+        "@metaplex-foundation/umi": "0.9.2",
+        "@solana/web3.js": "1.95.8"
+    },
+    "devDependencies": {
+        "@types/node": "20.0.0",
+        "tsup": "8.3.5"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "lint": "eslint --fix  --cache .",
+        "test": "vitest run"
+    }
+}

packages/plugin-mpl-bubblegum/src/actions/transfer.ts

@@ -0,0 +1,165 @@
+import {
+    ActionExample,
+    composeContext,
+    Content,
+    elizaLogger,
+    generateObject,
+    HandlerCallback,
+    IAgentRuntime,
+    Memory,
+    ModelClass,
+    State,
+} from "@elizaos/core";
+import { validateMplBubblegumConfig } from "../environment";
+import { getWalletKey } from "../utils";
+import { MplBubblegumProvider } from "../providers/bubblegumProvider";
+import { fromWeb3JsKeypair } from "@metaplex-foundation/umi-web3js-adapters";
+import { PublicKey } from "@metaplex-foundation/umi";
+
+export interface TransferContent extends Content {
+    assetId: string;
+    newLeafOwner: string;
+}
+
+function isTransferContent(
+    _runtime: IAgentRuntime,
+    content: any
+): content is TransferContent {
+    console.log("Content for transfer", content);
+    return (
+        typeof content.assetId === "string" &&
+        typeof content.newLeafOwner === "string"
+    );
+}
+
+const transferTemplate = `Respond with a JSON markdown block containing only the extracted values. Ensure that all extracted values, especially public key addresses, are complete and include every character as they appear in the messages. Use null for any values that cannot be determined.
+
+Example response:
+\`\`\`json
+{
+    "assetId": "54dQ8cfHsW1YfKYpmdVZhWpb9iSi6Pac82Nf7sg3bVb",
+    "newLeafOwner": "G2FAbFQPFa5qKXCetoFZQEvF9BVvCKbvUZvodpVidnoY"
+}
+\`\`\`
+
+{{recentMessages}}
+
+Given the recent messages, extract the following information about the requested token transfer:
+- Asset Id
+- New Leaf Owner  (new owner public key)
+
+Respond with a JSON markdown block containing only the extracted values.`;
+
+export default {
+    name: "SEND_COMPRESSED_NFT",
+    similes: ["TRANSFER_COMPRESSED_NFT", "SEND_CNFT", "TRANSFER_CNFT"],
+    validate: async (runtime: IAgentRuntime, message: Memory) => {
+        console.log("Validating config for user:", message.userId);
+        await validateMplBubblegumConfig(runtime);
+        return true;
+    },
+    description:
+        "Transfer compressed NFT (cNFT) from the agent wallet to another address",
+    handler: async (
+        runtime: IAgentRuntime,
+        message: Memory,
+        state: State,
+        _options: { [key: string]: unknown },
+        callback?: HandlerCallback
+    ) => {
+        elizaLogger.log("Starting SEND_COMPRESSED_NFT handler...");
+
+        if (!state) {
+            state = (await runtime.composeState(message)) as State;
+        } else {
+            state = await runtime.updateRecentMessageState(state);
+        }
+
+        const transferContext = composeContext({
+            state,
+            template: transferTemplate,
+        });
+
+        const content = await generateObject({
+            runtime,
+            context: transferContext,
+            modelClass: ModelClass.LARGE,
+        });
+
+        if (!isTransferContent(runtime, content)) {
+            console.error("Invalid content for SEND_COMPRESSED_NFT action.");
+            if (callback) {
+                callback({
+                    text: "Unable to process transfer request. Invalid content provided.",
+                    content: { error: "Invalid transfer content" },
+                });
+            }
+            return false;
+        }
+
+        try {
+            const { keypair: agentKeypair } = await getWalletKey(runtime, true);
+
+            const RPC_URL = runtime.getSetting("MPL_BUBBLEGUM_RPC_URL");
+
+            const agentKeypairAdapter = fromWeb3JsKeypair(agentKeypair);
+
+            const mplBubblegumProvider = new MplBubblegumProvider(
+                agentKeypairAdapter,
+                RPC_URL
+            );
+
+            const { signature, result } = await mplBubblegumProvider.transfer(
+                content.assetId as PublicKey,
+                content.newLeafOwner as PublicKey
+            );
+
+            console.log("Transfer successful", signature);
+
+            if (callback) {
+                callback({
+                    text: `Successfully transferred ${content.assetId} to ${content.newLeafOwner}\nTransaction: ${signature}`,
+                    content: {
+                        success: true,
+                        signature,
+                        recipient: content.newLeafOwner,
+                    },
+                });
+            }
+
+            return true;
+        } catch (error) {
+            console.error("Error in transfer", error);
+            if (callback) {
+                callback({
+                    text: `Error transferring tokens: ${error.message}`,
+                    content: { error: error.message },
+                });
+            }
+            return false;
+        }
+    },
+    examples: [
+        [
+            {
+                user: "{{user1}}",
+                content: {
+                    text: "Send BieefG47jAHCGZBxi2q87RDuHyGZyYC3vAzxpyu8pump to 9jW8FPr6BSSsemWPV22UUCzSqkVdTp6HTyPqeqyuBbCa",
+                },
+            },
+            {
+                user: "{{user2}}",
+                content: {
+                    text: "I'll send BieefG47jAHCGZBxi2q87RDuHyGZyYC3vAzxpyu8pump now...",
+                    action: "SEND_COMPRESSED_NFT",
+                },
+            },
+            {
+                user: "{{user2}}",
+                content: {
+                    text: "Successfully sent BieefG47jAHCGZBxi2q87RDuHyGZyYC3vAzxpyu8pump to 9jW8FPr6BSSsemWPV22UUCzSqkVdTp6HTyPqeqyuBbCa\nTransaction: 5KtPn3DXXzHkb7VAVHZGwXJQqww39ASnrf7YkyJoF2qAGEpBEEGvRHLnnTG8ZVwKqNHMqSckWVGnsQAgfH5pbxEb",
+                },
+            },
+        ],
+    ] as ActionExample[][],
+};

packages/plugin-mpl-bubblegum/src/environment.ts

@@ -0,0 +1,40 @@
+import { IAgentRuntime } from "@elizaos/core";
+import { z } from "zod";
+
+export const mplBubblegumEnvSchema = z.object({
+    MPL_BUBBLEGUM_PRIVATE_KEY: z
+        .string()
+        .min(1, "Private key for Bubblegum is required."),
+    MPL_BUBBLEGUM_RPC_URL: z
+        .string()
+        .min(1, "Bubblegum RPC URL with DAS API support is required."),
+});
+
+export type MplBubblegumConfig = z.infer<typeof mplBubblegumEnvSchema>;
+
+export async function validateMplBubblegumConfig(
+    runtime: IAgentRuntime
+): Promise<MplBubblegumConfig> {
+    try {
+        const config = {
+            MPL_BUBBLEGUM_PRIVATE_KEY:
+                runtime.getSetting("MPL_BUBBLEGUM_PRIVATE_KEY") ||
+                process.env.MPL_BUBBLEGUM_PRIVATE_KEY,
+            MPL_BUBBLEGUM_RPC_URL:
+                runtime.getSetting("MPL_BUBBLEGUM_RPC_URL") ||
+                process.env.MPL_BUBBLEGUM_RPC_URL,
+        };
+
+        return mplBubblegumEnvSchema.parse(config);
+    } catch (error) {
+        if (error instanceof z.ZodError) {
+            const errorMessages = error.errors
+                .map((err) => `${err.path.join(".")}: ${err.message}`)
+                .join("\n");
+            throw new Error(
+                `Mpl Bubblegum configuration validation failed:\n${errorMessages}`
+            );
+        }
+        throw error;
+    }
+}

packages/plugin-mpl-bubblegum/src/index.ts

@@ -0,0 +1,12 @@
+import { Plugin } from "@elizaos/core";
+import transfer from "./actions/transfer";
+
+export const mplBubblegumPlugin: Plugin = {
+    name: "mpl-bubblegum",
+    description: "Bubblegum Plugin for Eliza",
+    actions: [transfer],
+    providers: [],
+    evaluators: [],
+    services: [],
+    clients: [],
+};