Skip to content

Fix README to match actual contract implementation - #12

Merged
jj1980a merged 1 commit into
mainfrom
fix-readme-accuracy
Apr 16, 2026
Merged

jj1980a merged 1 commit into
mainfrom
fix-readme-accuracy

Conversation

@jj1980a

@jj1980a jj1980a commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removed documented functions, state variables, and events that don't exist in the contract
  • Fixed flashExecutionBid signature (was missing targetBlockNumber param) and corrected auction type usage ([bytes32(0)] sentinel, not empty array)
  • Fixed event signatures and added missing RelayBidFailed event
  • Removed fabricated mechanics (gas-adjusted bidding, EOA restriction)
  • Added repo structure, build/test/deploy instructions, constants, and searcher integration guide

The README documented functions, state variables, events, and mechanics
that don't exist in the contract. Rewrote to accurately reflect the code.

Key corrections:
- Remove non-existent functions (activateValidator, updateValidatorProxy,
  clearValidatorProxy, and all view functions)
- Remove non-existent state variables (POLICY_WRAPPER, proxyMap,
  validatorsBalanceMap, validatorsTotal)
- Add missing targetBlockNumber parameter to flashExecutionBid signature
- Fix event signatures (RelayFeeCollected uses uint64 validatorId, not
  address proxy; add missing RelayBidFailed event)
- Fix auction type docs: top-of-block uses [bytes32(0)], not empty array
- Remove fabricated gas-adjusted bidding and EOA-only restriction
- Add repo structure, build/test/deploy instructions, and dependencies
@jj1980a
jj1980a merged commit 99f5ca7 into main Apr 16, 2026
2 checks passed
@jj1980a
jj1980a deleted the fix-readme-accuracy branch April 16, 2026 06:13
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