feat: Add sync script to push validator.json files to bucket (#524)

* feat: Adding script to sync validator-info json summary to bucket

* Updating workflow path

Author: Brandon Graham

.github/workflows/generate-validators.yml

@@ -0,0 +1,57 @@
+name: Generate and Upload Validator Files
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'mainnet/**.json'
+      - 'testnet/**.json'
+      - '!mainnet/mainnet_validators.json'
+      - '!testnet/testnet_validators.json'
+
+env:
+  R2_PATH_PREFIX: ''  # Set to a path like 'validators/' if you want files under a subdirectory
+
+jobs:
+  generate-and-upload:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+      
+      - name: Run validator generation script
+        run: python3 scripts/generate_validators_json.py
+      
+      - name: Install AWS CLI (for S3-compatible upload)
+        run: |
+          pip install awscli
+      
+      - name: Configure AWS CLI for R2
+        env:
+          R2_ACCESS_KEY_ID: ${{ secrets.R2_ACCESS_KEY_ID }}
+          R2_SECRET_ACCESS_KEY: ${{ secrets.R2_SECRET_ACCESS_KEY }}
+        run: |
+          aws configure set aws_access_key_id $R2_ACCESS_KEY_ID
+          aws configure set aws_secret_access_key $R2_SECRET_ACCESS_KEY
+          aws configure set default.region auto
+      
+      - name: Upload files to R2
+        env:
+          R2_BUCKET_NAME: ${{ secrets.R2_BUCKET_NAME }}
+          R2_ENDPOINT: ${{ secrets.R2_ENDPOINT }}
+        run: |
+          # Upload mainnet validators JSON
+          aws s3 cp mainnet/mainnet_validators.json s3://${R2_BUCKET_NAME}/validator-info/mainnet/validators.json --endpoint-url $R2_ENDPOINT
+          
+          # Upload testnet validators JSON
+          aws s3 cp testnet/testnet_validators.json s3://${R2_BUCKET_NAME}/validator-info/testnet/validators.json --endpoint-url $R2_ENDPOINT
+          
+          echo "✅ Successfully uploaded validator JSON files to R2"
+

scripts/generate_validators_json.py

@@ -1,12 +1,11 @@
 #!/usr/bin/env python3
-import csv
 import json
 import os
 import glob
 
 
 def read_validators(directory):
-    """Read all validator JSON files from a directory and return dict mapping secp to name."""
+    """Read all validator JSON files from a directory and return dict mapping secp to full validator object."""
     validators_dict = {}
     json_files = glob.glob(os.path.join(directory, "*.json"))
 
@@ -15,16 +14,15 @@ def read_validators(directory):
             with open(json_file, "r") as f:
                 data = json.load(f)
 
-            # Extract fields
-            name = data.get("name", "").strip()
+            # Extract secp key
             secp = data.get("secp", "")
 
-            # Use secp as fallback if name is empty
-            if not name:
-                name = secp
+            # Use secp as fallback for name if name is empty
+            if not data.get("name", "").strip():
+                data["name"] = secp
 
-            # Map secp key to validator name
-            validators_dict[secp] = name
+            # Map secp key to full validator object
+            validators_dict[secp] = data
 
         except (json.JSONDecodeError, IOError) as e:
             print(f"Warning: Failed to read {json_file}: {e}")
@@ -34,25 +32,13 @@ def read_validators(directory):
 
 
 def write_json(validators_dict, output_file):
-    """Write validators to JSON file with secp as key and name as value."""
+    """Write validators to JSON file with secp as key and full validator object as value."""
     with open(output_file, "w") as f:
         json.dump(validators_dict, f, indent=2)
 
     print(f"✅ Generated {output_file} with {len(validators_dict)} validators")
 
 
-def write_csv(validators_dict, output_file):
-    """Write validators to CSV file with secp_key and name columns."""
-    with open(output_file, "w", newline="") as f:
-        writer = csv.writer(f)
-        writer.writerow(["secp_key", "name"])
-        
-        for secp, name in validators_dict.items():
-            writer.writerow([secp, name])
-    
-    print(f"✅ Generated {output_file} with {len(validators_dict)} validators")
-
-
 def main():
     # Get the project root directory (parent of scripts/)
     script_dir = os.path.dirname(os.path.abspath(__file__))
@@ -61,16 +47,15 @@ def main():
     # Process mainnet validators
     mainnet_dir = os.path.join(project_root, "mainnet")
     mainnet_validators = read_validators(mainnet_dir)
-    write_json(mainnet_validators, "mainnet_validators.json")
-    write_csv(mainnet_validators, "mainnet_validators.csv")
+    mainnet_json = os.path.join(mainnet_dir, "mainnet_validators.json")
+    write_json(mainnet_validators, mainnet_json)
 
     # Process testnet validators
     testnet_dir = os.path.join(project_root, "testnet")
     testnet_validators = read_validators(testnet_dir)
-    write_json(testnet_validators, "testnet_validators.json")
-    write_csv(testnet_validators, "testnet_validators.csv")
+    testnet_json = os.path.join(testnet_dir, "testnet_validators.json")
+    write_json(testnet_validators, testnet_json)
 
 
 if __name__ == "__main__":
     main()
-