feat: Add 0G plugin for file storage #416

Wilbert957 · 2024-11-19T09:15:42Z

This PR adds a new plugin for 0G.

Risks

Low. This change involves adding a new plugin, which is isolated and should not affect existing functionality.

Background

What does this PR do?

This PR adds a new plugin for 0G, which includes an action that allows users to upload local files to 0G Storage.
Future work will include extending 0G support for model serving, state persistence via KV store, and enhanced file management capabilities.

What kind of change is this?

Features (non-breaking change which adds functionality).

Why are we doing this? Any context or related work?

To extend the functionality of Eliza.

Documentation changes needed?

Require a change to the project documentation.

Testing

Where should a reviewer start?

The review can start with the new 0G plugin code, focusing on the action that uploads files to ensure it handles files correctly and integrates well with 0G Storage.

Detailed testing steps

Set Environment Variables

Configure the following variables: - `ZEROG_INDEXER_RPC` - `ZEROG_EVM_RPC` - `ZEROG_PRIVATE_KEY` - `ZEROG_FLOW_ADDRESS` [More details](https://github.com/0glabs/0g-ts-sdk)

Add 0g-plugin into character file
Ensure the @ai16z/plugin-0g is properly added and configured in the character file.

Interact with the Agent
Send a message to the agent: Upload the file at /path/to/your/file.txt to zg storage.

Screenshots

Before

After

Database changes

Deployment instructions

shakkernerd · 2024-11-19T15:09:09Z

Hey @Wilbert957 Great work!

There are conflicts that needs to be resolved before a merge could happen, could you fix that?

In the package.json for 0g-plugin, kind add dev command ("dev": "tsup --watch").

Wilbert957 · 2024-11-19T15:13:30Z

Thanks for your notification. Sure, I'll fix it ASAP. Shakker Nerd ***@***.***> 于2024年11月19日周二 23:09写道：

…

Hey @Wilbert957 <https://github.com/Wilbert957> Great work! There are conflicts that needs fixing, could you fix that? In the package.json for 0g-plugin, kind add dev command ("dev": "tsup --watch"). — Reply to this email directly, view it on GitHub <#416 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/BGT4B6HYQLKT3KSBOW3CFJT2BNICXAVCNFSM6AAAAABSBTEVX6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIOBVHE4DCNJSGA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Wilbert957 · 2024-11-19T15:24:16Z

Hey @Wilbert957 Great work!

There are conflicts that needs to be resolved before a merge could happen, could you fix that?

In the package.json for 0g-plugin, kind add dev command ("dev": "tsup --watch").

I've fixed it. Could you please check?

shakkernerd · 2024-11-19T15:33:56Z

Kindly attach a screengrab of the upload/file storage interaction.

@Wilbert957 This has been updated.

monilpat · 2024-11-19T19:12:53Z

packages/plugin-0g/src/actions/upload.ts

+import { promises as fs } from 'fs';
+
+
+const uploadTemplate = `Respond with a JSON markdown block containing only the extracted values. Use null for any values that cannot be determined.


Can we move this to a templates file for maintainability

Sure, thanks, I've fixed.

monilpat · 2024-11-19T19:13:55Z

packages/plugin-0g/src/actions/upload.ts

+        });
+
+        // Generate upload content
+        const content = await generateObject({


Can we consider using generateObjectV2 which actually uses z objects to be more type safe.

Sure, thanks, I've fixed.

monilpat · 2024-11-19T19:19:51Z

packages/plugin-0g/src/actions/upload.ts

+            const zgPrivateKey = runtime.getSetting("ZEROG_PRIVATE_KEY");
+            const flowAddr = runtime.getSetting("ZEROG_FLOW_ADDRESS");
+            const filePath = content.filePath;
+            if (!filePath) {


Can we add escape clauses if those settings aren't there? Or will validate ensure this cannot happen

Sorry, maybe I didn't get you, but I checked settings-exsitance using the validator of the action.

monilpat · 2024-11-19T19:22:32Z

Please resolve conflicts and add a test and / or screen grab of working plugin functionality thanks so much! Amazing work with this plugin you are the GOAT!

monilpat · 2024-11-19T19:20:09Z

packages/plugin-0g/src/actions/upload.ts

+            if (err === null) {
+                console.log("File uploaded successfully, tx: ", tx);
+                } else {
+                console.log("Error uploading file: ", err);


console.error please thanks

Sure, thanks, I've fixed.

…e type safe generateObjectV2

Wilbert957 · 2024-11-20T02:10:52Z

Kindly attach a screengrab of the upload/file storage interaction.

@Wilbert957 This has been updated.

Sure, thanks. I've attached a screengrab.

Wilbert957 · 2024-11-20T02:12:32Z

Please resolve conflicts and add a test and / or screen grab of working plugin functionality thanks so much! Amazing work with this plugin you are the GOAT!

Sure, thanks. I've attached a screengrab.

Wilbert957 · 2024-11-20T14:41:59Z

Please resolve conflicts and add a test and / or screen grab of working plugin functionality thanks so much! Amazing work with this plugin you are the GOAT!

I've resolved conflicts~

Wilbert957 · 2024-11-20T14:42:47Z

Hey @Wilbert957 Great work!

There are conflicts that needs to be resolved before a merge could happen, could you fix that?

In the package.json for 0g-plugin, kind add dev command ("dev": "tsup --watch").

I've resolved conflicts~

Wilbert957 · 2024-11-25T03:13:40Z

Hey @Wilbert957 Great work!

There are conflicts that needs to be resolved before a merge could happen, could you fix that?

In the package.json for 0g-plugin, kind add dev command ("dev": "tsup --watch").

Hi @shakkernerd

I hope you're doing well! I wanted to kindly remind you that my pull request (#PR-416) is awaiting your review and approval. Your feedback would be greatly appreciated.

Wilbert957 · 2024-11-25T06:03:49Z

Hi, @monilpat. Conflicts resolved. Would know if can merge? Your feedback would be greatly appreciated.

root added 8 commits November 19, 2024 03:01

add zerog plugin

c95c2d3

rename storage to upload, update env

b32a546

1.rename pluging name, 2.add deps for agent

b6bad94

correct upload file name

17a374b

1.change some logs, 2.add file access check

83343ee

add readme of plugin-0g

360e66c

new plugin description

fb72dac

change log

ea52509

Wilbert957 changed the title ~~415 add 0g plugin~~ 415 add 0G plugin Nov 19, 2024

Wilbert957 changed the title ~~415 add 0G plugin~~ feat: add 0G plugin Nov 19, 2024

Wilbert957 changed the title ~~feat: add 0G plugin~~ feat(plugin): Add 0G plugin for file storage Nov 19, 2024

Wilbert957 changed the title ~~feat(plugin): Add 0G plugin for file storage~~ feat: Add 0G plugin for file storage Nov 19, 2024

sirkitree requested a review from shakkernerd November 19, 2024 14:27

add script for development using tsup watch mode

c67e4fd

monilpat reviewed Nov 19, 2024

View reviewed changes

monilpat requested changes Nov 19, 2024

View reviewed changes

1.add template into a separate file; 2.fix a incorrect log; 3.use mor…

bf8a940

…e type safe generateObjectV2

root added 2 commits November 20, 2024 15:36

resolve conflicts

3d302ba

rm unsued files uploaded by mistake

9c92116

Wilbert957 and others added 3 commits November 21, 2024 09:49

Merge branch 'main' into 415-add-0g-plugin

2ab3c88

Merge branch 'main' into 415-add-0g-plugin

f982242

fix: solve conflicts

4a1a9cc

Wilbert957 requested a review from monilpat November 25, 2024 05:48

lalalune approved these changes Nov 25, 2024

View reviewed changes

lalalune merged commit 8442d09 into elizaOS:main Nov 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add 0G plugin for file storage #416

feat: Add 0G plugin for file storage #416

Wilbert957 commented Nov 19, 2024 •

edited

Loading

shakkernerd commented Nov 19, 2024 •

edited

Loading

Wilbert957 commented Nov 19, 2024 via email

Wilbert957 commented Nov 19, 2024

shakkernerd commented Nov 19, 2024 •

edited

Loading

monilpat Nov 19, 2024

Wilbert957 Nov 20, 2024 •

edited

Loading

monilpat Nov 19, 2024

Wilbert957 Nov 20, 2024 •

edited

Loading

monilpat Nov 19, 2024

Wilbert957 Nov 20, 2024

monilpat commented Nov 19, 2024

monilpat Nov 19, 2024

Wilbert957 Nov 20, 2024 •

edited

Loading

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 25, 2024

Wilbert957 commented Nov 25, 2024

		import { promises as fs } from 'fs';


		const uploadTemplate = `Respond with a JSON markdown block containing only the extracted values. Use null for any values that cannot be determined.

feat: Add 0G plugin for file storage #416

feat: Add 0G plugin for file storage #416

Conversation

Wilbert957 commented Nov 19, 2024 • edited Loading

Risks

Background

What does this PR do?

What kind of change is this?

Why are we doing this? Any context or related work?

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

Screenshots

Before

After

Database changes

Deployment instructions

shakkernerd commented Nov 19, 2024 • edited Loading

Wilbert957 commented Nov 19, 2024 via email

Wilbert957 commented Nov 19, 2024

shakkernerd commented Nov 19, 2024 • edited Loading

monilpat Nov 19, 2024

Choose a reason for hiding this comment

Wilbert957 Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

monilpat Nov 19, 2024

Choose a reason for hiding this comment

Wilbert957 Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

monilpat Nov 19, 2024

Choose a reason for hiding this comment

Wilbert957 Nov 20, 2024

Choose a reason for hiding this comment

monilpat commented Nov 19, 2024

monilpat Nov 19, 2024

Choose a reason for hiding this comment

Wilbert957 Nov 20, 2024 • edited Loading

Choose a reason for hiding this comment

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 20, 2024

Wilbert957 commented Nov 25, 2024

Wilbert957 commented Nov 25, 2024

Wilbert957 commented Nov 19, 2024 •

edited

Loading

shakkernerd commented Nov 19, 2024 •

edited

Loading

shakkernerd commented Nov 19, 2024 •

edited

Loading

Wilbert957 Nov 20, 2024 •

edited

Loading

Wilbert957 Nov 20, 2024 •

edited

Loading

Wilbert957 Nov 20, 2024 •

edited

Loading