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

Refactor project structure to accommodate tests, and better management #29

Open
SkandaBhat opened this issue Nov 5, 2024 · 3 comments

Comments

@SkandaBhat
Copy link
Contributor

SkandaBhat commented Nov 5, 2024

The project can be refactored using crate to better manage features and to setup end to end tests to validate spec.

Current project structure:

src/chainspec.rs
src/evmconfig.rs
src/execute.rs
src/node.rs
...

Proposed structure:

bin/
crates/
crates/e2etests/
crates/node/
crates/evm/
...

Inspiration: https://github.com/ithacaxyz/odyssey

op reth also has a very similar structure: https://github.com/paradigmxyz/reth/tree/main/crates/optimism

@dapplion
Copy link
Member

dapplion commented Nov 8, 2024

Why not, I wasn't worrying too much about the organization since the project is pretty early. @debjit-bw thoughts?

@SkandaBhat
Copy link
Contributor Author

SkandaBhat commented Nov 9, 2024

Biggest reason I would advocate for this is that spec tests will get easier to setup, and the effort to do this is quite low. I can create a draft and see if it makes sense

@debjit-bw
Copy link
Member

Individual features like payload builder or evm are too small to make their independent crates, I feel. We can have one crate with whole reth_gnosis, and one for testing maybe.

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

No branches or pull requests

3 participants