feat: Add Irys plugin

packages/core/src/types.ts

@@ -1226,6 +1226,25 @@ export interface IAwsS3Service extends Service {
     generateSignedUrl(fileName: string, expiresIn: number): Promise<string>;
 }
 
+
+export interface UploadIrysResult {
+    success: boolean;
+    url?: string;
+    error?: string;
+}
+
+export interface DataIrysFetchedFromGQL {
+    success: boolean;
+    data: any;
+    error?: string;
+}
+
+export interface IIrysService extends Service {
+    uploadDataOnIrys(data: any): Promise<UploadIrysResult>;
+    getDataFromAnAgent(agentsWalletPublicKeys: string[]): Promise<DataIrysFetchedFromGQL>;
+    uploadFileOrImageOnIrys(data: string): Promise<UploadIrysResult>;
+}
+
 export type SearchResult = {
     title: string;
     url: string;
@@ -1255,6 +1274,7 @@ export enum ServiceType {
     AWS_S3 = "aws_s3",
     BUTTPLUG = "buttplug",
     SLACK = "slack",
+    IRYS = "irys",
 }
 
 export enum LoggingLevel {

packages/plugin-irys/.npmignore

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

packages/plugin-irys/README.md

@@ -0,0 +1,139 @@
+# @elizaos/plugin-irys
+
+A plugin for ElizaOS that enables decentralized data storage and retrieval using Irys, a programmable datachain platform.
+
+## Overview
+
+This plugin integrates Irys functionality into ElizaOS, allowing agents to store and retrieve data in a decentralized manner. It provides a robust service for creating a decentralized knowledge base and enabling multi-agent collaboration.
+
+## Installation
+
+To install this plugin, run the following command:
+
+```bash
+pnpm add @elizaos/plugin-irys
+```
+
+
+## Features
+
+- **Decentralized Data Storage**: Store data permanently on the Irys network
+- **Data Retrieval**: Fetch stored data using GraphQL queries
+- **Multi-Agent Support**: Enable data sharing and collaboration between agents
+- **Ethereum Integration**: Built-in support for Ethereum wallet authentication
+
+## Configuration
+
+The plugin requires the following environment variables:
+
+- `EVM_WALLET_PRIVATE_KEY`: Your EVM wallet private key
+- `AGENTS_WALLET_PUBLIC_KEYS`: The public keys of the agents that will be used to retrieve the data (string separated by commas)
+
+For this plugin to work, you need to have an EVM (Base network) wallet with a private key and public address. To prevent any security issues, we recommend using a dedicated wallet for this plugin.
+
+> **Important**: The wallet address needs to have Base Sepolia ETH tokens to store images/files and any data larger than 100KB.
+
+## Usage
+
+### Uploading Data
+
+To upload data to the Irys network, you can use the `uploadDataOnIrys` function. This function will upload the data to the Irys network and return the transaction hash.
+
+```typescript
+const { IrysService } = require('@elizaos/plugin-irys');
+
+const irysService : IrysService = runtime.getService(ServiceType.IRYS)
+const data = "Hello, world!";
+const transactionResult = await irysService.uploadDataOnIrys(data);
+console.log(`Data uploaded successfully. Transaction hash: ${transactionResult}`);
+```
+
+To upload files or images to the Irys network, you can use the `uploadFileOrImageOnIrys` function:
+
+```typescript
+const { IrysService } = require('@elizaos/plugin-irys');
+
+const irysService : IrysService = runtime.getService(ServiceType.IRYS)
+const userAttachmentToStore = state.recentMessagesData[1].content.attachments[0].url.replace("agent\\agent", "agent");
+
+const transactionResult = await irysService.uploadFileOrImageOnIrys(userAttachmentToStore);
+console.log(`Data uploaded successfully. Transaction hash: ${transactionResult}`);
+```
+
+### Retrieving Data
+
+To retrieve data from the Irys network, you can use the `getDataFromAnAgent` function. This function will retrieve all data associated with the given wallet addresses. The function automatically detects the content type and returns either JSON data or file URLs accordingly.
+
+- For files and images: Returns the URL of the stored content
+- For other data types: Returns a JSON object with the following structure:
+```typescript
+{
+  data: string,    // The stored data
+  timestamp: Date  // When the data was stored
+}
+```
+
+```typescript
+const { IrysService } = require('@elizaos/plugin-irys');
+
+const irysService = runtime.getService(ServiceType.IRYS)
+const agentsWalletPublicKeys = runtime.getSetting("AGENTS_WALLET_PUBLIC_KEYS").split(",");
+const data = await irysService.getDataFromAnAgent(agentsWalletPublicKeys);
+console.log(`Data retrieved successfully. Data: ${data}`);
+```
+
+## About Irys
+
+Irys is the first Layer 1 (L1) programmable datachain designed to optimize both data storage and execution. By integrating storage and execution, Irys enhances the utility of blockspace, enabling a broader spectrum of web services to operate on-chain.
+
+### Key Features of Irys
+
+- **Unified Platform**: Combines data storage and execution, allowing developers to eliminate dependencies and integrate efficient on-chain data seamlessly.
+- **Cost-Effective Storage**: Optimized specifically for data storage, making it significantly cheaper to store data on-chain compared to traditional blockchains.
+- **Programmable Datachain**: The IrysVM can utilize on-chain data during computations, enabling dynamic and real-time applications.
+- **Decentralization**: Designed to minimize centralization risks by distributing control.
+- **Free Storage for Small Data**: Storing less than 100KB of data is free.
+- **GraphQL Querying**: Metadata stored on Irys can be queried using GraphQL.
+
+### GraphQL Query Examples
+
+The plugin uses GraphQL to retrieve transaction metadata. Here's an example query structure:
+
+```graphql
+query {
+  transactions(owners: ["0x1234567890", "0x0987654321"]) {
+    edges {
+      node {
+        id
+      }
+    }
+  }
+}
+```
+
+
+## API Reference
+
+### IrysService
+
+The main service provided by this plugin implements the following interface:
+
+```typescript
+interface IrysService {
+    uploadStringToIrys(data: string): Promise<string>;
+    getDataFromAnAgent(agentsWalletPublicKeys: string[]): Promise<string>;
+}
+```
+
+#### Methods
+
+- `uploadStringToIrys(data: string)`: Uploads a string to Irys and returns the transaction URL
+- `getDataFromAnAgent(agentsWalletPublicKeys: string[])`: Retrieves all data associated with the given wallet addresses
+
+## Testing
+
+While we don't currently have a formal test suite, all functions have been manually tested through agent actions to verify their functionality. Each function has been validated in real-world scenarios to ensure reliable performance.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

packages/plugin-irys/eslint.config.mjs

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

packages/plugin-irys/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@elizaos/plugin-irys",
+    "version": "0.1.0-alpha.1",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "@irys/upload": "^0.0.14",
+        "@irys/upload-ethereum": "^0.0.14",
+        "graphql-request": "^4.0.0"
+    },
+    "devDependencies": {
+        "tsup": "8.3.5",
+        "@types/node": "^20.0.0"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "lint": "eslint --fix  --cache ."
+    }
+}

packages/plugin-irys/src/agent-test/actions/retrieveData.ts

@@ -0,0 +1,44 @@
+import {
+    IAgentRuntime,
+    Action,
+    Memory,
+    State,
+    HandlerCallback,
+    ActionExample,
+    ServiceType,
+} from "@elizaos/core";
+
+import { IrysService } from "../services/irysService";
+
+export const retrieveDataAction: Action = {
+    name: "RETRIEVE_DATA_FROM_IRYS",
+    description: "Retrieve data from Irys for any message",
+    similes: ["RETRIEVE_DATA"],
+    validate: async (
+        _runtime: IAgentRuntime,
+        _message: Memory,
+    ) => {
+        return true;
+    },
+    handler: async (
+        runtime: IAgentRuntime,
+        message: Memory,
+        state: State,
+        options: any,
+        callback?: HandlerCallback
+    ): Promise<boolean> => {
+        console.log("Starting RETRIEVE_DATA_FROM_IRYS handler...");
+        const irysService: IrysService = runtime.getService(ServiceType.IRYS);
+        const agentsWalletPublicKeys = runtime.getSetting("AGENTS_WALLET_PUBLIC_KEYS").split(",");
+        const data = await irysService.getDataFromAnAgent(agentsWalletPublicKeys);
+        if (!data.success) {
+            console.log("Error retrieving data:", data.error);
+            return false;
+        }
+        console.log(`Data retrieved successfully. Data:`);
+        console.log(data.data);
+        return true;
+    },
+    examples: [
+    ] as ActionExample[][],
+}

packages/plugin-irys/src/agent-test/actions/storeData.ts

@@ -0,0 +1,47 @@
+import {
+    IAgentRuntime,
+    Action,
+    Memory,
+    State,
+    HandlerCallback,
+    ActionExample,
+    ServiceType,
+} from "@elizaos/core";
+
+import { IrysService } from "../services/irysService";
+
+export const storeDataAction: Action = {
+    name: "STORE_DATA_ON_IRYS",
+    description: "Store data on Irys for any message",
+    similes: ["DEFAULT_ACTION", "ANY_MESSAGE", "CATCH_ALL", "IRYS"],
+    validate: async (
+        _runtime: IAgentRuntime,
+        _message: Memory,
+    ) => {
+        console.log("Validating message:", _message.content.text);
+        return true;
+    },
+    handler: async (
+        runtime: IAgentRuntime,
+        message: Memory,
+        state: State,
+        options: any,
+        callback?: HandlerCallback
+    ): Promise<boolean> => {
+        console.log("Starting STORE_DATA_ON_IRYS handler...");
+        console.log("User message:", message.content.text);
+        console.log("Message generated:", state.recentMessagesData[0].content.text);
+        const irysService: IrysService = runtime.getService(ServiceType.IRYS);
+        const result = await irysService.uploadDataOnIrys(state.recentMessagesData[0].content.text);
+        if (state.recentMessagesData[1].content.attachments.length > 0) {
+            const userAttachmentToStore = state.recentMessagesData[1].content.attachments[0].url.replace("agent\\agent", "agent");
+            const resultImage = await irysService.uploadFileOrImageOnIrys(userAttachmentToStore);
+            console.log("Result Image:", resultImage);
+        }
+        console.log("Result:", result);
+
+        return true;
+    },
+    examples: [
+    ] as ActionExample[][],
+}