Automate Superchain Registry chain support

.editorconfig

@@ -13,6 +13,8 @@ file_header_template = SPDX-FileCopyrightText: 2025 Demerzel Solutions Limited\n
 
 [*.cs]
 indent_size = 4
+[*.py]
+indent_size = 4
 
 #### Naming styles ####
 

.github/workflows/update-fast-sync.yml

@@ -23,7 +23,7 @@ jobs:
           pip install setuptools
           pip install emoji
       - name: Update config files
-        run: python3 scripts/syncSettings.py ${{ secrets.ETHERSCAN_API_KEY }}
+        run: python3 scripts/syncSettings.py -k ${{ secrets.ETHERSCAN_API_KEY }}
       - name: Create GitHub app token
         id: gh-app
         uses: actions/create-github-app-token@v1

.github/workflows/update-superchain.yml

@@ -0,0 +1,56 @@
+name: Update OP Superchain chains
+
+on:
+  schedule:
+    - cron: '0 0 * * 0'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-configs:
+    name: Update OP Superchain chains
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13.1'
+      - name: Install dependencies
+        run: |
+          pip install zstandard
+          pip install safe-pysha3
+          pip install requests
+          pip install setuptools
+          pip install emoji
+      - name: Generate Chainspec and config files
+        run: python3 scripts/superchain.py -v
+      - name: Update fast sync settings
+        run: python3 scripts/syncSettings.py --superchain
+      - name: Copy generated files
+        run:
+          cp output/chainspec/* ./src/Nethermind/Chains
+          cp output/runner/* ./src/Nethermind/Nethermind.Runner/configs
+      - name: Create GitHub app token
+        id: gh-app
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
+      - name: Create a pull request
+        env:
+          GH_TOKEN: ${{ steps.gh-app.outputs.token }}
+        run: |
+          head_branch=feature/update-superchain-${{ github.run_number }}-${{ github.run_attempt }}
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          git checkout -b $head_branch
+          git add -A
+          git commit -am "Update OP Superchain chains"
+          git push origin $head_branch
+          gh pr create -B master -H $head_branch -t "Update OP Superchain chains" \
+            -b "Generated Chainspec and config files" -l configuration -l sync

scripts/syncSettings.py

@@ -1,21 +1,14 @@
 # SPDX-FileCopyrightText: 2022 Demerzel Solutions Limited
 # SPDX-License-Identifier: LGPL-3.0-only
 
+import argparse
 import json
-import subprocess
 import emoji
-import sys
 import requests
 
-configsPath = './src/Nethermind/Nethermind.Runner/configs'
-
-key = sys.argv[1]
-
-headers = {
-    'Content-type': 'application/json',
-}
-
-print(emoji.emojize("Fast Sync configuration settings initialization     :white_check_mark: "))
+CONFIGS_PATH = './src/Nethermind/Nethermind.Runner/configs'
+APPLICATION_JSON = { 'Content-type': 'application/json' }
+SUPERCHAIN_CHAINS = ["op-mainnet", "op-sepolia", "base-mainnet", "base-sepolia", "worldchain-mainnet", "worldchain-sepolia"]
 
 configs = {
     # fast sync section
@@ -97,6 +90,18 @@
         "multiplierRequirement": 10000,
         "isPoS": True
     },
+    "worldchain-mainnet": {
+        "url": "https://worldchain-mainnet.g.alchemy.com/public",
+        "blockReduced": 8192,
+        "multiplierRequirement": 10000,
+        "isPoS": True
+    },
+    "worldchain-sepolia": {
+        "url": "https://worldchain-sepolia.g.alchemy.com/public",
+        "blockReduced": 8192,
+        "multiplierRequirement": 10000,
+        "isPoS": True
+    },
     "linea-mainnet": {
         "url": "https://rpc.linea.build",
         "blockReduced": 8192,
@@ -113,22 +118,33 @@
 
 def fastBlocksSettings(configuration, apiUrl, blockReduced, multiplierRequirement, isPoS):
     if "etherscan" in apiUrl:
-        latestBlock = int(json.loads(subprocess.getoutput(
-            f'curl --silent "https://{apiUrl}/api?module=proxy&action=eth_blockNumber&apikey={key}"'))['result'], 16)
+        params = {
+            'module': 'proxy',
+            'action': 'eth_blockNumber',
+            'apikey': key,
+        }
+        response = requests.get(f'https://{apiUrl}/api', params=params)
+        latestBlock = int(json.loads(response.text)['result'], 16)
     else:
         data_req = '{"id":0,"jsonrpc":"2.0","method": "eth_blockNumber","params": []}'
-        response = requests.post(apiUrl, headers=headers, data=data_req).text
+        response = requests.post(apiUrl, headers=APPLICATION_JSON, data=data_req).text
         latestBlock = int(json.loads(response)['result'], 16)
 
     baseBlock = latestBlock - blockReduced
     baseBlock = baseBlock - baseBlock % multiplierRequirement
 
     if "etherscan" in apiUrl:
-        pivot = json.loads(subprocess.getoutput(
-            f'curl --silent "https://{apiUrl}/api?module=proxy&action=eth_getBlockByNumber&tag={hex(baseBlock)}&boolean=true&apikey={key}"'))
+        params = {
+            'module': 'proxy',
+            'action': 'eth_getBlockByNumber',
+            'tag': f'{hex(baseBlock)}',
+            'boolean': 'true',
+            'apikey': key,
+        }
+        pivot = json.loads(requests.get(f'https://{apiUrl}/api', params=params))
     else:
-        data_req = '{"id":0,"jsonrpc":"2.0","method": "eth_getBlockByNumber","params": ["' + str(hex(baseBlock)) + '", false]}'
-        pivot = json.loads(requests.post(apiUrl, headers=headers, data=data_req).text)
+        data_req = f'{{"id":0,"jsonrpc":"2.0","method": "eth_getBlockByNumber","params": ["{hex(baseBlock)}", false]}}'
+        pivot = json.loads(requests.post(apiUrl, headers=APPLICATION_JSON, data=data_req).text)
 
     pivotHash = pivot['result']['hash']
     pivotTotalDifficulty = int(pivot['result'].get('totalDifficulty', '0x0'), 16)
@@ -139,18 +155,30 @@ def fastBlocksSettings(configuration, apiUrl, blockReduced, multiplierRequiremen
     if not isPoS:
       print(configuration + ' PivotTotalDifficulty: ' + str(pivotTotalDifficulty))
 
-    with open(f'{configsPath}/{configuration}.json', 'r') as mainnetCfg:
+    with open(f'{CONFIGS_PATH}/{configuration}.json', 'r') as mainnetCfg:
         data = json.load(mainnetCfg)
 
     data['Sync']['PivotNumber'] = baseBlock
     data['Sync']['PivotHash'] = pivotHash
-  
+
     if not isPoS:
         data['Sync']['PivotTotalDifficulty'] = str(pivotTotalDifficulty)
 
-    with open(f'{configsPath}/{configuration}.json', 'w') as mainnetCfgChanged:
+    with open(f'{CONFIGS_PATH}/{configuration}.json', 'w') as mainnetCfgChanged:
         json.dump(data, mainnetCfgChanged, indent=2)
 
-for config, value in configs.items():
-    print(emoji.emojize(f"{config.capitalize()} section                                     :white_check_mark: "))
-    fastBlocksSettings(config, value['url'], value['blockReduced'], value['multiplierRequirement'], value['isPoS'])
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(description="Fast Sync configuration settings")
+    parser.add_argument("-k", "--key", default="", help="etherscan API key")
+    parser.add_argument("--superchain", action="store_true", help="only process superchain chains")
+
+    args = parser.parse_args()
+    key = args.key
+
+    print(emoji.emojize("Fast Sync configuration settings initialization     :white_check_mark: "))
+    for config, value in configs.items():
+        if args.superchain and config not in SUPERCHAIN_CHAINS:
+            continue
+
+        print(emoji.emojize(f"{config.capitalize()} section                                     :white_check_mark: "))
+        fastBlocksSettings(config, value['url'], value['blockReduced'], value['multiplierRequirement'], value['isPoS'])