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.

[odilitime]

most people just copy .env.example to .env; if they're not using nostr are these defaults going to cause any problems?

[AbdelStark]

Nope, no impact at all if they are not using the Nostr client.
The keys are invalid anyway so someone has to explicitly set them correctly and use the Nostr client

[AbdelStark]

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