Merge pull request #246 from lightclient/convert-to-yaml

Convert spec to yaml

Author: lightclient

package-lock.json

@@ -31,6 +31,7 @@
     "gh-pages": "^4.0.0",
     "graphql": "^16.3.0",
     "graphql-request": "^4.1.0",
+    "js-yaml": "^4.1.0",
     "json-schema-merge-allof": "^0.8.1"
   }
 }

package.json

@@ -1,4 +1,5 @@
 import fs from "fs";
+import yaml from "js-yaml";
 import merger from "json-schema-merge-allof";
 import { dereferenceDocument } from "@open-rpc/schema-utils-js";
 
@@ -10,7 +11,7 @@ let methodFiles = fs.readdirSync(methodsBase);
 methodFiles.forEach(file => {
   console.log(file);
   let raw = fs.readFileSync(methodsBase + file);
-  let parsed = JSON.parse(raw);
+  let parsed = yaml.load(raw);
   methods = [
     ...methods,
     ...parsed,
@@ -23,7 +24,7 @@ let schemaFiles = fs.readdirSync(schemasBase);
 schemaFiles.forEach(file => {
   console.log(file);
   let raw = fs.readFileSync(schemasBase + file);
-  let parsed = JSON.parse(raw);
+  let parsed = yaml.load(raw);
   schemas = {
     ...schemas,
     ...parsed,

scripts/build.js

@@ -22,7 +22,7 @@ matrix:
         - pre
   - name: json schemas
     sources:
-      - 'src/**/*.json'
+      - 'src/**/*.yaml'
     aspell:
       lang: en
       d: en_US

spellcheck.yaml

@@ -0,0 +1,84 @@
+- name: eth_getBlockByHash
+  summary: Returns information about a block by hash.
+  params:
+    - name: Block hash
+      required: true
+      schema:
+        $ref: '#/components/schemas/hash32'
+    - name: Hydrated transactions
+      required: true
+      schema:
+        title: hydrated
+        type: boolean
+  result:
+    name: Block information
+    schema:
+      $ref: '#/components/schemas/Block'
+- name: eth_getBlockByNumber
+  summary: Returns information about a block by number.
+  params:
+    - name: Block
+      required: true
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+    - name: Hydrated transactions
+      required: true
+      schema:
+        title: hydrated
+        type: boolean
+  result:
+    name: Block information
+    schema:
+      $ref: '#/components/schemas/Block'
+- name: eth_getBlockTransactionCountByHash
+  summary: Returns the number of transactions in a block from a block matching the given block hash.
+  params:
+    - name: Block hash
+      schema:
+        $ref: '#/components/schemas/hash32'
+  result:
+    name: Transaction count
+    schema:
+      title: Transaction count
+      type: array
+      items:
+        $ref: '#/components/schemas/uint'
+- name: eth_getBlockTransactionCountByNumber
+  summary: Returns the number of transactions in a block matching the given block number.
+  params:
+    - name: Block
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+  result:
+    name: Transaction count
+    schema:
+      title: Transaction count
+      type: array
+      items:
+        $ref: '#/components/schemas/uint'
+- name: eth_getUncleCountByBlockHash
+  summary: Returns the number of uncles in a block from a block matching the given block hash.
+  params:
+    - name: Block hash
+      schema:
+        $ref: '#/components/schemas/hash32'
+  result:
+    name: Uncle count
+    schema:
+      title: Uncle count
+      type: array
+      items:
+        $ref: '#/components/schemas/uint'
+- name: eth_getUncleCountByBlockNumber
+  summary: Returns the number of transactions in a block matching the given block number.
+  params:
+    - name: Block
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+  result:
+    name: Uncle count
+    schema:
+      title: Uncle count
+      type: array
+      items:
+        $ref: '#/components/schemas/uint'

src/eth/block.json

@@ -0,0 +1,46 @@
+- name: eth_protocolVersion
+  summary: Returns the current Ethereum protocol version.
+  params: []
+  result:
+    name: Protocol version
+    schema:
+      title: version
+      type: string
+- name: eth_chainId
+  summary: Returns the chain ID of the current network.
+  params: []
+  result:
+    name: Chain ID
+    schema:
+      $ref: '#/components/schemas/uint'
+- name: eth_syncing
+  summary: Returns an object with data about the sync status or false.
+  params: []
+  result:
+    name: Syncing status
+    schema:
+      $ref: '#/components/schemas/SyncingStatus'
+- name: eth_coinbase
+  summary: Returns the client coinbase address.
+  params: []
+  result:
+    name: Coinbase address
+    schema:
+      $ref: '#/components/schemas/address'
+- name: eth_accounts
+  summary: Returns a list of addresses owned by client.
+  params: []
+  result:
+    name: Accounts
+    schema:
+      title: Accounts
+      type: array
+      items:
+        $ref: '#/components/schemas/address'
+- name: eth_blockNumber
+  summary: Returns the number of most recent block.
+  params: []
+  result:
+    name: Block number
+    schema:
+      $ref: '#/components/schemas/uint'