feat: Implement Nostr client

[AbdelStark]

Relates to:

Risks

Low. It's an optional client to use.

Background

What does this PR do?

What kind of change is this?

Features (non-breaking change which adds functionality)

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

Nostr is the simplest open protocol that is able to create a censorship-resistant global "social" network once and for all.

It's nature and strong focus on censorship-resistance makes it a perfect fit for the Eliza agent framework.

Configuration

Here are the env variables that need to be set in the .env file:

Variable	Description	Example
NOSTR_RELAYS	The list of Nostr relays to connect to	wss://relay.damus.io,wss://relay.primal.net
NOSTR_NSEC_KEY	Nostr Private Key (starts with nsec)	nsec1...
NOSTR_NPUB_KEY	Nostr Public Key (starts with npub)	npub1...
NOSTR_POLL_INTERVAL	How often (in seconds) to check for Nostr interactions	120
NOSTR_POST_IMMEDIATELY	Whether to post immediately or not	false
NOSTR_DRY_RUN	Whether to dry run or not	false

Sample configuration:

# The list of Nostr relays to connect to.
NOSTR_RELAYS="wss://relay.damus.io,wss://relay.primal.net"
# Nostr Private Key (starts with nsec)
NOSTR_NSEC_KEY="nsec1..."
# Nostr Public Key (starts with npub)
NOSTR_NPUB_KEY="npub1..."
# How often (in seconds) the bot should check for Nostr interactions (default: 2 minutes)
NOSTR_POLL_INTERVAL=120
# Whether to post immediately or not
NOSTR_POST_IMMEDIATELY=false
# Whether to dry run or not
NOSTR_DRY_RUN=false

Note: The nsec configured key is used as the default signer when instantiating the NDK instance.

Nostr client must be set in the Character definition, example:

{
    "name": "goku",
    "clients": ["nostr"],
    "modelProvider": "anthropic"
    
}

Changes summary

• Add env variables for Nostr in .env.example.
• Introduce Nostr NDK for Nostr client.
• Implement Nostr client in Eliza (in packages/client-nostr).
  • Implement NostrClient class.
  • Implement NostrInteractionManager in packages/client-nostr/src/interactions.ts. For now it's a no op service.
  • Implement NostrPostManager in packages/client-nostr/src/post.ts.

Resources

• Nostr Github
• What is Nostr ?
• Nostr online dev tools

Documentation changes needed?

My changes do not require a change to the project documentation.

Testing

Where should a reviewer start?

Detailed testing steps

• As anon   - run pnpm run dev --characters="characters/goku.character.json"   - verify that Nostr notes are posted

Screenshots

Screenshot of Nostr notes posted by the agent:

Screenshot of terminal of the running agent with logs:

Discord username

abdel.stark

[odilitime]

S3 changes trip me up for a second but I think I get it now

[AbdelStark]

S3 changes trip me up for a second but I think I get it now

Yeah this is not related to the Nostr client, but for some reasons there was an error because of a mismatch of interface for the S3 service, and I had to fix it.

[AbdelStark]

hey sir @odilitime i fixed all the conflicts, can we move forward with this PR ?

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[AbdelStark]

Closed in favor of https://github.com/elizaOS/eliza/pull/2982 As requested by @wtfsayo