You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You successfully submitted a PR! Due to the amount of PRs coming in: we will only look at PRs that the CI is happy with. We can also not hold your hand getting the CI green - just look how others that where merged did it and RTFM. So as long as there is any CI check that reports an error - no human will look at this. You might be able to ask for some support after supporting the project - e.g. by sending funds to lists.eth. When you fixed things after a requested change - then you also need to (re-)request a review.
Copy file name to clipboardExpand all lines: README.md
+28-23Lines changed: 28 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The source data is in _data/chains. Each chain has its own file with the filename being the [CAIP-2](https://github.com/ChainAgnostic/CAIPs/blob/master/CAIPs/caip-2.md) representation as name and `.json` as extension.
4
4
5
-
## Example
5
+
## Example:
6
6
7
7
```json
8
8
{
@@ -33,7 +33,8 @@ The source data is in _data/chains. Each chain has its own file with the filenam
33
33
}
34
34
```
35
35
36
-
when an icon is used in either the network or an explorer there must be a json in _data/icons with the name used (e.g. in the above example there must be a `ethereum.json` and a `etherscan.json` in there) - the icon jsons look like this:
36
+
When an icon is used in either the network or an explorer, there must be a JSON in _data/icons with the name used.
37
+
(e.g. in the above example there must be a `ethereum.json` and a `etherscan.json` in there) - The icon JSON files look like this:
37
38
38
39
```json
39
40
@@ -49,9 +50,10 @@ when an icon is used in either the network or an explorer there must be a json i
49
50
```
50
51
51
52
where:
52
-
*the URL must be an IPFS url that is publicly resolvable
53
-
* width and height are positive integers
53
+
*The URL MUST be publicly resolvable through IPFS
54
+
* width and height MUST be positive integers
54
55
* format is either "png", "jpg" or "svg"
56
+
* size MUST be less than 250kb
55
57
56
58
If the chain is an L2 or a shard of another chain you can link it to the parent chain like this:
57
59
@@ -67,7 +69,7 @@ If the chain is an L2 or a shard of another chain you can link it to the parent
67
69
}
68
70
```
69
71
70
-
where you need to specify type 2 and the reference to an existing parent. The field about bridges is optional.
72
+
where you need to specify the type and the reference to an existing parent. The field about bridges is optional.
71
73
72
74
You can add a `status` field e.g. to deprecate (via status `deprecated`) a chain (a chain should never be deleted as this would open the door to replay attacks)
73
75
Other options for `status` are `active` (default) or `incubating`
@@ -82,7 +84,7 @@ There are also aggregated json files with all chains automatically assembled:
82
84
83
85
* the shortName and name MUST be unique - see e.g. EIP-3770 on why
84
86
* if referencing a parent chain - the chain MUST exist in the repo
85
-
* if using a IPFS CID for the icon - the CID MUST be retrievable via `ipfs get` - not only through some gateway (means please do not use pinata for now)
87
+
* if using an IPFS CID for the icon - the CID MUST be retrievable via `ipfs get` - not only through some gateway (means please do not use pinata for now)
86
88
* for more constraints you can look into the CI
87
89
88
90
## Collision management
@@ -93,9 +95,9 @@ There are also aggregated json files with all chains automatically assembled:
93
95
The only way to get a chain reassigned is when the old chain gets deprecated. This can e.g. be used for testnets that are short-lived. But then you will get the redFlag "reusedChaiID" that should be displayed in clients to warn them about the dangers here.
94
96
95
97
## Getting your PR merged
96
-
### before PR is submited
98
+
### before PR is submitted
97
99
98
-
Before submitting a PR, please verify that checks pass with:
100
+
Before submitting a PR, please ensure all checks pass by running:
99
101
100
102
```bash
101
103
$ ./gradlew run
@@ -104,20 +106,30 @@ BUILD SUCCESSFUL in 7s
104
106
9 actionable tasks: 9 executed
105
107
```
106
108
109
+
Additionally, run Prettier to format your JSON according to the style [defined here ](https://github.com/ethereum-lists/chains/blob/master/.prettierrc.json)
110
+
e.g. run
111
+
112
+
```
113
+
npx prettier --write _data/*/*.json
114
+
```
115
+
107
116
### Once PR is submitted
108
117
109
118
* Make sure CI is green. There will likely be no review when the CI is red.
110
119
* When making changes that fix the CI problems - please re-request a review - otherwise it is too much work to track such changes with so many PRs daily
0 commit comments