tests: add comments in tests (#520)

tests/debug_getRawBlock/get-block-n.io

@@ -1,2 +1,3 @@
+// gets non-zero block
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawBlock","params":["0x3"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xf904a5f90240a0a111ce2477e1dd45173ba93cac819e62947e62a63a7d561b6f4825fb31c22645a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a038ea140fb8eb50f1ac65fd96a06f3aeb01687c7c94b0d48da364d44acc3d54dea0d299151ff63157c3f358980eb9f723bcf76a7cb44887ce7e16a84d23b2e14ae4a056a013758ed9d533148e72dc8c697d122c7d6478bd547154451138f4368f0e5fb9010000000000000000000000000000000000000000000000000000000000800000000000000000000000000000400000000000000000000000200000000000000000000000000000000000004000000000000200000000000000004000000000002000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000009000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000800384023f3e20830231141e80a0000000000000000000000000000000000000000000000000000000000000000088000000000000000084281d620da056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b4218302000080a0756e335a8778f6aadb2cc18c5bc68892da05a4d8b458eee5ce3335a024000c67f9025db8ff03f8fc870c72dd9d5e883e080184281d620e830186a0947dcd17433742f4c0ca53122ab541d0ba67fc27df038cdc4c8669df128318656d6974f85bf859947dcd17433742f4c0ca53122ab541d0ba67fc27dff842a00000000000000000000000000000000000000000000000000000000000000000a0462708a3c1cd03b21605715d090136df64e227f7e7792f74bb1bd7a8288f880183020000e1a0015a4cab4911426699ed34483de6640cf55a568afc5c5edffdcbd8bcd4452f6880a0478385a47075dd6ba56300b623038052a6e4bb03f8cfc53f367712f1c1d3e7dea02f79ed9b154b0af2c97ddfc1f4f76e6c17725713b6d44ea922ca4c6bbc20775cf8770984281d620e830186a0947dcd17433742f4c0ca53122ab541d0ba67fc27df028c3f446a7c4145b1f0656d69748718e5bb3abd10a0a0fd8bac0ee686dce51ee5b859b2f9f9b766506ba6d0ccee60673e432fa6674ad8a031f682f506513b51dc0ff7fe4ba430ba468e32f87c3a2ebfcaae58a48310267cb87002f86d870c72dd9d5e883e0a0184281d620e825208941f4924b14f34e24159387c0a4cdbaa32f3ddb0cf0180c001a0a67e1e78ee61a63035f53d7a18eba15970cfe134ae35aeec465720d9fafba4f2a064f465780b1a5b7d522c6442936cb18530621e6d65621bcfa600b57446569e3cb86f01f86c870c72dd9d5e883e0b84281d620e825208943ae75c08b4c907eb63a8960c45b86e1e9ab6123c0180c080a0dcd5ff27f05a587f811936ca3822fbaf1c72dd3d40561a9a7addd552868f52f4a043d2e24e037ec3b34ade0969b5cd7cdf03c96069630ea76e3cb355e464bc1517c0c0"}

tests/debug_getRawBlock/get-genesis.io

@@ -1,2 +1,3 @@
+// gets block 0
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawBlock","params":["0x0"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xf9024cf90246a00000000000000000000000000000000000000000000000000000000000000000a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a03f721d898239f0f78c63ec54498e1533ac29cdf335b5682a42f97d19b6e83e86a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000830200008084023f3e2080808968697665636861696ea00000000000000000000000000000000000000000000000000000000000000000880000000000000000843b9aca00a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b4218080a00000000000000000000000000000000000000000000000000000000000000000c0c0c0"}

tests/debug_getRawBlock/get-invalid-number.io

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

tests/debug_getRawHeader/get-block-n.io

@@ -1,2 +1,3 @@
+// gets non-zero block
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawHeader","params":["0x3"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xf90240a0a111ce2477e1dd45173ba93cac819e62947e62a63a7d561b6f4825fb31c22645a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a038ea140fb8eb50f1ac65fd96a06f3aeb01687c7c94b0d48da364d44acc3d54dea0d299151ff63157c3f358980eb9f723bcf76a7cb44887ce7e16a84d23b2e14ae4a056a013758ed9d533148e72dc8c697d122c7d6478bd547154451138f4368f0e5fb9010000000000000000000000000000000000000000000000000000000000800000000000000000000000000000400000000000000000000000200000000000000000000000000000000000004000000000000200000000000000004000000000002000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000009000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000800384023f3e20830231141e80a0000000000000000000000000000000000000000000000000000000000000000088000000000000000084281d620da056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b4218302000080a0756e335a8778f6aadb2cc18c5bc68892da05a4d8b458eee5ce3335a024000c67"}

tests/debug_getRawHeader/get-genesis.io

@@ -1,2 +1,3 @@
+// gets block 0
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawHeader","params":["0x0"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xf90246a00000000000000000000000000000000000000000000000000000000000000000a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347940000000000000000000000000000000000000000a03f721d898239f0f78c63ec54498e1533ac29cdf335b5682a42f97d19b6e83e86a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000830200008084023f3e2080808968697665636861696ea00000000000000000000000000000000000000000000000000000000000000000880000000000000000843b9aca00a056e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b4218080a00000000000000000000000000000000000000000000000000000000000000000"}

tests/debug_getRawHeader/get-invalid-number.io

@@ -1,2 +1,3 @@
+// gets block with invalid number formatting
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawHeader","params":["2"]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"invalid argument 0: hex string without 0x prefix"}}

tests/debug_getRawReceipts/get-block-n.io

@@ -1,2 +1,3 @@
+// gets receipts non-zero block
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawReceipts","params":["0x3"]}
 << {"jsonrpc":"2.0","id":1,"result":["0x03f901850182ca9cb9010000000000000000000000000000000000000000000000000000000000800000000000000000000000000000400000000000000000000000200000000000000000000000000000000000004000000000000200000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000009000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000f87cf87a947dcd17433742f4c0ca53122ab541d0ba67fc27dff842a000000000000000000000000000000000000000000000000000000000656d6974a0462708a3c1cd03b21605715d090136df64e227f7e7792f74bb1bd7a8288f8801a00000000000000000000000000000000000000000000000000000000000000002","0xf901860183018d04b9010000000000000000000000000000000000000000000000000000000000800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000004000000000000200000000000000004000000000002000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000000000000000009000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000200000000000000000000000000000000f87cf87a947dcd17433742f4c0ca53122ab541d0ba67fc27dff842a000000000000000000000000000000000000000000000000000000000656d6974a0b52248fb459b43720abbf1d5218c4ede9036a623653b31c2077991e04da9a456a00000000000000000000000000000000000000000000000000000000000000003","0x02f90109018301df0cb9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c0","0x01f901090183023114b9010000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c0"]}

tests/debug_getRawReceipts/get-genesis.io

@@ -1,2 +1,3 @@
+// gets receipts for block 0
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawReceipts","params":["0x0"]}
 << {"jsonrpc":"2.0","id":1,"result":[]}

tests/debug_getRawReceipts/get-invalid-number.io

@@ -1,2 +1,3 @@
+// gets receipts with invalid number formatting
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawReceipts","params":["2"]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"invalid argument 0: hex string without 0x prefix"}}

tests/debug_getRawTransaction/get-invalid-hash.io

@@ -1,2 +1,3 @@
+// gets tx with hash missing 0x prefix
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawTransaction","params":["1000000000000000000000000000000000000000000000000000000000000001"]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":-32602,"message":"invalid argument 0: json: cannot unmarshal hex string without 0x prefix into Go value of type common.Hash"}}

tests/debug_getRawTransaction/get-tx.io

@@ -1,2 +1,3 @@
+// gets tx rlp by hash
 >> {"jsonrpc":"2.0","id":1,"method":"debug_getRawTransaction","params":["0xbdb37c763e721bf1a0e94e0bc72db704110b2ccc6720713708744422a2cc95d6"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xf8948084342770c1830131ec8080b83c600d380380600d6000396000f360004381526020014681526020014181526020014881526020014481526020013281526020013481526020016000f38718e5bb3abd10a0a0df95c12446d276292221a19cca4f3e678f113a412bf3845bd85dc5bb5bd87defa00523b1712e2f5a7b421f5740d32f51fd33a525026a21fd89770a55480ad28732"}

tests/eth_blockNumber/simple-test.io

@@ -1,2 +1,3 @@
+// retrieves the client's current block number
 >> {"jsonrpc":"2.0","id":1,"method":"eth_blockNumber"}
 << {"jsonrpc":"2.0","id":1,"result":"0x14"}

tests/eth_call/call-callenv-options-eip1559.io

@@ -1,2 +1,5 @@
+// Performs a call to the callenv contract, which echoes the EVM transaction environment.
+// This call uses EIP1559 transaction options.
+// See https://github.com/ethereum/hive/tree/master/cmd/hivechain/contracts/callenv.eas for the output structure.
 >> {"jsonrpc":"2.0","id":1,"method":"eth_call","params":[{"from":"0x14e46043e63d0e3cdcf2530519f4cfaf35058cb2","gas":"0xea60","input":"0x333435","maxFeePerGas":"0x44103f3","maxPriorityFeePerGas":"0xb","to":"0x9344b07175800259691961298ca11c824e65032d","value":"0x17"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"result":"0x0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000c72dd9d5e883e000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000044103f2000000000000000000000000000000000000000000000000000000000000000000000000000000000000000014e46043e63d0e3cdcf2530519f4cfaf35058cb20000000000000000000000000000000000000000000000000000000000000017"}

tests/eth_call/call-callenv.io

@@ -1,2 +1,4 @@
+// Performs a call to the callenv contract, which echoes the EVM transaction environment.
+// See https://github.com/ethereum/hive/tree/master/cmd/hivechain/contracts/callenv.eas for the output structure.
 >> {"jsonrpc":"2.0","id":1,"method":"eth_call","params":[{"from":"0x0000000000000000000000000000000000000000","to":"0x9344b07175800259691961298ca11c824e65032d"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"result":"0x0000000000000000000000000000000000000000000000000000000000000014000000000000000000000000000000000000000000000000000c72dd9d5e883e00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"}

tests/eth_call/call-contract.io

@@ -1,2 +1,3 @@
+// performs a basic contract call with default settings
 >> {"jsonrpc":"2.0","id":1,"method":"eth_call","params":[{"from":"0x0000000000000000000000000000000000000000","input":"0xff01","to":"0x17e7eedce4ac02ef114a7ed9fe6e2f33feba1667"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"result":"0xffee"}

tests/eth_call/call-revert-abi-error.io

@@ -1,2 +1,3 @@
+// calls a contract that reverts with an ABI-encoded Error(string) value
 >> {"jsonrpc":"2.0","id":1,"method":"eth_call","params":[{"from":"0x0000000000000000000000000000000000000000","gas":"0x186a0","input":"0x01","to":"0x0ee3ab1371c93e7c0c281cc0c2107cdebc8b1930"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":3,"message":"execution reverted: user error","data":"0x08c379a00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000a75736572206572726f72"}}

tests/eth_call/call-revert-abi-panic.io

@@ -1,2 +1,3 @@
+// calls a contract that reverts with an ABI-encoded Panic(uint) value
 >> {"jsonrpc":"2.0","id":1,"method":"eth_call","params":[{"from":"0x0000000000000000000000000000000000000000","gas":"0x186a0","input":"0x00","to":"0x0ee3ab1371c93e7c0c281cc0c2107cdebc8b1930"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":3,"message":"execution reverted: assert(false)","data":"0x4e487b710000000000000000000000000000000000000000000000000000000000000001"}}

tests/eth_chainId/get-chain-id.io

@@ -1,2 +1,3 @@
+// retrieves the client's current chain id
 >> {"jsonrpc":"2.0","id":1,"method":"eth_chainId"}
 << {"jsonrpc":"2.0","id":1,"result":"0xc72dd9d5e883e"}

tests/eth_createAccessList/create-al-contract-eip1559.io

@@ -1,2 +1,4 @@
+// Creates an access list for a contract invocation that accesses storage.
+// This invocation uses EIP-1559 fields to specify the gas price.
 >> {"jsonrpc":"2.0","id":1,"method":"eth_createAccessList","params":[{"from":"0x0c2c51a0990aee1d73c1228de158688341557508","gas":"0xea60","input":"0x010203040506","maxFeePerGas":"0x44103f2","maxPriorityFeePerGas":"0x3","nonce":"0x0","to":"0x7dcd17433742f4c0ca53122ab541d0ba67fc27df"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"result":{"accessList":[{"address":"0x7dcd17433742f4c0ca53122ab541d0ba67fc27df","storageKeys":["0x0000000000000000000000000000000000000000000000000000000000000000","0x13a08e3cd39a1bc7bf9103f63f83273cced2beada9f723945176d6b983c65bd2"]}],"gasUsed":"0xca3c"}}

tests/eth_createAccessList/create-al-contract.io

@@ -1,2 +1,3 @@
+// creates an access list for a contract invocation that accesses storage
 >> {"jsonrpc":"2.0","id":1,"method":"eth_createAccessList","params":[{"from":"0x0c2c51a0990aee1d73c1228de158688341557508","gas":"0xea60","gasPrice":"0x44103f2","input":"0x010203040506","nonce":"0x0","to":"0x7dcd17433742f4c0ca53122ab541d0ba67fc27df"},"latest"]}
-<< {"jsonrpc":"2.0","id":1,"result":{"accessList":[{"address":"0x7dcd17433742f4c0ca53122ab541d0ba67fc27df","storageKeys":["0x13a08e3cd39a1bc7bf9103f63f83273cced2beada9f723945176d6b983c65bd2","0x0000000000000000000000000000000000000000000000000000000000000000"]}],"gasUsed":"0xca3c"}}
+<< {"jsonrpc":"2.0","id":1,"result":{"accessList":[{"address":"0x7dcd17433742f4c0ca53122ab541d0ba67fc27df","storageKeys":["0x0000000000000000000000000000000000000000000000000000000000000000","0x13a08e3cd39a1bc7bf9103f63f83273cced2beada9f723945176d6b983c65bd2"]}],"gasUsed":"0xca3c"}}

tests/eth_createAccessList/create-al-value-transfer.io

@@ -1,2 +1,3 @@
+// estimates a simple transfer
 >> {"jsonrpc":"2.0","id":1,"method":"eth_createAccessList","params":[{"from":"0x0c2c51a0990aee1d73c1228de158688341557508","nonce":"0x0","to":"0x0100000000000000000000000000000000000000","value":"0xa"},"latest"]}
 << {"jsonrpc":"2.0","id":1,"result":{"accessList":[],"gasUsed":"0x5208"}}

tests/eth_estimateGas/estimate-failed-call.io

@@ -1,2 +1,3 @@
+// estimates a contract call that reverts
 >> {"jsonrpc":"2.0","id":1,"method":"eth_estimateGas","params":[{"from":"0x0102030000000000000000000000000000000000","input":"0xff030405","to":"0x17e7eedce4ac02ef114a7ed9fe6e2f33feba1667"}]}
 << {"jsonrpc":"2.0","id":1,"error":{"code":3,"message":"execution reverted","data":"0x77726f6e672d63616c6c6461746173697a65"}}

tests/eth_estimateGas/estimate-simple-transfer.io

@@ -1,2 +1,3 @@
+// estimates a simple transfer
 >> {"jsonrpc":"2.0","id":1,"method":"eth_estimateGas","params":[{"from":"0xaa00000000000000000000000000000000000000","to":"0x0100000000000000000000000000000000000000"}]}
 << {"jsonrpc":"2.0","id":1,"result":"0x5208"}

tests/eth_estimateGas/estimate-successful-call.io

@@ -1,2 +1,5 @@
+// estimates a successful contract call
+// 
+// speconly: client response is only checked for schema validity.
 >> {"jsonrpc":"2.0","id":1,"method":"eth_estimateGas","params":[{"from":"0x0102030000000000000000000000000000000000","input":"0xff01","to":"0x17e7eedce4ac02ef114a7ed9fe6e2f33feba1667"}]}
 << {"jsonrpc":"2.0","id":1,"result":"0x5316"}

tests/eth_feeHistory/fee-history.io

@@ -1,2 +1,3 @@
+// gets fee history information
 >> {"jsonrpc":"2.0","id":1,"method":"eth_feeHistory","params":["0x1","0x2",[95,99]]}
 << {"jsonrpc":"2.0","id":1,"result":{"oldestBlock":"0x2","reward":[["0x1","0x1"]],"baseFeePerGas":["0x2dbf1f99","0x281d620d"],"gasUsedRatio":[0.007565458319646006]}}

tests/eth_getBalance/get-balance-blockhash.io

@@ -1,2 +1,3 @@
+// retrieves the an account's balance at a specific blockhash
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBalance","params":["0x7dcd17433742f4c0ca53122ab541d0ba67fc27df","0x2a6275cf6c145fef2429949e11f0db11f677c456e3f595c92d9b44d51196d50a"]}
 << {"jsonrpc":"2.0","id":1,"result":"0x1d"}

tests/eth_getBalance/get-balance-unknown-account.io

@@ -1,2 +1,3 @@
+// requests the balance of a non-existent account
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBalance","params":["0xc1cadaffffffffffffffffffffffffffffffffff","latest"]}
 << {"jsonrpc":"2.0","id":1,"result":"0x0"}

tests/eth_getBalance/get-balance.io

@@ -1,2 +1,3 @@
+// retrieves the an account balance
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBalance","params":["0x7dcd17433742f4c0ca53122ab541d0ba67fc27df","latest"]}
 << {"jsonrpc":"2.0","id":1,"result":"0x3f"}

tests/eth_getBlockByHash/get-block-by-empty-hash.io

@@ -1,2 +1,3 @@
+// gets block empty hash
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBlockByHash","params":["0x0000000000000000000000000000000000000000000000000000000000000000",true]}
 << {"jsonrpc":"2.0","id":1,"result":null}