docs: correct .env.example's reticulum node id derivation (RE8) - #898
Merged
Merged
Conversation
.env.example still described the l5yth#896 model: the ingestor owning an RNS identity and deriving its !xxxxxxxx from "the transport identity already in RETICULUM_CONFIG_DIR". l5yth#897 shipped the opposite. RE8 excludes the transport identity from the pick, because RNS generates it as an independent keypair that matches none of the operator's announced destinations; the id is the discovered primary identity, the one announcing the most destinations on the machine. README says this correctly and .env.example contradicted it, pointing operators at the hash rnstatus prints as "Transport Instance". The strands-the-old-row caveat l5yth#897 added to README and CHANGELOG is carried over too, since .env.example is where an operator is standing when they set the variable that moves the id. Two guards in the deployment-surface class, both negative-tested against main, where they correctly fail. pytest 1443 passed; black clean.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
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.
.env.examplestill described the #896 model — the ingestor owning an RNS identity and deriving its!xxxxxxxxfrom "the transport identity already inRETICULUM_CONFIG_DIR".#897 shipped the opposite. SPEC RE8 excludes the transport identity from the pick, because RNS generates it as an independent keypair that matches none of the operator's announced destinations — keying on it registered
!fbf8e338for a host whose primary identity was27716218…. The id is the discovered primary identity, the one announcing the most destinations on the machine.README.mdsays this correctly ("It is not the transport identity, and not the hashrnstatusprints as 'Transport Instance'")..env.examplecontradicted it in both places it mentions the derivation, and an operator setting the variable reads.env.example, not the README.Also carries over the strands the old row caveat #897 added to
README.mdandCHANGELOG.md, since.env.exampleis where an operator is standing when they set the variable that moves the id.Docs only — no behavior change.
Tests
Two guards added to
TestReticulumDeploymentSurface, both negative-tested againstmainwhere they correctly fail:test_docs_do_not_key_the_ingestor_on_the_transport_identity— README and.env.examplemust not derive the id "from the transport identity", and must name the primary identity.test_docs_warn_that_changing_the_id_strands_the_old_rowhttps://claude.ai/code/session_01F8MHsE7xT4BhcQxPJf2AUR