Standardize debug namespace (#247)

* add debug namespace

* fix typo

* capitalize rlp

* make receipts plural

* remove set head

* clarify receipt encoding

* add raw prefix

* add tests for debug methods

* add debug_getRawTransaction

* add bad block for tests

Author: lightclient

package.json

@@ -5,9 +5,9 @@
   "main": "index.js",
   "type": "module",
   "scripts": {
-    "build": "npm run clean && npm run build:spec && npm run generate-clients",
+    "build": "npm run build:spec",
     "build:spec": "node scripts/build.js",
-    "build:docs": "cd build/docs/gatsby && npm install --legacy-peer-deps && gatsby build --prefix-paths",
+    "build:docs": "mkdir -p build && npm run generate-clients && cd build/docs/gatsby && npm install --legacy-peer-deps && gatsby build --prefix-paths",
     "lint": "node scripts/build.js && node scripts/validate.js && node scripts/graphql-validate.js",
     "clean": "rm -rf build && mkdir -p build",
     "generate-clients": "open-rpc-generator generate -c open-rpc-generator-config.json",

scripts/build.js

@@ -18,6 +18,18 @@ methodFiles.forEach(file => {
   ];
 });
 
+methodsBase = "src/debug/";
+methodFiles = fs.readdirSync(methodsBase);
+methodFiles.forEach(file => {
+  console.log(file);
+  let raw = fs.readFileSync(methodsBase + file);
+  let parsed = yaml.load(raw);
+  methods = [
+    ...methods,
+    ...parsed,
+  ];
+});
+
 let schemas = {};
 let schemasBase = "src/schemas/"
 let schemaFiles = fs.readdirSync(schemasBase);

src/debug/getters.yaml

@@ -0,0 +1,57 @@
+- name: debug_getRawHeader
+  summary: Returns an RLP-encoded header.
+  params:
+    - name: Block
+      required: true
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+  result:
+    name: Header RLP
+    schema:
+      $ref: '#/components/schemas/bytes'
+- name: debug_getRawBlock
+  summary: Returns an RLP-encoded block.
+  params:
+    - name: Block
+      required: true
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+  result:
+    name: Block RLP
+    schema:
+      $ref: '#/components/schemas/bytes'
+- name: debug_getRawTransaction
+  summary: Returns an array of EIP-2718 binary-encoded transactions.
+  params:
+    - name: Transaction hash
+      required: true
+      schema:
+        $ref: '#/components/schemas/hash32'
+  result:
+    name: EIP-2718 binary-encoded transaction
+    schema:
+      $ref: '#/components/schemas/bytes'
+- name: debug_getRawReceipts
+  summary: Returns an array of EIP-2718 binary-encoded receipts.
+  params:
+    - name: Block
+      required: true
+      schema:
+        $ref: '#/components/schemas/BlockNumberOrTag'
+  result:
+    name: Receipts
+    schema:
+      title: Receipt array
+      type: array
+      items:
+        $ref: '#/components/schemas/bytes'
+- name: debug_getBadBlocks
+  summary: Returns an array of recent bad blocks that the client has seen on the network.
+  params: []
+  result:
+    name: Blocks
+    schema:
+      title: Bad block array
+      type: array
+      items:
+        $ref: '#/components/schemas/BadBlock'

src/schemas/base-types.yaml

@@ -38,7 +38,7 @@ uint:
 uint64:
   title: hex encoded unsigned integer
   type: string
-  pattern: ^0x([1-9a-f][0-9a-f]{0,31})|0$
+  pattern: ^0x([1-9a-f][0-9a-f]{0,15})|0$
 uint256:
   title: hex encoded unsigned integer
   type: string

src/schemas/block.yaml

@@ -106,3 +106,20 @@ BlockNumberOrTag:
       $ref: '#/components/schemas/uint'
     - title: Block tag
       $ref: '#/components/schemas/BlockTag'
+BadBlock:
+  title: Bad block
+  type: object
+  required:
+    - block
+    - hash
+    - rlp
+  properties:
+    block:
+      title: Block
+      $ref: '#/components/schemas/bytes'
+    hash:
+      title: Hash
+      $ref: '#/components/schemas/hash32'
+    rlp:
+      title: RLP
+      $ref: '#/components/schemas/bytes'

tests/bad.rlp

@@ -0,0 +1,2 @@
+>> {"jsonrpc":"2.0","id":5,"method":"debug_getRawBlock","params":["0x3"]}
+<< {"jsonrpc":"2.0","id":5,"result":"0xf90269f901faa087a74234d5ad70c6ff8e89ffd305fa85048e6cbb4045d66b43a7bf03fe9b6171a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a09ba750cfccbb3e45e010229e805d1d854befeb2701745e93f975dbc965f737a5a0d911c25e97e27898680d242b7780b6faef30995c355a2d5de92e6b9a7212ad3aa0056b23fbba480696b65fe5a59b8f2148a1299103c4f57df839233af2cf4ca2d2b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008302000003834c4b408252081e80a00b43d19e6220dd7b4e8018a5046283377354ab021f49cdd082dfe167c86502fe8836a52bdb03334a2d842806be9df869f86702842806be9e82520894658bdf435d810c91414ec09147daa6db624063798203e880820a95a040ce7918eeb045ebf8c8b1887ca139d076bda00fa828a07881d442a72626c42da0156576a68e456e295e4c9cf67cf9f53151f329438916e0f24fc69d6bbb7fbacfc0"}

tests/debug_getRawBlock/get-block-n.io

@@ -0,0 +1,2 @@
+>> {"jsonrpc":"2.0","id":4,"method":"debug_getRawBlock","params":["0x0"]}
+<< {"jsonrpc":"2.0","id":4,"result":"0xf901faf901f5a00000000000000000000000000000000000000000000000000000000000000000a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a0078dc6061b1d8eaa8493384b59c9c65ceb917201221d08b80c4de6770b6ec7e7a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000180834c4b40808080a00000000000000000000000000000000000000000000000000000000000000000880000000000000000843b9aca00c0c0"}

tests/debug_getRawBlock/get-genesis.io

@@ -0,0 +1,2 @@
+>> {"jsonrpc":"2.0","id":6,"method":"debug_getRawBlock","params":["2"]}
+<< {"jsonrpc":"2.0","id":6,"error":{"code":-32602,"message":"invalid argument 0: hex string without 0x prefix"}}

tests/debug_getRawBlock/get-invalid-number.io

@@ -0,0 +1,2 @@
+>> {"jsonrpc":"2.0","id":2,"method":"debug_getRawHeader","params":["0x3"]}
+<< {"jsonrpc":"2.0","id":2,"result":"0xf901faa087a74234d5ad70c6ff8e89ffd305fa85048e6cbb4045d66b43a7bf03fe9b6171a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a09ba750cfccbb3e45e010229e805d1d854befeb2701745e93f975dbc965f737a5a0d911c25e97e27898680d242b7780b6faef30995c355a2d5de92e6b9a7212ad3aa0056b23fbba480696b65fe5a59b8f2148a1299103c4f57df839233af2cf4ca2d2b90100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000008302000003834c4b408252081e80a00b43d19e6220dd7b4e8018a5046283377354ab021f49cdd082dfe167c86502fe8836a52bdb03334a2d842806be9d"}