feat: release taiko reth v1.0.0

Cargo.toml

@@ -64,7 +64,9 @@ members = [
     "crates/optimism/primitives/",
     "crates/payload/basic/",
     "crates/payload/builder/",
-    "crates/payload/primitives/",
+    "crates/payload/primitives",
+    "crates/ethereum/payload",
+    "crates/optimism/payload",
     "crates/payload/validator/",
     "crates/primitives/",
     "crates/primitives-traits/",
@@ -125,6 +127,16 @@ members = [
     "examples/txpool-tracing/",
     "testing/ef-tests/",
     "testing/testing-utils",
+    # Taiko additional crates
+    "crates/taiko/consensus/consensus",
+    "crates/taiko/consensus/proposer",
+    "crates/taiko/engine-primitives/",
+    "crates/taiko/evm",
+    "crates/taiko/node",
+    "crates/taiko/payload/builder",
+    "crates/taiko/payload/validator",
+    "crates/taiko/primitives/",
+    "crates/taiko/storage/",
 ]
 default-members = ["bin/reth"]
 
@@ -342,6 +354,16 @@ reth-trie = { path = "crates/trie/trie" }
 reth-trie-common = { path = "crates/trie/common" }
 reth-trie-parallel = { path = "crates/trie/parallel" }
 
+taiko-reth-beacon-consensus = { path = "crates/taiko/consensus/consensus" }
+taiko-reth-proposer-consensus = { path = "crates/taiko/consensus/proposer" }
+taiko-reth-primitives = { path = "crates/taiko/primitives" }
+taiko-reth-provider = { path = "crates/taiko/storage" }
+taiko-reth-evm = { path = "crates/taiko/evm" }
+taiko-reth-payload-builder = { path = "crates/taiko/payload/builder" }
+taiko-reth-payload-validator = { path = "crates/taiko/payload/validator" }
+taiko-reth-engine-primitives = { path = "crates/taiko/engine-primitives" }
+taiko-reth-node = { path = "crates/taiko/node" }
+
 # revm
 revm = { version = "10.0.0", features = [
     "std",
@@ -409,7 +431,7 @@ thiserror = "1.0"
 thiserror-no-std = { version = "2.0.2", default-features = false }
 serde_json = "1.0.94"
 serde = { version = "1.0", default-features = false }
-serde_with = "3.3.0"
+serde_with = { version = "3.3.0", features = ["base64"] }
 humantime = "2.1"
 humantime-serde = "1.1"
 rand = "0.8.5"
@@ -429,6 +451,8 @@ sha2 = { version = "0.10", default-features = false }
 paste = "1.0"
 url = "2.3"
 backon = "0.4"
+anyhow = "1.0.86"
+lazy_static = "1.5.0"
 
 # metrics
 metrics = "0.23.0"
@@ -480,6 +504,7 @@ secp256k1 = { version = "0.29", default-features = false, features = [
     "recovery",
 ] }
 enr = { version = "0.12.1", default-features = false }
+flate2 = "1.0"
 
 # for eip-4844
 c-kzg = "1.0.0"
@@ -500,3 +525,15 @@ serial_test = "3"
 similar-asserts = "1.5.0"
 test-fuzz = "5"
 iai-callgrind = "0.11"
+
+
+[patch.crates-io]
+revm = { git = "https://github.com/taikoxyz/revm.git", branch = "v37-taiko" }
+revm-interpreter = { git = "https://github.com/taikoxyz/revm.git", branch = "v37-taiko" }
+revm-precompile = { git = "https://github.com/taikoxyz/revm.git", branch = "v37-taiko" }
+revm-primitives = { git = "https://github.com/taikoxyz/revm.git", branch = "v37-taiko" }
+c-kzg = { git = "https://github.com/brechtpd/c-kzg-4844", branch = "for-alpha7" }
+secp256k1 = { git = "https://github.com/CeciliaZ030/rust-secp256k1", branch = "sp1-patch" }
+
+[patch.'https://github.com/bluealloy/revm.git']
+revm = { git = "https://github.com/taikoxyz/revm.git", branch = "v37-taiko" }

DockerfileTaiko.cross

@@ -0,0 +1,15 @@
+# This image is meant to enable cross-architecture builds.
+# It assumes the reth binary has already been compiled for `$TARGETPLATFORM` and is
+# locatable in `./dist/bin/$TARGETARCH`
+FROM --platform=$TARGETPLATFORM ubuntu:22.04
+
+LABEL org.opencontainers.image.source=https://github.com/taikoxyz/taiko-reth
+LABEL org.opencontainers.image.licenses="MIT OR Apache-2.0"
+
+# Filled by docker buildx
+ARG TARGETARCH
+
+COPY ./dist/bin/$TARGETARCH/taiko-reth /usr/local/bin/taiko-reth
+
+EXPOSE 30303 30303/udp 9001 8545 8546
+ENTRYPOINT ["/usr/local/bin/taiko-reth"]

Makefile

@@ -31,6 +31,7 @@ EF_TESTS_DIR := ./testing/ef-tests/ethereum-tests
 
 # The docker image name
 DOCKER_IMAGE_NAME ?= ghcr.io/paradigmxyz/reth
+TAIKO_DOCKER_IMAGE_NAME ?= us-docker.pkg.dev/evmchain/images/taiko-reth
 
 # Features in reth/op-reth binary crate other than "ethereum" and "optimism"
 BIN_OTHER_FEATURES := asm-keccak jemalloc jemalloc-prof min-error-logs min-warn-logs min-info-logs min-debug-logs min-trace-logs
@@ -57,6 +58,14 @@ install-op: ## Build and install the op-reth binary under `~/.cargo/bin`.
 		--profile "$(PROFILE)" \
 		$(CARGO_INSTALL_EXTRA_FLAGS)
 
+
+.PHONY: install-taiko
+install-taiko: ## Build and install the op-reth binary under `~/.cargo/bin`.
+	cargo install --path bin/reth --bin taiko-reth --force --locked \
+		--features "taiko,$(FEATURES)" \
+		--profile "$(PROFILE)" \
+		$(CARGO_INSTALL_EXTRA_FLAGS)
+
 .PHONY: build
 build: ## Build the reth binary into `target` directory.
 	cargo build --bin reth --features "$(FEATURES)" --profile "$(PROFILE)"
@@ -65,13 +74,20 @@ build: ## Build the reth binary into `target` directory.
 build-op: ## Build the op-reth binary into `target` directory.
 	cargo build --bin op-reth --features "optimism,$(FEATURES)" --profile "$(PROFILE)"
 
+.PHONY: build-taiko
+build-taiko: ## Build the op-reth binary into `target` directory.
+	cargo build --bin taiko-reth --features "taiko,$(FEATURES)" --profile "$(PROFILE)"
+
 # Builds the reth binary natively.
 build-native-%:
 	cargo build --bin reth --target $* --features "$(FEATURES)" --profile "$(PROFILE)"
 
 op-build-native-%:
 	cargo build --bin op-reth --target $* --features "optimism,$(FEATURES)" --profile "$(PROFILE)"
 
+taiko-build-native-%:
+	cargo build --bin op-reth --target $* --features "taiko,$(FEATURES)" --profile "$(PROFILE)"
+
 # The following commands use `cross` to build a cross-compile.
 #
 # These commands require that:
@@ -93,9 +109,13 @@ build-aarch64-unknown-linux-gnu: export JEMALLOC_SYS_WITH_LG_PAGE=16
 op-build-aarch64-unknown-linux-gnu: FEATURES := $(filter-out asm-keccak,$(FEATURES))
 op-build-aarch64-unknown-linux-gnu: export JEMALLOC_SYS_WITH_LG_PAGE=16
 
+taiko-build-aarch64-unknown-linux-gnu: FEATURES := $(filter-out asm-keccak,$(FEATURES))
+taiko-build-aarch64-unknown-linux-gnu: export JEMALLOC_SYS_WITH_LG_PAGE=16
+
 # No jemalloc on Windows
 build-x86_64-pc-windows-gnu: FEATURES := $(filter-out jemalloc jemalloc-prof,$(FEATURES))
 op-build-x86_64-pc-windows-gnu: FEATURES := $(filter-out jemalloc jemalloc-prof,$(FEATURES))
+taiko-build-x86_64-pc-windows-gnu: FEATURES := $(filter-out jemalloc jemalloc-prof,$(FEATURES))
 
 # Note: The additional rustc compiler flags are for intrinsics needed by MDBX.
 # See: https://github.com/cross-rs/cross/wiki/FAQ#undefined-reference-with-build-std
@@ -107,6 +127,10 @@ op-build-%:
 	RUSTFLAGS="-C link-arg=-lgcc -Clink-arg=-static-libgcc" \
 		cross build --bin op-reth --target $* --features "optimism,$(FEATURES)" --profile "$(PROFILE)"
 
+taiko-build-%:
+	RUSTFLAGS="-C link-arg=-lgcc -Clink-arg=-static-libgcc" \
+		cross build --bin taiko-reth --target $* --features "taiko,$(FEATURES)" --profile "$(PROFILE)"
+
 # Unfortunately we can't easily use cross to build for Darwin because of licensing issues.
 # If we wanted to, we would need to build a custom Docker image with the SDK available.
 #
@@ -122,6 +146,11 @@ op-build-x86_64-apple-darwin:
 op-build-aarch64-apple-darwin:
 	$(MAKE) op-build-native-aarch64-apple-darwin
 
+taiko-build-x86_64-apple-darwin:
+	$(MAKE) taiko-build-native-x86_64-apple-darwin
+taiko-build-aarch64-apple-darwin:
+	$(MAKE) taiko-build-native-aarch64-apple-darwin
+
 # Create a `.tar.gz` containing a binary for a specific target.
 define tarball_release_binary
 	cp $(BUILD_PATH)/$(1)/$(PROFILE)/$(2) $(BIN_DIR)/$(2)
@@ -278,6 +307,53 @@ endef
 
 ##@ Other
 
+
+##@ Taiko docker
+
+# Note: This requires a buildx builder with emulation support. For example:
+#
+# `docker run --privileged --rm tonistiigi/binfmt --install amd64,arm64`
+# `docker buildx create --use --driver docker-container --name cross-builder`
+.PHONY: taiko-docker-build-push
+taiko-docker-build-push: ## Build and push a cross-arch Docker image tagged with the latest git tag.
+	$(call taiko_docker_build_push,$(GIT_TAG),$(GIT_TAG))
+
+# Note: This requires a buildx builder with emulation support. For example:
+#
+# `docker run --privileged --rm tonistiigi/binfmt --install amd64,arm64`
+# `docker buildx create --use --driver docker-container --name cross-builder`
+.PHONY: taiko-docker-build-push-latest
+taiko-docker-build-push-latest: ## Build and push a cross-arch Docker image tagged with the latest git tag and `latest`.
+	$(call taiko_docker_build_push,$(GIT_TAG),latest)
+
+# Note: This requires a buildx builder with emulation support. For example:
+#
+# `docker run --privileged --rm tonistiigi/binfmt --install amd64,arm64`
+# `docker buildx create --use --name cross-builder`
+.PHONY: taiko-docker-build-push-nightly
+taiko-docker-build-push-nightly: ## Build and push cross-arch Docker image tagged with the latest git tag with a `-nightly` suffix, and `latest-nightly`.
+	$(call taiko_docker_build_push,$(GIT_TAG)-nightly,latest-nightly)
+
+# Create a cross-arch Docker image with the given tags and push it
+define taiko_docker_build_push
+	$(MAKE) taiko-build-x86_64-unknown-linux-gnu
+	mkdir -p $(BIN_DIR)/amd64
+	cp $(BUILD_PATH)/x86_64-unknown-linux-gnu/$(PROFILE)/taiko-reth $(BIN_DIR)/amd64/taiko-reth
+
+	$(MAKE) taiko-build-aarch64-unknown-linux-gnu
+	mkdir -p $(BIN_DIR)/arm64
+	cp $(BUILD_PATH)/aarch64-unknown-linux-gnu/$(PROFILE)/taiko-reth $(BIN_DIR)/arm64/taiko-reth
+
+	docker buildx build --file ./DockerfileTaiko.cross . \
+		--platform linux/amd64,linux/arm64 \
+		--tag $(TAIKO_DOCKER_IMAGE_NAME):$(1) \
+		--tag $(TAIKO_DOCKER_IMAGE_NAME):$(2) \
+		--provenance=false \
+		--push
+endef
+
+##@ Other
+
 .PHONY: clean
 clean: ## Perform a `cargo` clean and remove the binary and test vectors directories.
 	cargo clean
@@ -345,6 +421,18 @@ lint-op-reth:
 	--features "optimism $(BIN_OTHER_FEATURES)" \
 	-- -D warnings
 
+
+lint-taiko-reth:
+	cargo +nightly clippy \
+	--workspace \
+	--bin "taiko-reth" \
+	--lib \
+	--examples \
+	--tests \
+	--benches \
+	--features "taiko $(BIN_OTHER_FEATURES)" \
+	-- -D warnings
+
 lint-other-targets:
 	cargo +nightly clippy \
 	--workspace \
@@ -368,6 +456,7 @@ lint:
 	make fmt && \
 	make lint-reth && \
 	make lint-op-reth && \
+	make lint-taiko-reth && \
 	make lint-other-targets && \
 	make lint-codespell
 
@@ -399,6 +488,21 @@ fix-lint-op-reth:
 	--allow-dirty \
 	-- -D warnings
 
+
+fix-lint-taiko-reth:
+	cargo +nightly clippy \
+	--workspace \
+	--bin "taiko-reth" \
+	--lib \
+	--examples \
+	--tests \
+	--benches \
+	--features "taiko $(BIN_OTHER_FEATURES)" \
+	--fix \
+	--allow-staged \
+	--allow-dirty \
+	-- -D warnings
+
 fix-lint-other-targets:
 	cargo +nightly clippy \
 	--workspace \
@@ -415,6 +519,7 @@ fix-lint-other-targets:
 fix-lint:
 	make fix-lint-reth && \
 	make fix-lint-op-reth && \
+	make fix-lint-taiko-reth && \
 	make fix-lint-other-targets && \
 	make fmt
 
@@ -447,6 +552,15 @@ test-op-reth:
 	--benches \
 	--features "optimism $(BIN_OTHER_FEATURES)"
 
+test-taiko-reth:
+	cargo test \
+	--workspace \
+	--bin "taiko-reth" \
+	--lib --examples \
+	--tests \
+	--benches \
+	--features "taiko $(BIN_OTHER_FEATURES)"
+
 test-other-targets:
 	cargo test \
 	--workspace \
@@ -463,6 +577,7 @@ test-doc:
 test:
 	make test-reth && \
 	make test-op-reth && \
+	make test-taiko-reth && \
 	make test-doc && \
 	make test-other-targets
 

bin/reth/Cargo.toml

@@ -68,8 +68,16 @@ reth-consensus.workspace = true
 reth-optimism-primitives.workspace = true
 reth-prune-types.workspace = true
 
+# taiko
+taiko-reth-payload-builder = { workspace = true, optional = true }
+taiko-reth-payload-validator = { workspace = true, optional = true }
+taiko-reth-node = { workspace = true, optional = true }
+
 # crypto
 alloy-rlp.workspace = true
+rlp = "0.5"
+alloy-chains.workspace = true
+secp256k1.workspace = true
 
 # tracing
 tracing.workspace = true
@@ -113,6 +121,7 @@ eyre.workspace = true
 clap = { workspace = true, features = ["derive", "env"] }
 tempfile.workspace = true
 backon.workspace = true
+thiserror.workspace = true
 similar-asserts.workspace = true
 itertools.workspace = true
 rayon.workspace = true
@@ -154,6 +163,15 @@ optimism = [
     "reth-node-core/optimism",
 ]
 
+taiko = [
+    "dep:taiko-reth-payload-validator",
+    "reth-primitives/taiko",
+    "reth-revm/taiko",
+    "reth-node-builder/taiko",
+    "dep:taiko-reth-node",
+    "reth-blockchain-tree/taiko",
+]
+
 # no-op feature flag for switching between the `optimism` and default functionality in CI matrices
 ethereum = []
 
@@ -165,3 +183,8 @@ path = "src/main.rs"
 name = "op-reth"
 path = "src/optimism.rs"
 required-features = ["optimism"]
+
+[[bin]]
+name = "taiko-reth"
+path = "src/taiko.rs"
+required-features = ["taiko"]

bin/reth/src/cli/mod.rs

@@ -160,6 +160,7 @@ impl<Ext: clap::Args + fmt::Debug> Cli<Ext> {
             Commands::Db(command) => runner.run_blocking_until_ctrl_c(command.execute()),
             Commands::Stage(command) => runner.run_command_until_exit(|ctx| command.execute(ctx)),
             Commands::P2P(command) => runner.run_until_ctrl_c(command.execute()),
+            // Commands::T8n(command) => runner.run_until_ctrl_c(command.execute()),
             Commands::TestVectors(command) => runner.run_until_ctrl_c(command.execute()),
             Commands::Config(command) => runner.run_until_ctrl_c(command.execute()),
             Commands::Debug(command) => runner.run_command_until_exit(|ctx| command.execute(ctx)),
@@ -211,6 +212,12 @@ pub enum Commands<Ext: clap::Args + fmt::Debug = NoArgs> {
     /// P2P Debugging utilities
     #[command(name = "p2p")]
     P2P(p2p::Command),
+    /// Runs an EVM state transition using the provided JSON pre-state files.
+    ///
+    /// Equivalent of Geth's `./evm t8n` utility, and should be used to confirm
+    /// equivalence of behavior between Geth and Reth executors.
+    // #[command(name = "t8n")]
+    // T8n(t8n::Command),
     /// Generate Test Vectors
     #[command(name = "test-vectors")]
     TestVectors(test_vectors::Command),