feat: Support for cutom geneis/chain spec for Besu and Nethermind (#161)

Author: karolpivo

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.37.0] - 2024-03-23
+
+### Added
+
+- Support for custom genesis file in Besu and Nethermind
+- Molecule test scenario for custom genesis file
+
 ## [0.36.0] - 2024-03-21
 
 ### Changed

defaults/main/main.yml

@@ -167,3 +167,6 @@ container_keystore_dir: /keystore
 host_ip_address_to_bind_to: 127.0.0.1
 
 bootnodes: ""
+
+# Nethermind and Besu only
+genesis_file: ""

molecule/custom_genesis/molecule.yml

@@ -0,0 +1,70 @@
+---
+role_name_check: 1
+dependency:
+  name: galaxy
+  options:
+    ignore-certs: true
+    ignore-errors: true
+    role-file: requirements_dev.yml
+    requirements-file: requirements.yml
+
+
+driver:
+  name: vagrant
+  provider:
+    name: libvirt
+  provision: false
+  cachier: machine
+  parallel: true
+  default_box: '${SLINGNODE_BOX:-generic/ubuntu2204}'
+
+
+platforms:
+  - name: instance
+    hostname: slingnode-test-01
+    config_options:
+      ssh.keep_alive: true
+      ssh.remote_user: 'vagrant'
+      synced_folder: false
+    memory: 10240
+    cpus: 4
+    provider_options:
+      video_type: 'vga'
+      driver: 'kvm'
+      cpu_mode: 'host-passthrough'
+      video_vram: '16384'
+
+
+provisioner:
+  name: ansible
+  env:
+    ANSIBLE_PIPELINING: "True"
+  playbooks:
+    converge: ../resources/playbooks/converge.yml
+    prepare: ../resources/playbooks/prepare.yml
+  inventory:
+    group_vars:
+      all:
+        deploy_consensus: false
+        deploy_validator: false
+        clients:
+          execution: ${SLINGNODE_EXECUTION:-besu}
+        genesis_file: "molecule/resources/fixtures/{{ 'nethermind_chainspec.json' if clients.execution == 'nethermind' else 'genesis.json' }}"
+
+
+verifier:
+  name: ansible
+
+
+scenario:
+  name: custom_genesis
+  test_sequence:
+    - lint
+    - destroy
+    - dependency
+    - syntax
+    - create
+    - prepare
+    - converge
+    - verify
+    - destroy

molecule/custom_genesis/verify.yml

@@ -0,0 +1,11 @@
+---
+- name: Verify
+  hosts: all
+  become: true
+  gather_facts: false
+
+  tasks:
+
+    - name: Include test tasks
+      ansible.builtin.include_tasks:
+        file: ../resources/tests/all_clients.yml

molecule/resources/fixtures/genesis.json

@@ -0,0 +1,21 @@
+{
+  "config": {
+    "chainId": 1981,
+    "berlinBlock": 0,
+    "clique": {
+      "blockperiodseconds": 15,
+      "epochlength": 30000
+    }
+  },
+  "coinbase": "0x0000000000000000000000000000000000000000",
+  "difficulty": "0x1",
+  "extraData": "0x000000000000000000000000000000000000000000000000000000000000000001a54556254bfa3db2daa7673435ec63649925c50000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000",
+  "gasLimit": "0x1fffffffffffff",
+  "mixHash": "0x0000000000000000000000000000000000000000000000000000000000000000",
+  "nonce": "0x0",
+  "timestamp": "0x5c51a607",
+  "alloc": {},
+  "number": "0x0",
+  "gasUsed": "0x0",
+  "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000"
+}

molecule/resources/fixtures/nethermind_chainspec.json

@@ -0,0 +1,35 @@
+{
+  "name": "Private",
+  "engine": {
+    "authorityRound": {
+      "params": {
+        "stepDuration": "5",
+        "validators" : {
+          "list": ["0x7d577a597b2742b498cb5cf0c26cdcd726d39e6e"]
+        }
+      }
+    }
+  },
+  "params": {
+    "gasLimitBoundDivisor": "0x0400",
+    "maximumExtraDataSize": "0x20",
+    "minGasLimit": "0x1388",
+    "networkID" : "0x2323"
+  },
+  "genesis": {
+    "seal": {
+      "authorityRound": {
+        "step": "0x0",
+        "signature": "0x0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"
+      }
+    },
+    "difficulty": "0x20000",
+    "gasLimit": "0x5B8D80"
+  },
+  "accounts": {
+    "0x0000000000000000000000000000000000000001": { "balance": "1", "builtin": { "name": "ecrecover", "pricing": { "linear": { "base": 3000, "word": 0 } } } },
+    "0x0000000000000000000000000000000000000002": { "balance": "1", "builtin": { "name": "sha256", "pricing": { "linear": { "base": 60, "word": 12 } } } },
+    "0x0000000000000000000000000000000000000003": { "balance": "1", "builtin": { "name": "ripemd160", "pricing": { "linear": { "base": 600, "word": 120 } } } },
+    "0x0000000000000000000000000000000000000004": { "balance": "1", "builtin": { "name": "identity", "pricing": { "linear": { "base": 15, "word": 3 } } } }
+  }
+}

tasks/execution.yml

@@ -90,6 +90,19 @@
     mode: "0700"
 
 
+- name: Copy custom genesis file to the server (besu and nethermind only)
+  ansible.builtin.template:
+    src: "{{ item.src }}"
+    dest: "{{ item.dest }}"
+    owner: "{{ execution_client_user.user }}"
+    group: "{{ execution_client_group.group }}"
+    mode: "0700"
+  loop:
+    - src: "{{ genesis_file }}"
+      dest: "{{ blockchain_root_path }}/execution/{{ clients.execution }}/genesis.json"
+  when: genesis_file != "" and (clients.execution == "besu" or clients.execution == "nethermind")
+
+
 - name: Copy docker-compose files for execution client
   ansible.builtin.template:
     src: "{{ item.src }}"

templates/dc-blockchain-eth-execution-besu.yml.j2

@@ -92,7 +92,9 @@ services:
       - --engine-jwt-secret=/jwt/{{ jwt_secret_file }}
       - --engine-rpc-port={{ execution_client_authrpc_port }}
       - --logging={{ besu_log_level }}
+{% if not genesis_file %}
       - --network={{ network }}
+{% endif %}
 {% if execution_client_metrics_enabled|bool == True %}
       - --metrics-enabled
       - --metrics-host=0.0.0.0
@@ -112,7 +114,9 @@ services:
 {% if bootnodes %}
       - --bootnodes={{ bootnodes }}
 {% endif %}
-
+{% if genesis_file %}
+      - --genesis-file={{ besu_data_dir }}/genesis.json
+{% endif %}
 
 networks:
   service_net:

templates/dc-blockchain-eth-execution-nethermind.yml.j2

@@ -93,15 +93,19 @@ services:
       - --Metrics.Enabled={{ execution_client_metrics_enabled | string | lower }}
       - --Metrics.ExposePort={{ execution_client_metrics_port }}
       - --Metrics.IntervalSeconds={{ nethermind_metrics_intervalseconds }}
+{% if not genesis_file %}
       - --config={{ network }}
+{% endif %}
       - --Sync.AncientBodiesBarrier=1
       - --Sync.AncientReceiptsBarrier=1
       - --log={{ nethermind_log_level }}
       - --Pruning.FullPruningMaxDegreeOfParallelism={{ nethermind_pruning_full_pruning_max_degree_of_parallelism }}
 {% if bootnodes %}
       - --Network.Bootnodes={{ bootnodes }}
 {% endif %}
-
+{% if genesis_file %}
+      - --Init.ChainSpecPath={{ nethermind_data_dir }}/genesis.json
+{% endif %}
 
 
 networks: