feat(l2): add validium mode (#2365)

Validium is a [scaling
solution](https://ethereum.org/en/developers/docs/scaling/) that
enforces integrity of transactions using validity proofs like
[ZK-rollups](https://ethereum.org/en/developers/docs/scaling/zk-rollups/),
but doesn’t store transaction data on the Ethereum Mainnet.

**Description**
- Replace EIP 4844 transactions for EIP 1559
- Modify OnChainProposer contract so that it supports validium. It is
not the most efficient way of doing it but the simplest.
- Now the config.toml has a validium field.

Note: I'm not 100% sure about the changes that I made to the
OnChainProposer, there may be a mistake in the additions that I made. I
will review it though but I still consider worth opening this PR.


<!-- Link to issues: Resolves #111, Resolves #222 -->

Closes #2313

---------

Co-authored-by: ilitteri <[email protected]>
Co-authored-by: Ivan Litteri <[email protected]>

Author: JereSalo

.github/workflows/pr-main_l2.yaml

@@ -46,9 +46,15 @@ jobs:
           path: /tmp/buildx-cache
 
   integration-test:
-    # "Integration Test" is a required check, don't change the name
-    name: Integration Test
+    name: Integration Test - ${{ matrix.name }}
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        include:
+          - name: "Validium"
+            validium: true
+          - name: "Vanilla"
+            validium: false
     needs: [docker-bake]
     steps:
       - name: Checkout sources
@@ -95,7 +101,9 @@ jobs:
           cp configs/prover_client_config_example.toml configs/prover_client_config.toml
           cp configs/sequencer_config_example.toml configs/sequencer_config.toml
           sed -i 's/listen_ip = "127.0.0.1"/listen_ip = "0.0.0.0"/' configs/sequencer_config.toml
-
+          if [ "${{ matrix.validium }}" = "true" ]; then
+            sed -i.bak 's/^validium = false$/validium = true/' configs/sequencer_config.toml && rm configs/sequencer_config.toml.bak
+          fi
           make integration-test
 
   state-diff-test:
@@ -146,3 +154,24 @@ jobs:
           sed -i 's/listen_ip = "127.0.0.1"/listen_ip = "0.0.0.0"/' configs/sequencer_config.toml
 
           make state-diff-test
+
+  # The purpose of this job is to add it as a required check in GitHub so that we don't have to add every individual job as a required check
+  all-tests:
+    # "Integration Test" is a required check, don't change the name
+    name: Integration Test
+    runs-on: ubuntu-latest
+    needs: [integration-test, state-diff-test]
+    # Make sure this job runs even if the previous jobs failed or were skipped
+    if: ${{ always() && needs.integration-test.result != 'skipped' && needs.state-diff-test.result != 'skipped' }}
+    steps:
+      - name: Check if any job failed
+        run: |
+          if [ "${{ needs.integration-test.result }}" != "success" ]; then
+            echo "Job Integration Tests failed"
+            exit 1
+          fi
+
+          if [ "${{ needs.state-diff-test.result }}" != "success" ]; then
+            echo "Job State Reconstruction Tests failed"
+            exit 1
+          fi

crates/l2/Makefile

@@ -202,7 +202,7 @@ test: ## 🚧 Runs the L2's integration test, run `make init` and in a new termi
 
 integration-test: rm-db-l2 rm-db-l1
 	# We create an empty .env file simply because if the file
-	# does not exists, the container fails to write to it.
+	# does not exist, the container fails to write to it.
 	touch .env
 	CI_ETHREX_WORKDIR=${CI_ETHREX_WORKDIR} docker compose -f ${ethrex_L2_DOCKER_COMPOSE_PATH} down
 	CI_ETHREX_WORKDIR=${CI_ETHREX_WORKDIR} docker compose -f ${ethrex_L2_DOCKER_COMPOSE_PATH} up --detach --build

crates/l2/configs/sequencer_config_example.toml

@@ -39,6 +39,8 @@ on_chain_proposer_address = "0xea6d04861106c1fb69176d49eeb8de6dd14a9cfe"
 commit_time_ms = 5000
 # 1 Gwei
 arbitrary_base_blob_gas_price = 1000000000
+# If set to true, initializes the committer in validium mode
+validium = false
 
 [prover_server]
 # Address of a funded account that the sequencer will use to send verify txs to the L1.

crates/l2/contracts/deployer.rs

@@ -350,13 +350,14 @@ async fn deploy_contracts(
         Color::Cyan,
     );
 
-    let (on_chain_proposer_deployment_tx_hash, on_chain_proposer_address) = deploy_contract(
-        deployer,
-        deployer_private_key,
-        eth_client,
-        &contracts_path.join("solc_out/OnChainProposer.bin"),
-    )
-    .await?;
+    let (on_chain_proposer_deployment_tx_hash, on_chain_proposer_address) =
+        deploy_on_chain_proposer(
+            deployer,
+            deployer_private_key,
+            eth_client,
+            &contracts_path.join("solc_out/OnChainProposer.bin"),
+        )
+        .await?;
 
     let msg = format!(
         "OnChainProposer:\n\tDeployed at address {}\n\tWith tx hash {}",
@@ -438,12 +439,10 @@ async fn deploy_contract(
     contract_path: &Path,
 ) -> Result<(H256, Address), DeployError> {
     let init_code = hex::decode(std::fs::read_to_string(contract_path).map_err(|err| {
-        DeployError::DecodingError(format!("Failed to read on_chain_proposer_init_code: {err}"))
+        DeployError::DecodingError(format!("Failed to read contract init code: {err}"))
     })?)
     .map_err(|err| {
-        DeployError::DecodingError(format!(
-            "Failed to decode on_chain_proposer_init_code: {err}"
-        ))
+        DeployError::DecodingError(format!("Failed to decode contract init code: {err}"))
     })?
     .into();
 
@@ -455,6 +454,44 @@ async fn deploy_contract(
     Ok((deploy_tx_hash, contract_address))
 }
 
+async fn deploy_on_chain_proposer(
+    deployer: Address,
+    deployer_private_key: SecretKey,
+    eth_client: &EthClient,
+    contract_path: &Path,
+) -> Result<(H256, Address), DeployError> {
+    let mut init_code = hex::decode(std::fs::read_to_string(contract_path).map_err(|err| {
+        DeployError::DecodingError(format!("Failed to read on_chain_proposer_init_code: {err}"))
+    })?)
+    .map_err(|err| {
+        DeployError::DecodingError(format!(
+            "Failed to decode on_chain_proposer_init_code: {err}"
+        ))
+    })?;
+
+    let validium: bool = read_env_var("COMMITTER_VALIDIUM")?
+        .trim()
+        .parse()
+        .map_err(|err| DeployError::ParseError(format!("Malformed COMMITTER_VALIDIUM: {err}")))?;
+
+    let validium_value = if validium { 1u8 } else { 0u8 };
+    let encoded_validium = vec![0; 31]
+        .into_iter()
+        .chain(std::iter::once(validium_value));
+    init_code.extend(encoded_validium);
+
+    let (deploy_tx_hash, contract_address) = create2_deploy(
+        deployer,
+        deployer_private_key,
+        &init_code.into(),
+        eth_client,
+    )
+    .await
+    .map_err(DeployError::from)?;
+
+    Ok((deploy_tx_hash, contract_address))
+}
+
 async fn deploy_bridge(
     deployer: Address,
     deployer_private_key: SecretKey,

crates/l2/contracts/src/l1/OnChainProposer.sol

@@ -60,6 +60,16 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
     /// @dev Used only in dev mode.
     address public constant DEV_MODE = address(0xAA);
 
+    /// @notice Indicates whether the contract operates in validium mode.
+    /// @dev This value is immutable and can only be set during contract deployment.
+    bool public immutable VALIDIUM;
+
+    /// @notice Constructor to initialize the immutable validium value.
+    /// @param _validium A boolean indicating if the contract operates in validium mode.
+    constructor(bool _validium) {
+        VALIDIUM = _validium;
+    }
+
     modifier onlySequencer() {
         require(
             authorizedSequencerAddresses[msg.sender],
@@ -149,13 +159,14 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
         bytes32 withdrawalsLogsMerkleRoot,
         bytes32 processedDepositLogsRollingHash
     ) external override onlySequencer {
+        // TODO: Refactor validation
         require(
             blockNumber == lastCommittedBlock + 1,
             "OnChainProposer: blockNumber is not the immediate successor of lastCommittedBlock"
         );
         require(
             blockCommitments[blockNumber].newStateRoot == bytes32(0),
-            "OnChainProposer: block already committed"
+            "OnChainProposer: tried to commit an already committed block"
         );
 
         // Check if commitment is equivalent to blob's KZG commitment.
@@ -176,13 +187,15 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
                 withdrawalsLogsMerkleRoot
             );
         }
+
         blockCommitments[blockNumber] = BlockCommitmentInfo(
             newStateRoot,
             stateDiffKZGVersionedHash,
             processedDepositLogsRollingHash
         );
-        lastCommittedBlock = blockNumber;
         emit BlockCommitted(newStateRoot);
+
+        lastCommittedBlock = blockNumber;
     }
 
     /// @inheritdoc IOnChainProposer
@@ -206,17 +219,16 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
         bytes calldata picoPublicValues,
         uint256[8] calldata picoProof
     ) external override onlySequencer {
+        // TODO: Refactor validation
         // TODO: imageid, programvkey and riscvvkey should be constants
         // TODO: organize each zkvm proof arguments in their own structs
         require(
             blockNumber == lastVerifiedBlock + 1,
             "OnChainProposer: block already verified"
         );
-
         require(
-            blockCommitments[blockNumber].stateDiffKZGVersionedHash !=
-                bytes32(0),
-            "OnChainProposer: block not committed"
+            blockCommitments[blockNumber].newStateRoot != bytes32(0),
+            "OnChainProposer: cannot verify an uncommitted block"
         );
 
         if (PICOVERIFIER != DEV_MODE) {
@@ -247,6 +259,7 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
         }
 
         lastVerifiedBlock = blockNumber;
+
         // The first 2 bytes are the number of deposits.
         uint16 deposits_amount = uint16(
             bytes2(
@@ -256,7 +269,6 @@ contract OnChainProposer is IOnChainProposer, ReentrancyGuard {
         if (deposits_amount > 0) {
             ICommonBridge(BRIDGE).removePendingDepositLogs(deposits_amount);
         }
-
         // Remove previous block commitment as it is no longer needed.
         delete blockCommitments[blockNumber - 1];