https://github.com/storacha/elizaos-plugin
🔌 A plugin providing distributed storage functionality for ElizaOS agents.
https://github.com/storacha/elizaos-plugin
client decentralized decentralized-storage elizaos elizaos-plugins filecoin ipfs plugin storage web3
Last synced: 2 months ago
JSON representation
🔌 A plugin providing distributed storage functionality for ElizaOS agents.
- Host: GitHub
- URL: https://github.com/storacha/elizaos-plugin
- Owner: storacha
- Created: 2025-02-24T12:55:41.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-17T19:42:06.000Z (2 months ago)
- Last Synced: 2025-03-17T20:38:05.223Z (2 months ago)
- Topics: client, decentralized, decentralized-storage, elizaos, elizaos-plugins, filecoin, ipfs, plugin, storage, web3
- Language: TypeScript
- Homepage: https://storacha.ai
- Size: 114 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# @storacha/elizaos-plugin
A plugin providing distributed storage functionality for ElizaOS agents.
## Description
The Storacha plugin enables agents to interact with a distributed storage network, allowing for file uploads and retrieval.
## Installation
```bash
pnpm install @storacha/elizaos-plugin
```
## Configuration
1. Add the plugin to the Agent configuration, e.g.
```typescript
// eliza/agent/src/defaultCharacter.ts
import { storagePlugin } from "@storacha/elizaos-plugin";
export const defaultCharacter: Character = {
name: "Eliza",
username: "eliza",
plugins: [storagePlugin],
...
};
```
2. Create the env var file
```bash
cp .env.example agent/.env
```
3. Generate and set the Agent Private Key
```bash
w3 key create
```
- Copy the private key (e.g., `MgCYJE...Ig3Kk=`) and set it to the `STORACHA_AGENT_PRIVATE_KEY` env var.
- Copy the Agent DID key (e.g., `did:key:...`) to create the Agent Delegation.
4. Create the Agent Delegation
- Replace `AGENT_DID_KEY` with the DID Key you copied in the previous step and execute:
```bash
w3 delegation create AGENT_DID_KEY \
--can 'store/add' \
--can 'filecoin/offer' \
--can 'upload/add' \
--can 'space/blob/add' \
--can 'space/index/add' | base64
```
- Copy the base64 encoded content and set it to the `STORACHA_AGENT_DELEGATION` env var.
5. Set the model
- If you are starting from scratch you may want to use OpenRouter API to provide the LLM Model for the Agent.
- Just create an account and API key at: https://openrouter.ai
- Then set the `OPENROUTER_API_KEY` env var.
- The default agent character is already configured to use OpenRouter.
## Build & Run
1. Build and start the agent from the project root folder
```bash
pnpm install --no-frozen-lockfile && pnpm build && pnpm start
```
2. In another terminal start the Web Client to interact with the agent
```bash
pnpm start:client
```
3. Open http://localhost:5173 in browser and have fun
## Features
### 1. File Upload
- STORAGE_UPLOAD action for uploading files to the Storacha network
- Supports multiple file types and sizes
- Provides a link to access uploaded files
### 2. File Retrieval
- STORAGE_RETRIEVE action for reading files from the IPFS based on a CID.
- Embeds the file in the Agent response as an attachment, so the user can download it.
## Development
1. Clone the repository
2. Install dependencies
```bash
pnpm install
```
3. Build the plugin
```bash
pnpm run build
```
## Dependencies
- @elizaos/core: workspace:*
## Future Enhancements
- Conversation History & Agent Context Backup
- Cross Agent Data Sharing
- Encryption with LIT Protocol
## License
MIT & Apache 2