feat: RP for plugin-tee-verifiable-log-api #1260

gene-zhan · 2024-12-20T02:26:16Z

Relates to:

Run verifiable Eliza in the TEE.
Verifiable log for Eliza in the TEE
RP for plugin-tee-verifiable-log #1259

Risks

Low

Background

What does this PR do?

This PR builds upon plugin-tee-verifiable-log by modifying the direct client to add remote attestation and query interfaces for verifiable logs.

To better understand what verifiable logs are and why we implemented this feature, it is necessary to refer to the preceding PR that introduces plugin-tee-verifiable-log and provides the context for its development.

What kind of change is this?

Feature
TEE plugin
Verifiable feature

Documentation changes needed?

Yes, we will add documentation about api detail.

Testing

Where should a reviewer start?

Understand the existing plugin-tee
1. We rely on Eliza's existing plugin-tee and use its key derivation interface.
To better understand what verifiable logs are and why we implemented this feature, it is necessary to refer to the preceding PR that introduces plugin-tee-verifiable-log and provides the context for its development.
Understand what plugin-tee-verifiable-log does
1. Derive a key pair for verifiable logs: It uses the TEE to derive a key pair specifically for signing verifiable logs.
2. Remote attestation: The public key of verifiable logs is embedded in the remote attestation report, making it accessible for external verification.
3. Sign logs: This plugin accepts logs passed in from external modules (e.g., tweets sent and received by a Twitter client, or executed actions), signs them with the TEE-derived key pair, and stores them in the database.
4. Verification: External entities can use the remotely attested public key to verify these logs, ensuring that certain actions were indeed performed by TEE Eliza.

Detailed testing steps

It have completed the integration tests and can run the pnpm test file in the test directory.

odilitime · 2024-12-20T04:30:06Z

is this a duplicate of #1259 ?

packages/plugin-tee-verifiable-log/README.md

HashWarlock · 2024-12-20T05:25:30Z

packages/client-direct/src/README.md

@@ -43,3 +43,42 @@ curl -X GET "http://localhost:3000/fine-tune/8566c47a-ada8-441c-95bc-7bb07656c4c
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer jvBpxrTNqGqhnfQhSEqCdsG6aTSP8IBL".
 ```
+
+
+## Verifiable Attestations


Love this!

I think the easiest way to insert into documentation is to add this as a section called Enable Verifiable Logs for the Eliza in TEE Doc docs/docs/advanced/eliza-in-tee.md. Then add a reference to your discord or discord user to contact about the implementation.

I think we can work on this together for formatting & further enhancements/tutorials down the road. Separate into to two Plugin Sections:

TEE Plugin

Core Components

TEE Verifiable Log Plugin

Core Components

Tutorial

Enable Verifiable Log

Conclusion

Mention contributors for implementation and who to reach out to learn more about Verifiable Logs in TEE

No problem, let's work on this together. that’s exactly the idea behind building this plugin.

Let me explain further:

RP for plugin-tee-verifiable-log #1259 : This is a standalone log plugin that doesn’t modify other plugins or the client.

feat: RP for plugin-tee-verifiable-log-api #1260 : This modifies the direct client to provide a query interface for verifiable logs.

@HashWarlock @odilitime

HashWarlock · 2024-12-20T07:33:05Z

LGTM, outside of the 1 suggested edit. I can help document tomorrow and run a test to fix any bugs i may encounter

HashWarlock · 2024-12-21T07:03:00Z

packages/client-direct/src/index.ts

@@ -69,6 +71,9 @@ export class DirectClient {
        const apiRouter = createApiRouter(this.agents, this);
        this.app.use(apiRouter);

+        const apiLogRouter = createVerifiableLogApiRouter(this.agents, this);


If VERIFIABLE_LOGGING is not enabled, will this fail to start the agent? or will it just fail the API call?

fail the api call

HashWarlock · 2024-12-22T01:31:59Z

~~@odilitime~~ @gene-zhan what are the @gene-sf changes? Is that some automation? I'm approving this PR now

gene-zhan · 2024-12-22T04:04:39Z

~~@odilitime~~ @gene-zhan what are the @gene-sf changes? Is that some automation? I'm approving this PR now

sorry，I have configured two GitHub accounts locally. The problem with @gene-sf is that I forgot to switch the configuration file when submitting the code.

I have completed the following operations:

According to your review, I have fixed the code.
Updated the readme that is easier to understand.
Merged the latest version of main code.

gene-zhan · 2024-12-22T10:05:47Z

@shakkernerd I noticed that PRs #1331 and #1333 were reopened and this PR closed, which has left me a bit confused about the current direction. Should I merge my changes into the develop branch, or is there a different branch we should treat as the standard? I’ve submitted #1369. both cpppppp7 and I have been working diligently to make progress on this code contribution. I’d appreciate any clarification to ensure we align our efforts effectively. 😊

shakkernerd · 2024-12-22T12:48:44Z

Hi @gene-zhan Thanks for bringing this to my attention.
PRs that were closed about 5hours ago were due to develop branch getting accidentally deleted.
And yes, the develop remains the standard to open PRs to.

Good to hear about your active contributions.
Apologies for the confusion.

gene-zhan · 2024-12-22T14:19:56Z

@shakkernerd Thank you for your response! I accidentally submitted duplicate PRs (#1259 #1260 #1331, #1333, and #1369). I recommend prioritizing the merge of #1369, as this branch already includes the latest develop code. The other branches contain the same code but currently have conflicts that need to be resolved. Merging #1369 would help reduce additional workload. Thank you again for your understanding and support! 😊

The merge-base changed after approval.

gene-zhan · 2024-12-23T08:30:37Z

@shakkernerd @odilitime @HashWarlock How can I help facilitate the merging of this PR?

shakkernerd · 2024-12-23T09:18:14Z

Hi @gene-zhan which PRs do you need attention on and which ones should be closed?

gene-zhan · 2024-12-23T15:22:52Z

@shakkernerd

I would like to request the following actions:

Close the following pull requests (PRs):

RP for plugin-tee-verifiable-log #1259
feat: RP for plugin-tee-verifiable-log-api #1260
RP for plugin-tee-verifiable-log #1331
RP for plugin-tee-verifiable-log-api #1333
These PRs are no longer needed, and we can safely close them.

Merge PR feat: RP for plugin-tee-verifiable-log #1369
Please proceed with merging PR feat: RP for plugin-tee-verifiable-log #1369 into the develop branch as it contains the necessary updates/fixes we need.
Let me know if there are any issues or additional steps required. Thank you!

shakkernerd · 2024-12-23T17:03:52Z

Okay, thanks for listing them out. I will get to it.

shakkernerd · 2024-12-23T17:06:51Z

Closing in favor of #1369

GeneFuture and others added 8 commits December 15, 2024 11:59

Update README.md

464a87a

Update README.md

710fc4e

Merge branch 'ai16z:main' into main

f9d9f31

add tee-verifiable-log plugin

654bada

add tee-verifiable-log plugin

85be88d

add tee-verifiable-log plugin api

e74e390

add tee-verifiable-log plugin api

e4d995a

Update package.json

be19cc0

HashWarlock self-requested a review December 20, 2024 04:19

odilitime changed the base branch from main to develop December 20, 2024 04:30

odilitime added the Plugin_new Mark PRs that are a new plugin label Dec 20, 2024

odilitime mentioned this pull request Dec 20, 2024

RP for plugin-tee-verifiable-log #1259

Closed

HashWarlock reviewed Dec 20, 2024

View reviewed changes

packages/plugin-tee-verifiable-log/README.md Outdated Show resolved Hide resolved

HashWarlock reviewed Dec 20, 2024

View reviewed changes

odilitime changed the title ~~RP for plugin-tee-verifiable-log-api~~ feat: RP for plugin-tee-verifiable-log-api Dec 20, 2024

HashWarlock reviewed Dec 21, 2024

View reviewed changes

gene-zhan and others added 11 commits December 21, 2024 19:06

Merge branch 'ai16z:main' into main

a3c1417

merge main

2163be3

merge main

416e9b5

rollback main docs

b8a1e72

rollback main docs

a127898

rollback main docs

5c0bd9a

rollback main docs

edc830d

rollback main docs

7f057bc

rollback main docs

8286d6d

rollback main docs

0548d24

rollback main docs

d401c99

odilitime mentioned this pull request Dec 21, 2024

RP for plugin-tee-verifiable-log-api #1333

Closed

HashWarlock self-requested a review December 22, 2024 01:32

HashWarlock previously approved these changes Dec 22, 2024

View reviewed changes

shakkernerd deleted the branch elizaOS:develop December 22, 2024 07:02

shakkernerd closed this Dec 22, 2024

gene-zhan mentioned this pull request Dec 22, 2024

RP for plugin-tee-verifiable-log #1331

Closed

shakkernerd reopened this Dec 22, 2024

shakkernerd closed this Dec 23, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: RP for plugin-tee-verifiable-log-api #1260

feat: RP for plugin-tee-verifiable-log-api #1260

gene-zhan commented Dec 20, 2024

odilitime commented Dec 20, 2024

HashWarlock Dec 20, 2024 •

edited

Loading

HashWarlock Dec 20, 2024

cpppppp7 Dec 21, 2024

HashWarlock commented Dec 20, 2024

HashWarlock Dec 21, 2024

gene-zhan Dec 21, 2024

HashWarlock commented Dec 22, 2024 •

edited

Loading

gene-zhan commented Dec 22, 2024 •

edited

Loading

gene-zhan commented Dec 22, 2024

shakkernerd commented Dec 22, 2024

gene-zhan commented Dec 22, 2024

gene-zhan commented Dec 23, 2024

shakkernerd commented Dec 23, 2024 •

edited

Loading

gene-zhan commented Dec 23, 2024

shakkernerd commented Dec 23, 2024

shakkernerd commented Dec 23, 2024

feat: RP for plugin-tee-verifiable-log-api #1260

feat: RP for plugin-tee-verifiable-log-api #1260

Conversation

gene-zhan commented Dec 20, 2024

Relates to:

Risks

Background

What does this PR do?

What kind of change is this?

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

odilitime commented Dec 20, 2024

HashWarlock Dec 20, 2024 • edited Loading

Choose a reason for hiding this comment

HashWarlock Dec 20, 2024

Choose a reason for hiding this comment

cpppppp7 Dec 21, 2024

Choose a reason for hiding this comment

HashWarlock commented Dec 20, 2024

HashWarlock Dec 21, 2024

Choose a reason for hiding this comment

gene-zhan Dec 21, 2024

Choose a reason for hiding this comment

HashWarlock commented Dec 22, 2024 • edited Loading

gene-zhan commented Dec 22, 2024 • edited Loading

gene-zhan commented Dec 22, 2024

shakkernerd commented Dec 22, 2024

gene-zhan commented Dec 22, 2024

gene-zhan commented Dec 23, 2024

shakkernerd commented Dec 23, 2024 • edited Loading

gene-zhan commented Dec 23, 2024

shakkernerd commented Dec 23, 2024

shakkernerd commented Dec 23, 2024

HashWarlock Dec 20, 2024 •

edited

Loading

HashWarlock commented Dec 22, 2024 •

edited

Loading

gene-zhan commented Dec 22, 2024 •

edited

Loading

shakkernerd commented Dec 23, 2024 •

edited

Loading