Skip to content
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.

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

Fix typos, add networks list #13

Merged
merged 3 commits into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ jobs:
- name: Generate registry
run: bun generate:public

- name: Generate table
run: bun generate:table

- name: Format
run: bun format

Expand Down
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# The Graph networks registry

This repository manages a registry of networks in The Graph ecosystem. See [Releases](https://github.com/pinax-network/supported-networks/releases) page for the latest version of the registry.
[![GitHub Release](https://img.shields.io/github/v/release/graphprotocol/networks-registry)](https://github.com/graphprotocol/networks-registry/releases/latest)

This repository manages a registry of networks in The Graph ecosystem.

See [Releases](https://github.com/graphprotocol/networks-registry/releases) page for the latest version of the registry.
See [Networks Table](./docs/networks-table.md) for an up-to-date auto-generated networks list.

[Libraries](https://github.com/pinax-network/graph-networks-libs) for Typescript, Go and Rust.

[Demo app](https://graph-networks-app.vercel.app/) for the registry.

## Adding/updating a chain

Expand All @@ -14,6 +23,7 @@ This repository manages a registry of networks in The Graph ecosystem. See [Rele

- `schemas/`: Contains the schema for the registry
- `registry/`: Contains the networks JSONs (edit these)
- `docs/`: Contains docs and auto-generated networks table
- `public`: Contains all generated registry versions (don't edit those)
- `src/`: Contains scripts to validate networks JSONs and generate the resulting registry JSON

Expand Down Expand Up @@ -71,9 +81,9 @@ In addition to the above, the JSON Schema is available at TheGraphNetworksRegist

## Registry Usage

In your application you can pull one of the registry JSONs above depending on your use case - whether it's pinned to a specific registry version, whether you allow backwards compatible schema changes or you just need the latest one.
In your application you can use one of the generated registry JSONs above depending on your use case.

Refer to [Using The Graph Networks Registry](./docs/using-the-registry.md) for more information and best practices.
Libraries for Typescript, Go and Rust [exist](https://github.com/pinax-network/graph-networks-libs) to make it easier to work with the registry.

Typical use cases:

Expand All @@ -84,6 +94,7 @@ Typical use cases:

## References

- [The Graph Networks Registry libraries](https://github.com/pinax-network/graph-networks-libs)
- [Ethereum chains list](https://github.com/ethereum-lists/chains)
- [CAIP-2 chain ids](https://chainagnostic.org/CAIPs/caip-2)
- [Web3Icons](https://github.com/0xa3k5/web3icons/tree/main/raw-svgs/networks/branded)
Expand Down
102 changes: 102 additions & 0 deletions docs/networks-table.md

Large diffs are not rendered by default.

52 changes: 0 additions & 52 deletions docs/using-the-registry.md

This file was deleted.

3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "0.6.0",
"version": "0.6.1",
"private": true,
"type": "module",
"scripts": {
Expand All @@ -13,6 +13,7 @@
"generate:types": "json2ts --input schemas/registry.schema.json --output src/types/registry.d.ts --cwd=schemas",
"generate:registry": "bun run ./src/generate.ts",
"generate:public": "bun run ./src/generate.ts registry public",
"generate:table": "bun run ./src/generate_table.ts",
"all": "bun generate:types && bun validate && bun generate:registry && bun format && bun format:check"
},
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/arbitrum-one.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/arbitrum",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/avalanche.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/avalanche",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/base.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/base",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/blast-mainnet.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/blast",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/boba-bnb.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/bobabnb",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/boba.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/boba",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/bsc.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/binance",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/celo.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/celo",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/fantom.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/fantom",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/fuse.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/fuse",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/gnosis.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/gnosis",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/linea.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/linea",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/mainnet.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/ethereum",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/matic.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/polygon",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"issuanceRewards": true,
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/mode-mainnet.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/mode",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/moonbeam.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/moonbeam",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/optimism.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/optimism",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/rootstock.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/rootstock",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/scroll.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/scroll",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/eip155/zora.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/zora",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
2 changes: 1 addition & 1 deletion registry/starknet/starknet-mainnet.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
"indexerDocsUrls": [
{
"url": "https://docs.infradao.com/archive-nodes-101/starknet",
"description": "Arhchive Nodes 101"
"description": "Archive Nodes 101"
}
],
"genesis": {
Expand Down
Loading