- Notifications
You must be signed in to change notification settings - Fork26
docs: add custom events howto#386
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
codecov-commenter commentedAug 19, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report?Let us know! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Pull Request Overview
This PR adds documentation for creating and publishing custom Nostr events using the nostr-java library. The guide explains how to work with non-standard event kinds while adhering to the Nostr protocol specifications.
- Adds a comprehensive how-to guide for custom Nostr events
- Provides a practical Java code example demonstrating event creation, signing, and publishing
- Documents the required event fields and references relevant NIPs (Nostr Improvement Proposals)
Tip: Customize your code reviews with copilot-instructions.md.Create the file orlearn how to get started.
| // Required fields `id` and `sig` are populated when signing | ||
| identity.sign(event); | ||
| try (StandardWebSocketClient client = new StandardWebSocketClient("wss://relay.example.com")) { |
CopilotAIAug 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The example uses a placeholder relay URL 'wss://relay.example.com' which is not a real relay. Consider using a well-known public relay like 'wss://relay.damus.io' or add a note that users should replace this with an actual relay URL.
| try (StandardWebSocketClient client = new StandardWebSocketClient("wss://relay.example.com")) { | |
| try (StandardWebSocketClient client = new StandardWebSocketClient("wss://relay.damus.io")) { |
692a1ed intodevelopUh oh!
There was an error while loading.Please reload this page.
Summary
Testing
mvn -q verify(fails: Could not find a valid Docker environment)https://chatgpt.com/codex/tasks/task_b_68a48d9bbdf08331a313fcb945fe393b