Repository navigation
docs(readme): document Marmot Protocol MIP support - #810
Merged
Merged
Conversation
The relay has implemented Marmot MIPs 00-03 since #602, but the only public mention is the CHANGELOG entry. Add it to the feature list so the support is discoverable from the README. Kinds: 443 (legacy KeyPackage), 444 (Welcome rumor, gift-wrapped only), 445 (Group Event), 10051 (KeyPackage relay list), 30443 (KeyPackage). NIP-11 advertises supported_mips: [0, 1, 2, 3].
🦋 Changeset detectedLatest commit: 313d306 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This was referenced Oct 10, 2026
 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
cameri
approved these changes
Oct 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What
Adds the Marmot Protocol to the feature list, and changes the list's intro from "NIPs" to "NIPs and MIPs".
Why
The relay has implemented Marmot MIPs 00–03 since #602, but the only public mention anywhere in the repo is the CHANGELOG entry. Anyone evaluating the relay for encrypted group messaging would have to read the changelog to discover it. This makes it discoverable from the README, which is where the surface belongs.
Concretely,
src/constants/base.tsalready documents the kinds:htag (MIP-03)d-tag deduplication)NIP-11 already advertises
supported_mips: [0, 1, 2, 3].Notes
patchchangeset, so the heavy jobs (Lint code,Build check, both test suites) skip on the path filter, as they did on docs(deploy): add sandbox deploy runbook and recreate-relay script #768.Context
This also unblocks adding the relay to
marmot-protocol/awesome-marmot, whose discovery gate requires a repository's description or README to mention Marmot explicitly — the relay currently meets neither, despite the code being Marmot-specific.