Skip to content

Add section on data aggregation to README #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add section on data aggregation to README #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down