Skip to content

chore: pre-announcement cleanup — stale README claims, license, security policy - #24

Merged
LeonardoVieira1630 merged 7 commits into
devfrom
chore/pre-announcement-cleanup
Aug 19, 2026
Merged

chore: pre-announcement cleanup — stale README claims, license, security policy#24
LeonardoVieira1630 merged 7 commits into
devfrom
chore/pre-announcement-cleanup

Conversation

@LeonardoVieira1630

Copy link
Copy Markdown
Member

Fixes surfaced by a pre-announcement review of the repo, ahead of the implementation report going to the ENS forum.

README corrections

  • Gas table regenerated from GasBench at the pinned block 25,445,220: propose is 138,778 (was 139,441) and castVote is 135,842 (was 135,831); queue, execute, and all live-governor numbers were already correct.
  • validateProposal signature: the hook receives the governor-computed proposalId as its first parameter; the prose and the layout row still described the pre-refactor(validator): pass the governor-computed proposalId through IProposalValidator #20 interface (descriptionHash).
  • Self-cancel: "the proposer can always cancel" was false — _validateCancel bars any cancel in the propose block. Now documented, including why the bar exists (kills the atomic propose→cancel bond round-trip).
  • Layout table: adds src/RulesetQuorumFraction.sol, the batch and voteNonce test suites, and the FeeOnTransferToken mock; page title now matches the project name.

New files

  • LICENSE (MIT): all source files carry MIT SPDX headers but the repo had no license text, so GitHub showed "no license".
  • SECURITY.md: private disclosure path (shared@blockful.io) for researchers arriving before the external audit.

Code comments and params

  • No+SlashAgainstAndSlash in RulesetCounting natspec and its test suite (the option's shipped name).
  • ENSParams gains BOND_AMOUNT and VETO_THRESHOLD — both were quoted in the README but existed nowhere in src/.
  • Removed the internal task-sync workflow.

No behavior changes: src diffs are comments and two new constants. Full unit suite (309 tests) and the fork gas bench pass locally.

🤖 Generated with Claude Code

LeonardoVieira1630 and others added 7 commits August 19, 2026 14:17
- regenerate the gas table from GasBench at the pinned block
  (propose 138,778 / castVote 135,842; queue and execute unchanged)
- validateProposal signature: the hook receives the governor-computed
  proposalId first; the layout row carried descriptionHash from the
  pre-proposalId interface
- self-cancel: 'always' was false — cancel is barred in the propose
  block; document the bar and why it exists
- layout table: add RulesetQuorumFraction, the batch and voteNonce
  suites, and the FeeOnTransferToken mock; retitle the page

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Source files already carried MIT SPDX headers with no license text at
the root. SECURITY.md gives researchers a private disclosure path
(shared@blockful.io) ahead of the external audit.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
No+Slash predates the option's final name; also reword one bond-suite
pin comment that referenced an internal review id.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
BOND_AMOUNT (1,000 ENS, EP 5.15) and VETO_THRESHOLD (500k ENS) were
quoted in the README but existed nowhere in src; ENSParams is the
single source of truth, so they live here.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Internal-process wiring, and it triggered on a branch that is being
retired.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@LeonardoVieira1630
LeonardoVieira1630 merged commit 2b22fda into dev Aug 19, 2026
7 of 8 checks passed
@LeonardoVieira1630
LeonardoVieira1630 deleted the chore/pre-announcement-cleanup branch August 19, 2026 18:48
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