Skip to content

Cap76 nits - #1913

Closed
JFWooten4 wants to merge 3 commits into
stellar:masterfrom
JFWooten4:cap76
Closed

Cap76 nits#1913
JFWooten4 wants to merge 3 commits into
stellar:masterfrom
JFWooten4:cap76

Conversation

@JFWooten4

Copy link
Copy Markdown
Contributor

I think these minor changes are clarifying.

Copilot AI review requested due to automatic review settings April 22, 2026 13:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

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 makes small editorial/formatting adjustments to the CAP-0076 protocol document to improve readability and correct/standardize wording and links.

Changes:

  • Rephrases parts of the Simple Summary and Motivation for clarity.
  • Standardizes several relative links to the contents/ CSV file.
  • Tweaks formatting (including introducing a NOTE admonition block) and minor wording adjustments in the specification/security sections.

Comment thread core/cap-0076.md Outdated
## Simple Summary

Fix the entries that have been archived in corrupted state due to a bug in protocol 23 *and have never had corruption observed*. Also update the fee pool to reflect the unintentional XLM burns.
Fixes the entries that have been archived in corrupted state due to a bug in protocol 23 *and have never had corruption observed*. Also updates the fee pool to reflect the unintentional XLM burns.

Copilot AI Apr 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Simple Summary sentence is grammatically awkward: the clause “and have never had corruption observed” reads as a dangling modifier relative to “entries”. Consider rephrasing (e.g., “Fixes entries … that were archived in a corrupted state … and for which corruption has never been observed”) to avoid ambiguity about what was observed and when.

Suggested change
Fixes the entries that have been archived in corrupted state due to a bug in protocol 23 *and have never had corruption observed*. Also updates the fee pool to reflect the unintentional XLM burns.
Fixes entries that were archived in a corrupted state due to a bug in protocol 23 and for which corruption has never been observed. Also updates the fee pool to reflect the unintentional XLM burns.

Copilot uses AI. Check for mistakes.
Comment thread core/cap-0076.md Outdated

Note, that this CAP does not allow amendment of any state that has actually been observed due to restoration. The only change that concerns restored corrupted entries is an amendment of the fee pool that is done just in order to reflect the total XLM balance on the network.
> [!NOTE]
> This CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the networks' total XLM balance.

Copilot AI Apr 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“networks' total XLM balance” should be singular possessive (“network’s total …”). As written, it reads like a plural possessive and is grammatically incorrect.

Suggested change
> This CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the networks' total XLM balance.
> This CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the network's total XLM balance.

Copilot uses AI. Check for mistakes.
Comment thread core/cap-0076.md Outdated
Comment on lines +34 to +35
> [!NOTE]
> This CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the networks' total XLM balance.

Copilot AI Apr 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This introduces GitHub-specific admonition syntax (> [!NOTE]). A quick scan of core/ CAPs shows no other uses of [!NOTE]; to keep formatting consistent and renderer-agnostic, consider using the existing prose style used elsewhere in CAPs (e.g., a normal paragraph starting with “Note,”) instead.

Suggested change
> [!NOTE]
> This CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the networks' total XLM balance.
Note, this CAP does not allow amendment of any state that has actually been observed due to restoration. The only change concerning restored corrupted entries is an amendment of the fee pool, implemented just in order to reflect the network's total XLM balance.

Copilot uses AI. Check for mistakes.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, but the code's locale and reference point across all documentation is GitHub. example

Comment thread core/cap-0076.md Outdated
#### Fee pool amendment

`31879035` stroops will be added to the `feePool` in the `LedgerHeader`. This change reflects the XLM burn that occurred due to bug. Specifically, two XLM contract balances have been restored with a balance that is lower than the balance they had before archival. The specific XLM burns are as follows (these can also be verified in [corrupted_hot_archive_entries](./../contents/cap-0076/corrupted_hot_archive_entries.csv)):
`31879035` stroops will be added to the `feePool` in the `LedgerHeader`. This change reflects the XLM burn that occurred due to bug. Specifically, two XLM contract balances have been restored with a balance that is lower than the balance they had before archival. The specific XLM burns are as follows (these can also be verified in [corrupted_hot_archive_entries](../contents/cap-0076/corrupted_hot_archive_entries.csv)):

Copilot AI Apr 22, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“occurred due to bug” is missing an article; “due to the bug” reads correctly and is consistent with surrounding phrasing.

Suggested change
`31879035` stroops will be added to the `feePool` in the `LedgerHeader`. This change reflects the XLM burn that occurred due to bug. Specifically, two XLM contract balances have been restored with a balance that is lower than the balance they had before archival. The specific XLM burns are as follows (these can also be verified in [corrupted_hot_archive_entries](../contents/cap-0076/corrupted_hot_archive_entries.csv)):
`31879035` stroops will be added to the `feePool` in the `LedgerHeader`. This change reflects the XLM burn that occurred due to the bug. Specifically, two XLM contract balances have been restored with a balance that is lower than the balance they had before archival. The specific XLM burns are as follows (these can also be verified in [corrupted_hot_archive_entries](../contents/cap-0076/corrupted_hot_archive_entries.csv)):

Copilot uses AI. Check for mistakes.
@github-actions

Copy link
Copy Markdown

This pull request is stale because it has been open for 30 days with no activity. It will be closed in 30 days unless the stale label is removed.

@github-actions github-actions Bot added the stale label May 22, 2026
@leighmcculloch

Copy link
Copy Markdown
Member

Thanks for the contribution, and the other recent many contributions as well. CAP-76 is final and so isn't receiving any edits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants