tests: add tests for typed txs and receipts (ethereum#442)

* tests: add tests for typed txs and receipts

* eth: allow null result for tx and block methods

* eth: update

* eth: add names

* eth: Information

* eth: capitalize

* tests: add yParity in transactions

* schemas: allow null in transaction 'to'

* schemas: add newlines between definitions in transaction.yaml

* schemas: allow null in receipt 'to'

* schemas: add newline in receipt.yaml

* schemas: undo blank lines

* add type definition notFound

* fix indent

* fix build issue

* remove blank lines in eth spec

* rename results back

* undo capitalization

---------

Co-authored-by: Felix Lange <fjl@twurst.com>

Author: lightclient

src/eth/block.yaml

@@ -13,7 +13,9 @@
   result:
     name: Block information
     schema:
-      $ref: '#/components/schemas/Block'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $ref: '#/components/schemas/Block'
 - name: eth_getBlockByNumber
   summary: Returns information about a block by number.
   params:
@@ -29,7 +31,9 @@
   result:
     name: Block information
     schema:
-      $ref: '#/components/schemas/Block'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $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:
@@ -39,7 +43,10 @@
   result:
     name: Transaction count
     schema:
-      $ref: '#/components/schemas/uint'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - title: Transaction count
+          $ref: '#/components/schemas/uint'
 - name: eth_getBlockTransactionCountByNumber
   summary: Returns the number of transactions in a block matching the given block number.
   params:
@@ -49,7 +56,10 @@
   result:
     name: Transaction count
     schema:
-      $ref: '#/components/schemas/uint'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - title: Transaction count
+          $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:
@@ -59,7 +69,10 @@
   result:
     name: Uncle count
     schema:
-      $ref: '#/components/schemas/uint'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - title: Uncle count
+          $ref: '#/components/schemas/uint'
 - name: eth_getUncleCountByBlockNumber
   summary: Returns the number of transactions in a block matching the given block number.
   params:
@@ -69,4 +82,7 @@
   result:
     name: Uncle count
     schema:
-      $ref: '#/components/schemas/uint'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - title: Uncle count
+          $ref: '#/components/schemas/uint'

src/eth/transaction.yaml

@@ -8,7 +8,9 @@
   result:
     name: Transaction information
     schema:
-      $ref: '#/components/schemas/TransactionInfo'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $ref: '#/components/schemas/TransactionInfo'
 - name: eth_getTransactionByBlockHashAndIndex
   summary: Returns information about a transaction by block hash and transaction index position.
   params:
@@ -23,7 +25,9 @@
   result:
     name: Transaction information
     schema:
-      $ref: '#/components/schemas/TransactionInfo'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $ref: '#/components/schemas/TransactionInfo'
 - name: eth_getTransactionByBlockNumberAndIndex
   summary: Returns information about a transaction by block number and transaction index position.
   params:
@@ -38,7 +42,9 @@
   result:
     name: Transaction information
     schema:
-      $ref: '#/components/schemas/TransactionInfo'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $ref: '#/components/schemas/TransactionInfo'
 - name: eth_getTransactionReceipt
   summary: Returns the receipt of a transaction by transaction hash.
   params:
@@ -47,6 +53,8 @@
       schema:
         $ref: '#/components/schemas/hash32'
   result:
-    name: Receipt Information
+    name: Receipt information
     schema:
-      $ref: '#/components/schemas/ReceiptInfo'
+      oneOf:
+        - $ref: '#/components/schemas/notFound'
+        - $ref: '#/components/schemas/ReceiptInfo'

src/schemas/base-types.yaml

@@ -60,3 +60,6 @@ hash32:
   title: 32 byte hex value
   type: string
   pattern: ^0x[0-9a-f]{64}$
+notFound:
+  title: 'Not Found (null)'
+  type: 'null'

src/schemas/receipt.yaml

@@ -36,7 +36,7 @@ Log:
         $ref: '#/components/schemas/bytes32'
 ReceiptInfo:
   type: object
-  title: Receipt info
+  title: Receipt information
   required:
     - blockHash
     - blockNumber
@@ -71,7 +71,11 @@ ReceiptInfo:
     to:
       title: to
       description: Address of the receiver or null in a contract creation transaction.
-      $ref: '#/components/schemas/address'
+      oneOf:
+        - title: Contract Creation (null)
+          type: 'null'
+        - title: Recipient Address
+          $ref: '#/components/schemas/address'
     cumulativeGasUsed:
       title: cumulative gas used
       description: The sum of gas used by this transaction and all preceding transactions in the same block.

src/schemas/transaction.yaml

@@ -38,7 +38,11 @@ Transaction1559Unsigned:
       $ref: '#/components/schemas/uint'
     to:
       title: to address
-      $ref: '#/components/schemas/address'
+      oneOf:
+        - title: Contract Creation (null)
+          type: 'null'
+        - title: Address
+          $ref: '#/components/schemas/address'
     gas:
       title: gas limit
       $ref: '#/components/schemas/uint'
@@ -89,7 +93,11 @@ Transaction2930Unsigned:
       $ref: '#/components/schemas/uint'
     to:
       title: to address
-      $ref: '#/components/schemas/address'
+      oneOf:
+        - title: Contract Creation (null)
+          type: 'null'
+        - title: Address
+          $ref: '#/components/schemas/address'
     gas:
       title: gas limit
       $ref: '#/components/schemas/uint'
@@ -131,7 +139,11 @@ TransactionLegacyUnsigned:
       $ref: '#/components/schemas/uint'
     to:
       title: to address
-      $ref: '#/components/schemas/address'
+      oneOf:
+        - title: Contract Creation (null)
+          type: 'null'
+        - title: Address
+          $ref: '#/components/schemas/address'
     gas:
       title: gas limit
       $ref: '#/components/schemas/uint'
@@ -263,7 +275,11 @@ GenericTransaction:
       $ref: '#/components/schemas/uint'
     to:
       title: to address
-      $ref: '#/components/schemas/address'
+      oneOf:
+        - title: Contract Creation (null)
+          type: 'null'
+        - title: Address
+          $ref: '#/components/schemas/address'
     from:
       title: from address
       $ref: '#/components/schemas/address'
@@ -296,4 +312,3 @@ GenericTransaction:
       title: chainId
       description: Chain ID that this transaction is valid on.
       $ref: '#/components/schemas/uint'
-

tests/bad.rlp

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

tests/chain.rlp

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

tests/debug_getRawBlock/get-block-n.io

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