RPC Call

Connecting to the Messaging Layer

To interact with the Messaging Layer, you have two options: connect to XePHY’s public relay URL or deploy a local instance. Choose based on your needs—public for simplicity, local for development or control.

1. Local Deployment

• Prerequisites:

  • Docker: Ensure Docker is installed and running on your system to manage the messaging network services.

• Steps:

  1. Clone the repository:

     Copy

     git clone https://github.com/xephy-io/xephy-messaging-network-self-hosted.git
     cd xephy-messaging-network-self-hosted/xephy-messaging-network

  2. Launch the messaging layer using Docker Compose:

     Copy

     docker compose up --pull always

This deploys a self-hosted Nostr-based messaging network locally, ready to handle event subscriptions and publications for your XePHY applications. By default, it will be accessible at wss://localhost:8080.

Recommended Messaging Layer Client

Below are recommended libraries for interacting with the Nostr protocol across multiple programming languages, with hyperlinks to their official repositories or documentation.

Rust

• nostr-sdk
• nostr

JavaScript/TypeScript

• nostr-tools
• nostr-relay

Python

• pynostr
• nostr-py

Go

• go-nostr

Kotlin

• nostr-kotlin

Swift

• NostrKit