@@ -21,7 +21,7 @@ specification and the JSON schema [specification][json-schema] to get started.
21
21
22
22
### Building
23
23
24
- The specification is split into multiple files to improve readability. The
24
+ The specification is split into multiple files to improve readability. The
25
25
spec can be compiled into a single document as follows:
26
26
27
27
``` console
@@ -36,7 +36,7 @@ will have all schema `#ref`s resolved.
36
36
#### Testing
37
37
38
38
There are several mechanisms for testing specification contributions and client
39
- conformance.
39
+ conformance.
40
40
41
41
First is the [ OpenRPC validator] [ validator ] . It performs some basic syntactic
42
42
checks on the generated specification.
@@ -56,6 +56,13 @@ $ speccheck -v
56
56
all passing.
57
57
```
58
58
59
+ If you get an error that says: ` speccheck: command not found ` ,
60
+ make sure that the go binary is in your $PATH:
61
+
62
+ ``` console
63
+ $ export PATH=$HOME /go/bin:$PATH
64
+ ```
65
+
59
66
The spell checker ensures the specification is free of spelling errors.
60
67
61
68
``` console
@@ -64,6 +71,10 @@ $ pyspelling -c spellcheck.yaml
64
71
Spelling check passed :)
65
72
```
66
73
74
+ pyspelling is a wrapper around either [ Aspell] ( http://aspell.net/ ) or
75
+ [ Hunspell] ( https://hunspell.github.io/ ) . You'll need to install
76
+ one of those before running ` pyspelling ` .
77
+
67
78
Finally, the test cases in the ` tests/ ` directory may be run against individual
68
79
execution client using the [ ` hive ` ] simulator [ ` rpc-compat ` ] [ rpc-compat ] .
69
80
Please see the documentation in the aforementioned repositories for more
@@ -102,7 +113,7 @@ This repository is licensed under [CC0](LICENSE).
102
113
[ graphql-schema ] : http://graphql-schema.ethdevops.io/?url=https://raw.githubusercontent.com/ethereum/execution-apis/main/graphql.json
103
114
[ eip-1767 ] : https://eips.ethereum.org/EIPS/eip-1767
104
115
[ making-changes ] : docs/making-changes.md
105
- [ json-schema] : https://json-schema.org
116
+ [ json-schema ] : https://json-schema.org
106
117
[ hive ] : https://github.com/ethereum/hive
107
118
[ rpc-compat ] : https://github.com/ethereum/hive/tree/master/simulators/ethereum/rpc-compat
108
119
[ test-gen ] : tests/README.md
0 commit comments