From aace4b47b47c5d39d17196af7d05aa3e196b055f Mon Sep 17 00:00:00 2001 From: Mark Date: Wed, 22 Oct 2025 23:35:01 +0300 Subject: [PATCH] Add section on data aggregation to README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index e0e2b71b8889..dc0048b0aca4 100644 --- a/README.md +++ b/README.md @@ -80,6 +80,16 @@ There are also aggregated json files with all chains automatically assembled: * https://chainid.network/chains.json * https://chainid.network/chains_mini.json (miniaturized - fewer fields for smaller filesize) +## Aggregation of Chain Data + +All chain metadata from `_data/chains/` is automatically aggregated into a single JSON file (e.g., `aggregated-chains.json`) using the Kotlin-based build script. To run aggregation locally: + +1. Ensure you have Gradle installed or use the wrapper. +2. Run `./gradlew aggregate` (assuming the task exists; adjust if needed based on build.gradle). +3. The output will be in `build/aggregated/` or similar. + +This process validates uniqueness of `shortName`, `name`, and `chainId` to prevent collisions. For details, see `src/main/kotlin/Aggregator.kt` (if present). + ## Constraints * the shortName and name MUST be unique - see e.g. EIP-3770 on why