diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..535a29f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,97 @@ +# Contributing to Morph Reth + +Thanks for your interest in contributing to Morph Reth! This document provides guidelines and information for contributors. + +## Getting Started + +1. Fork the repository on GitHub +2. Clone your fork locally: + ```bash + git clone https://github.com//morph-reth.git + cd morph-reth + ``` +3. Add the upstream remote: + ```bash + git remote add upstream https://github.com/morph-l2/morph-reth.git + ``` +4. Create a new branch for your work: + ```bash + git checkout -b feat/my-feature + ``` + +## Development Environment + +### Prerequisites + +- Rust 1.88 or later +- Cargo + +### Build + +```bash +cargo build --release +``` + +### Running Tests + +```bash +# Run all tests +cargo test --all + +# Run tests for a specific crate +cargo test -p morph-consensus +``` + +### Code Quality + +Before submitting a pull request, ensure all checks pass: + +```bash +# Format code (requires nightly toolchain) +cargo +nightly fmt --all + +# Run clippy lints +cargo clippy --all --all-targets -- -D warnings + +# Build documentation +cargo doc --no-deps --document-private-items +``` + +## Pull Request Process + +1. Ensure your branch is up to date with `main`: + ```bash + git fetch upstream + git rebase upstream/main + ``` +2. Write clear, concise commit messages following [Conventional Commits](https://www.conventionalcommits.org/): + - `feat:` for new features + - `fix:` for bug fixes + - `refactor:` for code refactoring + - `docs:` for documentation changes + - `test:` for adding or updating tests + - `chore:` for maintenance tasks +3. Include tests for new functionality +4. Update documentation if your changes affect public APIs +5. Open a pull request against `main` with a clear description of the changes + +## Project Structure + +See [README.md](README.md#architecture) for an overview of the crate structure. + +## Code Style + +- Follow standard Rust conventions and idioms +- Use `cargo fmt` formatting (nightly) +- All public items should have documentation comments +- Avoid `unsafe` code unless absolutely necessary and well-documented + +## Reporting Issues + +- Use [GitHub Issues](https://github.com/morph-l2/morph-reth/issues) to report bugs or request features +- Include steps to reproduce for bug reports +- Provide relevant logs, error messages, and environment details + +## License + +By contributing to Morph Reth, you agree that your contributions will be licensed under the [MIT License](LICENSE-MIT) or [Apache License 2.0](LICENSE-APACHE), at your option. diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..3fece7b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,190 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to the Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by the Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding any notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +Copyright 2024-2026 Morph Contributors + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..0cc3b58 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2024-2026 Morph Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 8864fcd..c07ea04 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # Morph Reth +[![Build](https://github.com/morph-l2/morph-reth/actions/workflows/build.yml/badge.svg)](https://github.com/morph-l2/morph-reth/actions/workflows/build.yml) +[![Test](https://github.com/morph-l2/morph-reth/actions/workflows/test.yml/badge.svg)](https://github.com/morph-l2/morph-reth/actions/workflows/test.yml) +[![Lint](https://github.com/morph-l2/morph-reth/actions/workflows/lint.yml/badge.svg)](https://github.com/morph-l2/morph-reth/actions/workflows/lint.yml) +[![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue)](#license) + ## Overview Morph Reth is the next-generation execution client for [Morph](https://www.morph.network/), a decentralized Layer 2 scaling solution for Ethereum. Built on the modular [Reth SDK](https://github.com/paradigmxyz/reth), it provides high-performance block execution with Morph-specific features. @@ -8,42 +13,62 @@ Morph Reth is the next-generation execution client for [Morph](https://www.morph - **L1 Message Support**: Seamless bridging of assets and messages from Ethereum L1 to Morph L2 - **Morph Transaction**: Morph EVM+ transaction enabling alternative token fees, reference key indexing, and memo attachment -- **Morph Hardforks**: Full support for Morph's upgrade schedule (Bernoulli, Curie, Morph203, Viridian, Emerald) +- **Morph Hardforks**: Full support for Morph's upgrade schedule (Bernoulli, Curie, Morph203, Viridian, Emerald, Jade) +- **Custom Engine API**: L2-specific Engine API for sequencer block building and validation +- **L1 Fee Validation**: Transaction pool with L1 data fee affordability checks + +### Supported Networks + +| Network | Chain ID | Type | +|---------|----------|------| +| Morph Mainnet | 2818 | Production | +| Morph Hoodi | 2910 | Testnet | ## Architecture Morph Reth is designed as a modular extension of Reth, following the SDK pattern: -``` +```text morph-reth/ -├── crates/ -│ ├── chainspec/ # Morph chain specification and hardfork definitions -│ ├── consensus/ # L2 block validation (header, body, L1 messages) -│ ├── evm/ # EVM configuration and block execution -│ ├── payload/ -│ │ ├── builder/ # Block building logic -│ │ └── types/ # Engine API types (ExecutableL2Data, etc.) -│ ├── primitives/ # Core types (transactions, receipts) -│ └── revm/ # L1 fee calculation, token fee logic +├── bin/ +│ └── morph-reth/ # Main CLI binary +└── crates/ + ├── chainspec/ # Morph chain specification and hardfork definitions + ├── consensus/ # L2 block validation (header, body, L1 messages) + ├── engine-api/ # Custom L2 Engine API (assemble/validate/import blocks) + ├── evm/ # EVM configuration and block execution + ├── node/ # Node assembly with component builders + ├── payload/ + │ ├── builder/ # Block building logic + │ └── types/ # Engine API types (MorphExecutionData, etc.) + ├── primitives/ # Core types (transactions, receipts) + ├── revm/ # L1 fee calculation, token fee logic + ├── rpc/ # RPC implementation and type conversions + └── txpool/ # Transaction pool with L1 fee validation ``` ### Crates | Crate | Description | |-------|-------------| -| `morph-chainspec` | Chain specification with Morph hardfork timestamps | +| `morph-reth` | Main CLI binary — Morph L2 Execution Layer Client | +| `morph-chainspec` | Chain specification with Morph hardfork definitions | | `morph-consensus` | Consensus validation for L2 blocks | +| `morph-engine-api` | Custom L2 Engine API for sequencer interaction | | `morph-evm` | EVM configuration and receipt builder | +| `morph-node` | Node implementation with modular component builders | | `morph-payload-types` | Engine API payload types | | `morph-payload-builder` | Block building implementation | | `morph-primitives` | Transaction and receipt types | | `morph-revm` | L1 fee and token fee calculations | +| `morph-rpc` | RPC implementation and type conversions | +| `morph-txpool` | Transaction pool with L1 fee and MorphTx validation | ## Getting Started ### Prerequisites -- Rust 1.82.0 or later +- Rust 1.88 or later - Cargo ### Building from Source @@ -54,6 +79,43 @@ cd morph-reth cargo build --release ``` +### Running the Node + +Morph Reth is a sequencer-driven L2 execution client. It does **not** sync blocks via P2P — blocks are delivered through the custom L2 Engine API by an external sequencer or derivation pipeline. + +```bash +# Generate a JWT secret for Engine API authentication +openssl rand -hex 32 > jwt.hex + +# Run on Morph mainnet +./target/release/morph-reth node \ + --chain mainnet \ + --http \ + --authrpc.jwtsecret jwt.hex + +# Run on Hoodi testnet +./target/release/morph-reth node \ + --chain hoodi \ + --http \ + --authrpc.jwtsecret jwt.hex + +# Run with a custom genesis file +./target/release/morph-reth node \ + --chain /path/to/genesis.json \ + --http \ + --authrpc.jwtsecret jwt.hex +``` + +> **Note:** The node requires a sequencer or derivation pipeline to call the Engine API (`engine_assembleL2Block`, `engine_newL2Block`, etc.) for block production and import. See [Morph Documentation](https://docs.morph.network/) for full deployment guides. + +#### Morph-Specific CLI Flags + +| Flag | Default | Description | +|------|---------|-------------| +| `--morph.max-tx-payload-bytes` | 122880 (120KB) | Maximum transaction payload bytes per block | +| `--morph.max-tx-per-block` | None (unlimited) | Maximum number of transactions per block | +| `--morph.geth-rpc-url` | None | Geth RPC URL for cross-validating MPT state root via `morph_diskRoot` | + ### Running Tests ```bash @@ -88,7 +150,7 @@ Morph supports the following transaction types: | Legacy | `0x00` | Standard legacy transactions | | EIP-2930 | `0x01` | Access list transactions | | EIP-1559 | `0x02` | Dynamic fee transactions | -| EIP-7702 | `0x04` | Account abstraction transactions | +| EIP-7702 | `0x04` | Delegate EOA execution to smart contract code | | L1 Message | `0x7e` | L1-to-L2 deposit messages | | Morph Transaction | `0x7f` | Morph EVM+ transaction with enhanced features | @@ -113,21 +175,40 @@ Morph Transaction (`0x7f`) is Morph's EVM+ transaction type, extending standard ### Hardforks -| Hardfork | Description | -|----------|-------------| -| Bernoulli | Initial L2 launch | -| Curie | EIP-1559 fee market activation | -| Morph203 | Various improvements | -| Viridian | Fee vault and alt fee support | -| Emerald | Block time 300ms | - -### Development Setup - -1. Fork and clone the repository -2. Create a new branch for your feature -3. Make your changes with tests -4. Ensure all checks pass: `cargo fmt`, `cargo clippy`, `cargo test` -5. Submit a pull request +Bernoulli and Curie use block-based activation; Morph203, Viridian, Emerald, and Jade use timestamp-based activation. + +| Hardfork | Activation | Description | +|----------|------------|-------------| +| Bernoulli | Block | Initial L2 launch with disabled ripemd160 and blake2f precompiles | +| Curie | Block | EIP-1559 fee market activation with blob-based L1 data fee | +| Morph203 | Timestamp | Re-enable ripemd160 and blake2f precompiles | +| Viridian | Timestamp | EIP-7702 EOA delegation support | +| Emerald | Timestamp | BLS12-381 and P256verify precompiles | +| Jade | Timestamp | MPT state root validation, MorphTx V1 with reference and memo fields | + +### Engine API + +Morph provides a custom L2 Engine API (different from the standard Ethereum Engine API) for sequencer interaction: + +| Method | Description | +|--------|-------------| +| `engine_assembleL2Block` | Build a new block with given transactions | +| `engine_validateL2Block` | Validate a block without importing | +| `engine_newL2Block` | Import and finalize a block | +| `engine_newSafeL2Block` | Import a safe block from derivation | + +## Contributing + +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute. + +## License + +Licensed under either of: + +- [Apache License, Version 2.0](LICENSE-APACHE) +- [MIT License](LICENSE-MIT) + +at your option. ## Links