Skip to content

Commit 3dd236a

Browse files
pinax-botpinax-bot
committed
generate registry v0.7.0 [no ci]
1 parent d378fcb commit 3dd236a

16 files changed

+21422
-1710
lines changed

‎docs/networks-table.md

Lines changed: 108 additions & 108 deletions
Large diffs are not rendered by default.

‎public/TheGraphNetworksRegistry.json

Lines changed: 1237 additions & 781 deletions
Large diffs are not rendered by default.

‎public/TheGraphNetworksRegistrySchema_v0_7.json

Lines changed: 363 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,363 @@
1+
{
2+
"$id": "https://thegraph.com/schemas/networks-registry.schema.json",
3+
"$schema": "http://json-schema.org/schema#",
4+
"title": "The Graph networks registry schema",
5+
"type": "object",
6+
"properties": {
7+
"$schema": {
8+
"type": "string",
9+
"minLength": 10,
10+
"format": "uri",
11+
"description": "Reference to this schema file"
12+
},
13+
"title": { "type": "string" },
14+
"description": { "type": "string" },
15+
"version": {
16+
"type": "string",
17+
"pattern": "^\\d+\\.\\d+\\.\\d+$",
18+
"description": "Version of the registry"
19+
},
20+
"updatedAt": {
21+
"type": "string",
22+
"format": "date-time",
23+
"description": "Date and time of the last update"
24+
},
25+
"networks": {
26+
"type": "array",
27+
"items": { "$ref": "#/$defs/Network" },
28+
"description": "List of networks"
29+
}
30+
},
31+
"required": [
32+
"networks",
33+
"title",
34+
"description",
35+
"updatedAt",
36+
"version",
37+
"$schema"
38+
],
39+
"additionalProperties": false,
40+
"$defs": {
41+
"Network": {
42+
"type": "object",
43+
"properties": {
44+
"id": {
45+
"type": "string",
46+
"pattern": "^(?!-)[a-z0-9-]{3,}(?<!-)$",
47+
"description": "Established name of the network in The Graph ecosystem, e.g. mainnet, btc, arweave-mainnet, near-testnet"
48+
},
49+
"shortName": {
50+
"type": "string",
51+
"description": "Short display name of the network, e.g. Ethereum, BNB"
52+
},
53+
"secondName": {
54+
"type": "string",
55+
"description": "Second display name of the network, e.g. Sepolia, Nova"
56+
},
57+
"fullName": {
58+
"type": "string",
59+
"description": "Display name of the network, e.g. Ethereum Mainnet, Bitcoin Testnet"
60+
},
61+
"caip2Id": {
62+
"type": "string",
63+
"pattern": "^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}$",
64+
"description": "CAIP-2 Chain ID, e.g. eip155:1, bip122:000000000019d6689c085ae165831e93"
65+
},
66+
"aliases": {
67+
"type": "array",
68+
"items": {
69+
"type": "string",
70+
"pattern": "^(?!-)[a-z0-9-]{3,}(?<!-)$"
71+
},
72+
"description": "[optional] List of possible aliases for the network id, e.g. ethereum, eth, mainnet, eth-mainnet"
73+
},
74+
"networkType": {
75+
"type": "string",
76+
"enum": ["mainnet", "testnet", "devnet", "beacon"],
77+
"description": "Whether the network is a mainnet/testnet/devnet"
78+
},
79+
"relations": {
80+
"type": "array",
81+
"items": {
82+
"type": "object",
83+
"properties": {
84+
"kind": {
85+
"type": "string",
86+
"enum": [
87+
"testnetOf",
88+
"beaconOf",
89+
"forkedFrom",
90+
"l2Of",
91+
"shardOf",
92+
"evmOf",
93+
"svmOf",
94+
"other"
95+
],
96+
"description": "Kind of relation"
97+
},
98+
"network": {
99+
"type": "string",
100+
"pattern": "^[a-z0-9-]+$",
101+
"description": "ID of the related network, e.g. mainnet, near-mainnet"
102+
}
103+
},
104+
"required": ["kind", "network"],
105+
"additionalProperties": false
106+
},
107+
"description": "Relations to other networks in the registry"
108+
},
109+
"firehose": {
110+
"type": "object",
111+
"properties": {
112+
"blockType": {
113+
"type": "string",
114+
"pattern": "^[a-zA-Z0-9.]+$",
115+
"description": "Block type, e.g. sf.ethereum.type.v2.Block"
116+
},
117+
"bytesEncoding": {
118+
"type": "string",
119+
"enum": ["hex", "0xhex", "base58", "base64", "other"],
120+
"description": "Bytes encoding, e.g. hex, 0xhex, base58"
121+
},
122+
"bufUrl": {
123+
"type": "string",
124+
"format": "uri",
125+
"description": "Protobuf definitions on buf.build, e.g. https://buf.build/streamingfast/firehose-ethereum"
126+
},
127+
"evmExtendedModel": {
128+
"type": "boolean",
129+
"description": "[optional] Whether there is support for extended EVM block model"
130+
},
131+
"blockFeatures": {
132+
"type": "array",
133+
"items": {
134+
"type": "string",
135+
"pattern": "^(base|hybrid|extended|extended@[0-9]+)$"
136+
},
137+
"uniqueItems": true,
138+
"description": "Block features supported by the network"
139+
},
140+
"firstStreamableBlock": {
141+
"type": "object",
142+
"properties": {
143+
"height": {
144+
"type": "integer",
145+
"description": "Block height of the first streamable block. Can be different from genesis",
146+
"minimum": 0
147+
},
148+
"id": {
149+
"type": "string",
150+
"description": "Id of the first streamable block either in 0x-prefixed hex or base58",
151+
"pattern": "^(0x[a-fA-F0-9]+|[1-9A-HJ-NP-Za-km-z]+)$"
152+
}
153+
},
154+
"required": ["id", "height"],
155+
"additionalProperties": false,
156+
"description": "First available block information"
157+
},
158+
"deprecatedAt": {
159+
"type": "string",
160+
"format": "date-time",
161+
"description": "[optional] Timestamp when the network was deprecated in Firehose software"
162+
}
163+
},
164+
"required": ["blockType", "bytesEncoding", "bufUrl"],
165+
"additionalProperties": false,
166+
"description": "Firehose block information"
167+
},
168+
"tokenApi": {
169+
"type": "object",
170+
"additionalProperties": false,
171+
"properties": {
172+
"features": {
173+
"type": "array",
174+
"items": {
175+
"type": "string",
176+
"enum": [
177+
"tokens",
178+
"dexes",
179+
"nfts",
180+
"other"
181+
],
182+
"description": "List of Token API features supported"
183+
}
184+
},
185+
"networkId": {
186+
"type": "string",
187+
"pattern": "^(?!-)[a-z0-9-]{3,}(?<!-)$",
188+
"description": "Network ID in Token API, has to be an ID or alias of an existing network"
189+
},
190+
"deprecatedAt": {
191+
"type": "string",
192+
"format": "date-time",
193+
"description": "[optional] Timestamp when the network was deprecated in Token API software"
194+
}
195+
},
196+
"description": "Token API specific configuration information"
197+
},
198+
"nativeToken": {
199+
"type": "string",
200+
"pattern": "^[a-zA-Z0-9]+$",
201+
"description": "Symbol of the native token"
202+
},
203+
"graphNode": {
204+
"type": "object",
205+
"additionalProperties": false,
206+
"properties": {
207+
"protocol": {
208+
"type": "string",
209+
"enum": [
210+
"ethereum",
211+
"near",
212+
"arweave",
213+
"cosmos",
214+
"starknet",
215+
"other"
216+
],
217+
"description": "[optional] Protocol name in graph-node, e.g. ethereum, near, arweave"
218+
},
219+
"deprecatedAt": {
220+
"type": "string",
221+
"format": "date-time",
222+
"description": "[optional] Timestamp when the network was deprecated in Graph Node software"
223+
}
224+
},
225+
"description": "Graph Node specific configuration information"
226+
},
227+
"explorerUrls": {
228+
"type": "array",
229+
"items": { "type": "string", "format": "uri" },
230+
"description": "URLs for the block explorers"
231+
},
232+
"services": {
233+
"type": "object",
234+
"properties": {
235+
"subgraphs": {
236+
"type": "array",
237+
"items": { "type": "string", "format": "uri-template" },
238+
"description": "Subgraph studio deployment URLs, e.g. https://api.thegraph.com/deploy"
239+
},
240+
"sps": {
241+
"type": "array",
242+
"items": { "type": "string", "format": "uri-template" },
243+
"description": "Substreams-based subgraphs studio deployment URLs, e.g. https://api.thegraph.com/deploy"
244+
},
245+
"firehose": {
246+
"type": "array",
247+
"items": { "type": "string", "format": "uri-template" },
248+
"description": "Firehose gRPC URLs, e.g. eth.firehose.pinax.network:443"
249+
},
250+
"substreams": {
251+
"type": "array",
252+
"items": { "type": "string", "format": "uri-template" },
253+
"description": "Substreams gRPC URLs, e.g. eth.substreams.pinax.network:443"
254+
},
255+
"tokenApi": {
256+
"type": "array",
257+
"items": { "type": "string", "format": "uri-template" },
258+
"description": "Token API URLs, e.g. https://token-api.thegraph.com"
259+
}
260+
},
261+
"additionalProperties": false,
262+
"description": "Services available for the network in the ecosystem"
263+
},
264+
"issuanceRewards": {
265+
"type": "boolean",
266+
"description": "Issuance rewards on the Graph Network for this chain"
267+
},
268+
"icon": {
269+
"type": "object",
270+
"properties": {
271+
"web3Icons": {
272+
"type": "object",
273+
"properties": {
274+
"name": {
275+
"type": "string",
276+
"pattern": "^[a-z0-9-]+$",
277+
"description": "Web3Icons icon ID"
278+
},
279+
"variants": {
280+
"type": "array",
281+
"items": {
282+
"type": "string",
283+
"pattern": "^(mono|branded|background)$"
284+
},
285+
"uniqueItems": true,
286+
"description": "Variants of the icon, if none specified - all are available"
287+
}
288+
},
289+
"required": ["name"],
290+
"additionalProperties": false,
291+
"description": "Web3Icons icon - see https://github.com/0xa3k5/web3icons"
292+
}
293+
},
294+
"additionalProperties": false,
295+
"description": "Icons for the network"
296+
},
297+
"rpcUrls": {
298+
"type": "array",
299+
"items": { "type": "string", "format": "uri-template" },
300+
"description": "List of RPC URLs for the chain. Use {CUSTOM_API_KEY} as a placeholder for a private API key"
301+
},
302+
"apiUrls": {
303+
"type": "array",
304+
"items": {
305+
"type": "object",
306+
"properties": {
307+
"url": { "type": "string", "format": "uri-template" },
308+
"kind": {
309+
"type": "string",
310+
"enum": [
311+
"etherscan",
312+
"blockscout",
313+
"ethplorer",
314+
"subscan",
315+
"other"
316+
],
317+
"description": "Kind of API"
318+
}
319+
},
320+
"required": ["url", "kind"],
321+
"additionalProperties": false
322+
},
323+
"description": "List of API URLs for the network, i.e. Etherescan-like API to get ABI. Use {CUSTOM_API_KEY} as a placeholder for a private API key"
324+
},
325+
"docsUrl": {
326+
"type": "string",
327+
"format": "uri",
328+
"description": "URL to the chain documentation"
329+
},
330+
"indexerDocsUrls": {
331+
"type": "array",
332+
"items": {
333+
"type": "object",
334+
"properties": {
335+
"url": {
336+
"type": "string",
337+
"format": "url",
338+
"description": "URL to the documentation, e.g. https://docs.infradao.com/archive-nodes-101/arbitrum"
339+
},
340+
"description": {
341+
"type": "string",
342+
"description": "Docs description, e.g. Arbitrum 101"
343+
}
344+
},
345+
"required": ["url"],
346+
"additionalProperties": false
347+
},
348+
"description": "Documentation to run indexer components for this network"
349+
}
350+
},
351+
"required": [
352+
"id",
353+
"caip2Id",
354+
"shortName",
355+
"fullName",
356+
"networkType",
357+
"services",
358+
"issuanceRewards"
359+
],
360+
"additionalProperties": false
361+
}
362+
}
363+
}

0 commit comments

Comments
 (0)