Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing docs to rollup-interface. Cleanup module structure. #483

Merged
merged 3 commits into from
Jul 10, 2023

Conversation

preston-evans98
Copy link
Member

@preston-evans98 preston-evans98 commented Jul 10, 2023

Description

  • Add missing docs to rollup-interface
  • Cleanup unneeded code instead of documenting it
    • Remove MerkleHasher trait
    • Remove CanonicalHash trait and instead add a hash method to BlockHeaderTrait
    • Remove the standalone traits module, and move its contents into either state_machine/mod.rs or the state_machine/da.rs files as appropriate.
    • Remove unnecessary nesting of modules; everywhere that there was a top-level module with no direct contents and exactly one child module, bring replace the parent with the child.

N.B. This PR makes no functional changes - only minor refactoring and docs improvements

Linked Issues

@codecov
Copy link

codecov bot commented Jul 10, 2023

@preston-evans98 preston-evans98 marked this pull request as ready for review July 10, 2023 11:52
@preston-evans98 preston-evans98 changed the title WIP: Add missing docs to rollup-interface Add missing docs to rollup-interface. Cleanup module structure. Jul 10, 2023
@preston-evans98 preston-evans98 merged commit 225113e into main Jul 10, 2023
9 checks passed
@preston-evans98 preston-evans98 deleted the preston/rollup-interface/docs branch July 10, 2023 15:43
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.

4 participants