-
Notifications
You must be signed in to change notification settings - Fork 26
docs: document extending events #385
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
tcheeric
merged 1 commit into
develop
from
codex/create-documentation-for-extending-events
Aug 19, 2025
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Extending Events | ||
|
|
||
| This project uses factories and registries to make it easy to introduce new event types while keeping core classes stable. | ||
|
|
||
| ## Factory and Registry Overview | ||
|
|
||
| - **Event factories** (e.g. [`EventFactory`](../../nostr-java-api/src/main/java/nostr/api/factory/EventFactory.java) and its implementations) centralize event creation so that callers don't have to handle boilerplate like setting the sender, tags, or content. | ||
| - **TagRegistry** maps tag codes to concrete implementations, allowing additional tag types to be resolved at runtime without modifying `BaseTag`. | ||
|
|
||
| ## Adding a New Event Type | ||
|
|
||
| 1. **Define the kind.** Add a constant to [`Kind`](../../nostr-java-base/src/main/java/nostr/base/Kind.java) or reserve a custom value. | ||
| 2. **Implement the event.** Create a class under `nostr.event.impl` that extends `GenericEvent` or a more specific base class. | ||
| 3. **Provide a factory.** Implement a factory extending `EventFactory` to encapsulate default tags and content for the new event. | ||
| 4. **Register tags.** If the event introduces new tag codes, register their factory functions with [`TagRegistry`](../../nostr-java-event/src/main/java/nostr/event/tag/TagRegistry.java). | ||
| 5. **Write tests.** Add unit and integration tests covering serialization, deserialization, and NIP compliance. | ||
| 6. **Follow contributing guidelines.** Run `mvn -q verify` before committing, ensure events comply with Nostr NIPs, and document your changes. | ||
|
|
||
| ## Testing & Contribution Requirements | ||
|
|
||
| - Run `mvn -q verify` from the repository root and ensure all checks pass. | ||
| - Include comprehensive tests for new functionality and remove unused imports. | ||
| - Summaries of changes and test results are expected in pull requests. | ||
|
|
||
| Refer to the repository's `AGENTS.md` for the full list of contribution expectations. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 reference to
AGENTS.mdappears to be a non-standard filename for contribution guidelines. Consider verifying this filename exists or if it should beCONTRIBUTING.mdwhich is the conventional name for contribution guidelines.