receiptsRoot (#539)

* RLP encoding of receipts

* Build receiptsRoot

* Add firefly_getReceiptsRoot

* receiptsRoot tests

Author: gtrepta

tests/web3/firefly_getReceiptsRoot.expected.json

@@ -0,0 +1 @@
+[{"jsonrpc":"2.0","id":1,"result":true},{"jsonrpc":"2.0","id":2,"result":true},{"jsonrpc":"2.0","id":3,"result":"0x2c11d46cf3df0566ee4b6c49c8dcc1197ec796dbbf267b4d03eacd5ada85f469"},{"jsonrpc":"2.0","id":4,"result":{"receiptsRoot":"0x056b23fbba480696b65fe5a59b8f2148a1299103c4f57df839233af2cf4ca2d2"}}]

tests/web3/firefly_getReceiptsRoot.in.json

@@ -0,0 +1,37 @@
+[{
+    "jsonrpc":"2.0",
+    "id":1,
+    "method":"firefly_addAccount",
+    "params":[{
+        "key":"0xcdeac0dd5ec7c04072af48f2a4451e102a80ca5bb441a7b4d72c176cea61866e",
+        "balance":"0x56bc75e2d63100000"
+    }]
+},
+{
+    "jsonrpc":"2.0",
+    "id":2,
+    "method":"firefly_addAccount",
+    "params":[{
+        "key":"0xf9eaf090058471f8ddb294ddeae71ff056b631420e6bdce27d90f3c1a8c74124",
+        "balance":"0x56bc75e2d63100000"
+    }]
+},
+{
+  "jsonrpc": "2.0",
+  "id": 3,
+  "method": "eth_sendTransaction",
+  "params": [
+    {
+      "from": "0x911392821a6B8a3e0bD8078fC7403E04C3ad2416",
+      "to": "0x0093Ffb8D72408c1ab2547505A9914F0cF1F1298",
+      "value": "0x500",
+      "gasPrice": "0x4a817c800"
+    }
+  ]
+},
+{
+  "jsonrpc": "2.0",
+  "id": 4,
+  "method": "firefly_getReceiptsRoot",
+  "params": []
+}]

tests/web3/firefly_getReceiptsRootLog.expected.json

@@ -0,0 +1 @@
+[{"jsonrpc":"2.0","id":1,"result":true},{"jsonrpc":"2.0","id":2,"result":true},{"jsonrpc":"2.0","id":3,"result":"0xdb1def0efd9cf3bdceae1f04a32e92e0a84e921ef3a9cb22ea4a58f7836cd6fc"},{"jsonrpc":"2.0","id":4,"result":{"receiptsRoot":"0x86a171c58aac4ccaded4964d3c32649cd968d42b7fbf11cb10087e4bb65c5a6f"}}]

tests/web3/firefly_getReceiptsRootLog.in.json

@@ -0,0 +1,37 @@
+[{
+    "jsonrpc":"2.0",
+    "id":1,
+    "method":"firefly_addAccount",
+    "params":[{
+        "key":"0xcdeac0dd5ec7c04072af48f2a4451e102a80ca5bb441a7b4d72c176cea61866e",
+        "balance":"0x56bc75e2d63100000"
+    }]
+},
+{
+    "jsonrpc":"2.0",
+    "id":2,
+    "method":"firefly_addAccount",
+    "params":[{
+        "address":"0x116fe73b49c56e5e78f307e360a95760242d5fc1",
+        "code":"0x60806040523480156100115760006000fd5b50600436106100305760003560e01c80636d4ce63c1461003657610030565b60006000fd5b61003e610060565b604051808263ffffffff1663ffffffff16815260200191505060405180910390f35b60007f82cce92e3ae3d5367097cf20110c99ac1345c871cec5df94c0438746d353480c3033602a604051808473ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff1681526020018373ffffffffffffffffffffffffffffffffffffffff1673ffffffffffffffffffffffffffffffffffffffff168152602001828152602001935050505060405180910390a1602a905061010b565b9056fea265627a7a723158205e68d0e49a57e24f791b1fb1ead9612a2759953757912fceda99b775f7f8b8e364736f6c634300050b0032"
+    }]
+},
+{
+  "jsonrpc": "2.0",
+  "id": 3,
+  "method": "eth_sendTransaction",
+  "params": [
+    {
+      "from": "0x911392821a6B8a3e0bD8078fC7403E04C3ad2416",
+      "to": "0x116fe73b49c56e5e78f307e360a95760242d5fc1",
+      "data": "0x6d4ce63c",
+      "gasPrice": "0x4a817c800"
+    }
+  ]
+},
+{
+  "jsonrpc": "2.0",
+  "id": 4,
+  "method": "firefly_getReceiptsRoot",
+  "params": []
+}]

web3.md

@@ -321,6 +321,8 @@ WEB3 JSON RPC
          <method> "firefly_getStateRoot" </method>
     rule <k> #runRPCCall => #firefly_getTxRoot ... </k>
          <method> "firefly_getTxRoot" </method>
+    rule <k> #runRPCCall => #firefly_getReceiptsRoot ... </k>
+         <method> "firefly_getReceiptsRoot" </method>
 
     rule <k> #runRPCCall => #sendResponse( "error": {"code": -32601, "message": "Method not found"} ) ... </k> [owise]
 
@@ -1222,6 +1224,51 @@ Helper Funcs
            <sigS>       S       </sigS>
            <sigV>       V       </sigV>
          </message>
+
+    syntax String ::= #rlpEncodeReceipt( Int )       [function]
+                    | #rlpEncodeReceiptAux( String ) [function]
+ // -----------------------------------------------------------
+    rule #rlpEncodeReceipt( I ) => #rlpEncodeReceiptAux( "0x" +String #hashSignedTx( I ) )
+    rule [[ #rlpEncodeReceiptAux( TXHASH ) =>
+            #rlpEncodeLength(         #rlpEncodeWord( STATUS )
+                              +String #rlpEncodeWord( CGAS )
+                              +String #rlpEncodeString( #asString( BLOOM ) )
+                              +String #rlpEncodeLogs( LOGS )
+                            , 192
+                            )
+         ]]
+         <txReceipt>
+           <txHash> TXHASH </txHash>
+           <txCumulativeGas> CGAS   </txCumulativeGas>
+           <logSet>          LOGS   </logSet>
+           <bloomFilter>     BLOOM  </bloomFilter>
+           <txStatus>        STATUS </txStatus>
+         </txReceipt>
+
+    syntax String ::= #rlpEncodeLogs   ( List ) [function]
+                    | #rlpEncodeLogsAux( List ) [function]
+ // ------------------------------------------------------
+    rule #rlpEncodeLogs( .List ) => "\xc0"
+    rule #rlpEncodeLogs( LOGS )  => #rlpEncodeLength( #rlpEncodeLogsAux( LOGS ), 192 )
+      requires LOGS =/=K .List
+
+    rule #rlpEncodeLogsAux( .List ) => ""
+    rule #rlpEncodeLogsAux( ListItem({ ACCT | TOPICS | DATA }) LOGS )
+      => #rlpEncodeLength(         #rlpEncodeBytes( ACCT, 20 )
+                           +String #rlpEncodeTopics( TOPICS )
+                           +String #rlpEncodeString( #asString( DATA ) )
+                         , 192 )
+         +String #rlpEncodeLogsAux( LOGS )
+
+    syntax String ::= #rlpEncodeTopics   ( List ) [function]
+                    | #rlpEncodeTopicsAux( List ) [function]
+ // --------------------------------------------------------
+    rule #rlpEncodeTopics( .List )  => "\xc0"
+    rule #rlpEncodeTopics( TOPICS ) => #rlpEncodeLength( #rlpEncodeTopicsAux( TOPICS ), 192 )
+      requires TOPICS =/=K .List
+
+    rule #rlpEncodeTopicsAux( .List ) => ""
+    rule #rlpEncodeTopicsAux( ListItem( X:Int ) TOPICS ) => #rlpEncodeWord( X ) +String #rlpEncodeTopicsAux( TOPICS )
 ```
 
 State Root
@@ -1267,6 +1314,29 @@ Transactions Root
     syntax KItem ::= "#firefly_getTxRoot"
  // -------------------------------------
     rule <k> #firefly_getTxRoot => #sendResponse("result": { "transactionsRoot" : "0x" +String Keccak256( #rlpEncodeMerkleTree( #transactionsRoot ) ) } ) ... </k>
+```
+
+Receipts Root
+-------------
+
+```k
+    syntax MerkleTree ::= "#receiptsRoot" [function]
+ // ------------------------------------------------
+    rule #receiptsRoot => MerkleUpdateMap( .MerkleTree, #receiptsMap )
+
+    syntax Map ::= "#receiptsMap"         [function]
+                 | #receiptsMapAux( Int ) [function]
+ // ------------------------------------------------
+    rule #receiptsMap => #receiptsMapAux( 0 )
+
+    rule    #receiptsMapAux( _ ) => .Map [owise]
+    rule [[ #receiptsMapAux( I ) => #parseByteStackRaw( #rlpEncodeWord( I ) )[0 .. 1] |-> #rlpEncodeReceipt( { TXLIST[ I ] }:>Int ) #receiptsMapAux( I +Int 1 ) ]]
+         <txOrder> TXLIST </txOrder>
+      requires size(TXLIST) >Int I
+
+    syntax KItem ::= "#firefly_getReceiptsRoot"
+ // -------------------------------------------
+    rule <k> #firefly_getReceiptsRoot => #sendResponse("result": { "receiptsRoot" : "0x" +String Keccak256( #rlpEncodeMerkleTree( #receiptsRoot ) ) } ) ... </k>
 
 endmodule
 ```