Skip to content

Clarify mapping keys and remove stale comments - #1161

Merged
KillariDev merged 3 commits into
mainfrom
t3code/review-code-comments
Oct 14, 2026
Merged

KillariDev merged 3 commits into
mainfrom
t3code/review-code-comments

Conversation

@KillariDev

@KillariDev KillariDev commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Document the meaning and order of unnamed Solidity mapping keys and values, including ERC-1155 balances and approvals, share migration accounting, escrow outcomes, approval nonces, factory deployment IDs, and auction/carry-tree indexes. Distinguish one-based Fenwick indexes from zero-based MMR leaf indexes and specify accounting units where needed.

Remove stale or redundant procedural comments and a commented-out escalation migration call. Clarify underfunded auction estimates, attoETH units, and the rationale for broad live-network price-test bounds.

All source and test edits are comments only. Refresh the comment-sensitive documentation audit fingerprints and regenerate the reference pages' hidden fingerprint comments. Executable behavior, assertions, compiled ABIs, storage declarations, license headers, compiler directives, and rendered documentation are unchanged.

Validation:

  • bun run tsc
  • bun ./tooling/testing/bun-test.mts tooling/docs/contract-reference-metadata.test.ts (5 tests)
  • bun run format:check
  • bun run check
  • bun run knip
  • bun run check:generated-clean
  • Direct diff inspection confirming comment-only source/test edits and hidden-comment-only generated HTML edits
  • git diff --check

Protocol, application, and browser tests are skipped because executable behavior, assertions, and interfaces are unchanged. Browser QA and visual review are skipped because no rendered appearance or interaction changes. The affected metadata tests and documentation freshness check cover the audit-pin updates; documentation review covers the generated HTML comments.

@KillariDev KillariDev changed the title Remove redundant comments and clarify current guarantees Clarify mapping keys and remove stale comments Oct 13, 2026
@KillariDev
KillariDev enabled auto-merge October 13, 2026 23:58
@KillariDev
KillariDev added this pull request to the merge queue Oct 13, 2026
Merged via the queue into main with commit ea1feb4 Oct 14, 2026
48 checks passed
@KillariDev
KillariDev deleted the t3code/review-code-comments branch October 14, 2026 00:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant