Wording and consistency fixes: state archival, Starlight, Horizon lifecycle, allocator, Lab keypairs#2620
Merged
ElliotFriend merged 2 commits intoJul 16, 2026
Conversation
- State archival: qualify auto-restore semantics in both directions — archived-entry footprints fail only when the entry isn't in the transaction's restore list, and auto-restore requires the restore list (CAP-0066), not mere footprint presence - Glossary: Starlight is an archived experimental project, not "Stellar's layer 2 protocol" in the present tense - Horizon lifecycle: apply the sanctioned PR stellar#2146 wording ("nearing end-of-life") to the three remaining pages still saying "considered deprecated" / "Horizon (deprecated)", and fix a "compatiblity" typo - Hello World: soften "no allocator and no heap memory" — the SDK has an opt-in `alloc` feature; link the alloc example - Lab saved keypairs: disclose that saved keypairs are obfuscated, not encrypted (and pre-Sept-2025 saves may remain plain text) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR applies documentation wording and consistency fixes across Soroban state archival behavior, Horizon lifecycle messaging, Starlight status, Soroban allocator defaults, and Stellar Lab saved keypairs security disclosure.
Changes:
- Clarifies Protocol 23+ auto-restoration behavior by consistently requiring the transaction restore list (and adjusts
RestoreFootprintOppositioning accordingly). - Aligns Horizon lifecycle phrasing to the “nearing end-of-life…” wording and updates related docs surfaces.
- Updates ancillary wording: Starlight marked as archived/unmaintained, Soroban allocator described as “by default”, and Lab saved keypairs storage risk disclosed.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tools/lab/saved/keypairs.mdx | Adds explicit disclosure that saved keypairs are not encrypted (and are recoverable). |
| docs/tools/lab/api-explorer/horizon-endpoint.mdx | Updates Horizon warning language to “nearing end-of-life…” and links to Portfolio APIs. |
| docs/README.mdx | Updates docs landing-page reference to Horizon lifecycle (“nearing end-of-life”). |
| docs/learn/glossary.mdx | Rewords Starlight glossary entry as archived/unmaintained experimental prior work. |
| docs/learn/fundamentals/contract-development/storage/state-archival.mdx | Adds restore-list qualifier to “fail immediately” wording and refines RestoreFootprintOp guidance. |
| docs/data/apis/README.mdx | Aligns Horizon lifecycle warning language and fixes “compatibility” typo. |
| docs/build/smart-contracts/getting-started/hello-world.mdx | Clarifies that Soroban has no allocator/heap by default and links to alloc example. |
| docs/build/guides/storage/choosing-the-right-storage.mdx | Mentions auto-restore via restore list as the usual restoration path, with manual fallback. |
| docs/build/guides/archival/create-restoration-footprint-js.mdx | Updates Protocol 23+ messaging around auto-restore vs RestoreFootprintOp. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
ElliotFriend
changed the title
|
Preview is available here: |
…anchor Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Preview is available here: |
This was referenced Jul 15, 2026
briwylde08
approved these changes
Jul 16, 2026
This was referenced Jul 16, 2026
Open
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.
Batch quick-fix for five Raven-reported wording/consistency issues. All claims verified against CAP-0066, stellar-core behavior, live repos, and Lab source before editing.
Changes
State archival auto-restore nuance (#2568)
state-archival.mdx:96claimed an archived-entry footprint "will fail immediately" unqualified, contradicting the CAP-0066 auto-restoration section on the same page. But the two-edit fix suggested in the issue would have left the page self-contradictory in the opposite direction — several spots overstate auto-restore by omitting the restore-list requirement. Fixed all surfaces consistently:state-archival.mdx— the "fail immediately" claim now carries the restore-list qualifier; the two "automatically restored when they appear in a footprint" sentences now say entries must be in the transaction's restore list (usually populated by simulation)create-restoration-footprint-js.mdx— same overstated sentence, repeated verbatim, same fixchoosing-the-right-storage.mdx— no longer presentsRestoreFootprintOpas the only restoration pathStarlight glossary entry (#2591)
The glossary described Starlight in the present tense as "Stellar's layer 2 protocol." It was an experimental project whose repo (stellar-deprecated/starlight) has been archived since April 2024. Reworded with the repo link.
Horizon lifecycle wording (#2592)
PR #2146 deliberately settled on "nearing end-of-life…" wording for Horizon (on
stellar-stack.mdx), but three pages still carried the older, stronger phrasing. Copied the sanctioned wording to:docs/data/apis/README.mdx(also fixes a "compatiblity" typo)docs/tools/lab/api-explorer/horizon-endpoint.mdxdocs/README.mdx— the docs landing page still said "Horizon (deprecated)" flat-outAllocator claim in Hello World (#2594)
hello-world.mdxclaimed absolutely that there is "no allocator and no heap memory in Soroban contracts," contradicting our own alloc example and the SDK's opt-inallocfeature. Softened to "by default" with a link. (The similar "no memory allocator" statement onenvironment-concepts.mdxdescribes the raw Wasm VM and is correct as-is, so it's untouched.)Lab saved keypairs storage disclosure (#2605)
The Lab UI already warns inline that saved keypairs are unencrypted; the docs page didn't mention the security property at all. Added a sentence: saved keypairs are obfuscated (XOR with a public constant), not encrypted — treat them as recoverable — and keypairs saved before September 2025 may remain literal plaintext until re-saved.
Closes #2568
Closes #2591
Closes #2592
Closes #2594
Closes #2605
🤖 Generated with Claude Code