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

Add eip155/caip2.json and section on machine-readable supplements to Contributing.md #113

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
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
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,26 @@ When linking to an image in the CAN, use relative links such as `../assets/names

It is greatly appreciated if you can render your PR locally to check the Jekyll syntax; to do so, run `bundle exec jekyll serve`.

## Machine-readable Supplements

To facilitate validation and multi-chain registries, you may choose to include (or editors may include) a secondary copy of each profile's validation sections and test cases in the form of a `.json` file, with the following format:

### Example: eip155/caip2.json

```json
{
"standard":"caip2",
"validation":"[0-9]{1-32}",
"test cases": [
"Ethereum mainnet": "eip155:1",
"Görli": "eip155:5",
"Auxilium Network Mainnet": "eip155:28945486"
]
}
```

These machine-readable records are for illustrative purposes only, and any time they contradict or grow out-of-date with their corresponding specifications, the latter should be considered authoritative.

## Style Guide

Github-flavored Markdown is encouraged for all CAIP documents, with the following conventions observed:
Expand Down
9 changes: 9 additions & 0 deletions eip155/caip2.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"standard":"caip2",
"validation":"[0-9]{1-32}",
"test cases": [
"Ethereum mainnet": "eip155:1",
"Görli": "eip155:5",
"Auxilium Network Mainnet": "eip155:28945486"
]
}