URC and whitelst functionalities sharing the same common code base (#577)

* new registration module

Signed-off-by: Maciej Skrzypkowski <mskr@gmx.com>

* registry ABI

* adding registry abi wip

* Two separate binaries for whitelist and URC

* removed unneeded

* desugar async trait function to add Send trait to return value

* Introduced 3 separate crate catalyst-common, catalyst-urc, catalyst-whitelist

* inner execution layer field

* chain_id example cont.

* specific config for Extension Trait

* get logs compiles

* Getting logs improvements

* removed catalyst from crates names

* moved node module to the whitelist crate

* tests work

* sort dependencies

* Set publish to false in Cargo.toml

* Update Cargo.toml files to use workspace for common dependency

Signed-off-by: Maciej Skrzypkowski <mskr@gmx.com>

* fmt

* Add Default implementation for Metrics struct

* Refactor test_gas module: Move test_gas from common to whitelist crate and implement test_gas_params function for transaction handling.

Signed-off-by: Maciej Skrzypkowski <mskr@gmx.com>

* Update Cargo.lock to remove catalyst_node package and bump versions for common, urc, and whitelist packages to 1.6.0. Refactor slot_clock initialization in operator.rs for improved clarity.

* v1.7.0

* Refactor project structure: Rename 'urc' to 'permissionless' and 'whitelist' to 'catalyst_whitelist'. Update Dockerfile and Cargo files accordingly. Add 'permissionless' package to Cargo.lock.

* renamed directories

Signed-off-by: Maciej Skrzypkowski <mskr@gmx.com>

* .env.sample

* Update log message to reflect the correct node name: changed from 'URC Node' to 'Permissionless Node'.

---------

Signed-off-by: Maciej Skrzypkowski <mskr@gmx.com>

Author: mskrzypkows

node/.env.sample .env.samplenode/.env.sample renamed to .env.sample

@@ -10,5 +10,4 @@ TAIKO_DRIVER_URL=http://127.0.0.1:1235
 L1_RPC_URLS=ws://127.0.0.1:32003,wss://123.123.123.123:32001
 L1_BEACON_URL=http://127.0.0.1:33001
 RUST_LOG=debug,reqwest=info,hyper=info,alloy_transport=info,alloy_rpc_client=info,alloy_provider=info
-JWT_SECRET_FILE_PATH=/some/path/jwtsecret.hex
-
+JWT_SECRET_FILE_PATH=/some/path/jwtsecret.hex

Cargo.lock

@@ -1,16 +1,18 @@
 
 [workspace]
 members = [
-    "node",
+    "common",
+    "permissionless",
     "tools/p2p_node/p2p_boot_node",
     "tools/p2p_node/p2p_network",
     "tools/p2p_node/p2p_test_node",
+    "whitelist",
 ]
 resolver = "2"
-default-members = ["node"]
+default-members = ["whitelist"]
 
 [workspace.package]
-version = "1.6.0"
+version = "1.7.0"
 edition = "2024"
 repository = "https://github.com/NethermindEth/Catalyst"
 license = "MIT"
@@ -42,6 +44,7 @@ clap = { version = "4.5", default-features = false, features = [
     "suggestions",
     "derive",
 ] }
+common = { path = "common" }
 discv5 = { version = "0.9.1", default-features = false, features = ["libp2p"] }
 dotenvy = { version = "0.15", default-features = false }
 ecdsa = { version = "0.16", default-features = false }

Cargo.toml

@@ -8,7 +8,7 @@ RUN apt-get update && apt-get install -y \
     && rm -rf /var/lib/apt/lists/*
 
 # Set the working directory inside the container
-WORKDIR /app/catalyst_node
+WORKDIR /app/catalyst_whitelist
 
 # Copy only the toolchain file first
 COPY rust-toolchain.toml .
@@ -19,19 +19,19 @@ RUN rustup show
 # Now copy the rest of the files
 COPY . .
 
-# Build catalyst_node
+# Build catalyst_whitelist
 RUN --mount=type=cache,target=/usr/local/cargo/registry \
     --mount=type=cache,target=/usr/local/cargo/git \
-    --mount=type=cache,target=/app/catalyst_node/target \
-    cargo build -p catalyst_node --release \
-    && mv /app/catalyst_node/target/release/catalyst_node /root
+    --mount=type=cache,target=/app/catalyst_whitelist/target \
+    cargo build -p whitelist --release \
+    && mv /app/catalyst_whitelist/target/release/catalyst_whitelist /root
 
 # Use small size system for final image
 FROM gcr.io/distroless/cc
 
 # Copy artifacts
-COPY --from=builder /root/catalyst_node /usr/local/bin/catalyst_node
+COPY --from=builder /root/catalyst_whitelist /usr/local/bin/catalyst_whitelist
 COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/
 COPY --from=builder /bin/sleep /bin/sleep
 
-ENTRYPOINT ["catalyst_node"]
+ENTRYPOINT ["catalyst_whitelist"]

Dockerfile

@@ -1,5 +1,5 @@
 [files]
 extend-exclude = [
-    "node/src/ethereum_l1/abi/*.json", 
-    "node/src/taiko/abi/*.json"
+    "node/src/l1/abi/*.json",
+    "node/src/l2/abi/*.json"
 ]

_typos.toml

@@ -1,18 +1,13 @@
 [package]
-name = "catalyst_node"
+name = "common"
 version.workspace = true
 edition.workspace = true
 repository.workspace = true
 license.workspace = true
+publish = false
 
 [features]
-# A testing feature that allows the node to send only
-# a proposeBatch transaction and then stop.
-# Useful for validating transaction sending logic
-# without running the full flow
-test-gas = ["clap"]
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+test-gas = []
 
 [dependencies]
 alloy = { workspace = true }
@@ -22,7 +17,6 @@ anyhow = { workspace = true }
 async-trait = { workspace = true }
 c-kzg = { workspace = true }
 chrono = { workspace = true }
-clap = { workspace = true, optional = true }
 dotenvy = { workspace = true }
 ecdsa = { workspace = true }
 elliptic-curve = { workspace = true }

node/Cargo.toml common/Cargo.tomlnode/Cargo.toml renamed to common/Cargo.toml

@@ -3,11 +3,12 @@ use std::{sync::Arc, time::Duration};
 use alloy::{eips::eip4844::kzg_to_versioned_hash, primitives::B256, rpc::types::Transaction};
 use anyhow::Error;
 
+use super::blob_decoder::BlobDecoder;
+use crate::l1::{ethereum_l1::EthereumL1, extension::ELExtension};
 use crate::shared::l2_tx_lists::uncompress_and_decode;
-use crate::{ethereum_l1::EthereumL1, utils::blob::decode_blob};
 
-pub async fn extract_transactions_from_blob(
-    ethereum_l1: Arc<EthereumL1>,
+pub async fn extract_transactions_from_blob<T: ELExtension>(
+    ethereum_l1: Arc<EthereumL1<T>>,
     block: u64,
     blob_hash: Vec<B256>,
     tx_list_offset: u32,
@@ -27,8 +28,8 @@ pub async fn extract_transactions_from_blob(
     Ok(txs)
 }
 
-async fn blob_to_vec(
-    ethereum_l1: Arc<EthereumL1>,
+async fn blob_to_vec<T: ELExtension>(
+    ethereum_l1: Arc<EthereumL1<T>>,
     block: u64,
     blob_hash: Vec<B256>,
     tx_list_offset: u32,
@@ -54,7 +55,7 @@ async fn blob_to_vec(
     for hash in blob_hash {
         for (i, sidecar) in sidecars.data.iter().enumerate() {
             if sidecar_hashes[i] == hash {
-                let data = decode_blob(sidecar.blob.as_ref())?;
+                let data = BlobDecoder::decode_blob(sidecar.blob.as_ref())?;
                 result.extend(data);
                 break;
             }
@@ -80,12 +81,11 @@ async fn blob_to_vec(
 
 #[cfg(test)]
 mod tests {
-    use super::*;
     use crate::{
+        blob::{BlobDecoder, build_blob_sidecar},
         shared::l2_tx_lists::{
             decompose_pending_lists_json_from_geth, encode_and_compress, uncompress_and_decode,
         },
-        utils::blob::build_blob_sidecar,
     };
 
     #[test]
@@ -97,7 +97,7 @@ mod tests {
         let compress = encode_and_compress(&txs).unwrap();
         let blob = build_blob_sidecar(&compress).unwrap();
         assert_eq!(blob.blobs.len(), 1);
-        let blob_data = decode_blob(&blob.blobs[0]).unwrap();
+        let blob_data = BlobDecoder::decode_blob(&blob.blobs[0]).unwrap();
         assert_eq!(blob_data, compress);
         let decoded_txs = uncompress_and_decode(&blob_data).unwrap();
         assert_eq!(decoded_txs, txs);