From 1ba7338b079168dbf3fe07052bd156843c614b09 Mon Sep 17 00:00:00 2001 From: Anna Shaleva Date: Tue, 30 Mar 2021 13:08:13 +0300 Subject: [PATCH] rpc: fix mpt-related responses serialisation MPT structures should be serialized in base64. --- pkg/rpc/response/result/mpt.go | 28 +++++++--------------------- pkg/rpc/response/result/mpt_test.go | 20 +++++++------------- pkg/rpc/server/server.go | 11 ++++------- pkg/rpc/server/server_test.go | 13 ++++++------- 4 files changed, 24 insertions(+), 48 deletions(-) diff --git a/pkg/rpc/response/result/mpt.go b/pkg/rpc/response/result/mpt.go index 10ef7e8c3..768c382fd 100644 --- a/pkg/rpc/response/result/mpt.go +++ b/pkg/rpc/response/result/mpt.go @@ -2,9 +2,8 @@ package result import ( "bytes" - "encoding/hex" + "encoding/base64" "encoding/json" - "errors" "github.com/nspcc-dev/neo-go/pkg/io" ) @@ -21,12 +20,6 @@ type ProofWithKey struct { Proof [][]byte } -// GetProof is a result of getproof RPC. -type GetProof struct { - Result ProofWithKey `json:"proof"` - Success bool `json:"success"` -} - // VerifyProof is a result of verifyproof RPC. // nil Value is considered invalid. type VerifyProof struct { @@ -40,7 +33,7 @@ func (p *ProofWithKey) MarshalJSON() ([]byte, error) { if w.Err != nil { return nil, w.Err } - return []byte(`"` + hex.EncodeToString(w.Bytes()) + `"`), nil + return []byte(`"` + base64.StdEncoding.EncodeToString(w.Bytes()) + `"`), nil } // EncodeBinary implements io.Serializable. @@ -74,12 +67,12 @@ func (p *ProofWithKey) UnmarshalJSON(data []byte) error { func (p *ProofWithKey) String() string { w := io.NewBufBinWriter() p.EncodeBinary(w.BinWriter) - return hex.EncodeToString(w.Bytes()) + return base64.StdEncoding.EncodeToString(w.Bytes()) } // FromString decodes p from hex-encoded string. func (p *ProofWithKey) FromString(s string) error { - rawProof, err := hex.DecodeString(s) + rawProof, err := base64.StdEncoding.DecodeString(s) if err != nil { return err } @@ -93,7 +86,7 @@ func (p *VerifyProof) MarshalJSON() ([]byte, error) { if p.Value == nil { return []byte(`"invalid"`), nil } - return []byte(`{"value":"` + hex.EncodeToString(p.Value) + `"}`), nil + return []byte(`"` + base64.StdEncoding.EncodeToString(p.Value) + `"`), nil } // UnmarshalJSON implements json.Unmarshaler. @@ -102,18 +95,11 @@ func (p *VerifyProof) UnmarshalJSON(data []byte) error { p.Value = nil return nil } - var m map[string]string + var m string if err := json.Unmarshal(data, &m); err != nil { return err } - if len(m) != 1 { - return errors.New("must have single key") - } - v, ok := m["value"] - if !ok { - return errors.New("invalid json") - } - b, err := hex.DecodeString(v) + b, err := base64.StdEncoding.DecodeString(m) if err != nil { return err } diff --git a/pkg/rpc/response/result/mpt_test.go b/pkg/rpc/response/result/mpt_test.go index 0db0bbc69..e328288f8 100644 --- a/pkg/rpc/response/result/mpt_test.go +++ b/pkg/rpc/response/result/mpt_test.go @@ -24,23 +24,17 @@ func testProofWithKey() *ProofWithKey { func TestGetProof_MarshalJSON(t *testing.T) { t.Run("Good", func(t *testing.T) { - p := &GetProof{ - Result: *testProofWithKey(), - Success: true, - } - testserdes.MarshalUnmarshalJSON(t, p, new(GetProof)) + p := testProofWithKey() + testserdes.MarshalUnmarshalJSON(t, p, new(ProofWithKey)) }) t.Run("Compatibility", func(t *testing.T) { - js := []byte(`{ - "proof" : "25ddeb9aa1bfc353c9c54e21dffb470f65d9c22a0662616c616e63654f70000000000000000708fd12020020666eaa8a6e75d43a97d76e72b605c7e05189f0c57ec19d84acdb75810f18239d202c83028ce3d7abcf4e4f95d05fbfdfa5e18bde3a8fbb65a57559d6b5ea09425c2090c40d440744a848e3b407a00e4efb692a957245a1efc9cb8496cb05fd328ee620dd2652bf25dfc3ad5fee7b200ccf3e3ae50772ff8ed58907e4dab8e7d4b2489720d8a5d5ed75b5b0f256d0a2cf5c220b4ddae2a228ef0fc0212b689f3811dfa94620342cc0d73fabd2440ed2cc735a9608391a510e1981b321a9f4258682706adc9620ced036e52f39387b9c58ade7bf8c3ca8959b64d8031d36d9b1c62f3f1c51c7cb2031072c7c801b5c1614dae441383a65344acd238f13db28ff0a39c0626e597f002062552d64c616d8b2a6a93d22936055110c0065728aa2b4fbf4d76b108390b474203322d3c93c741674a307cf6455e77c02ceeda307d4ec23fd809a2a420b4243f82052ab92a9cedc6716ad4c66a8a3e423b195b05bdebde456f992bff48f2561e99720e6379995e7053823b8ba8fb8af9623cf48e89f60c989598445df5e711db42a6f20192894ed637e86561ff6a4b8dea4539dee8bddb2fb20bf4ae3499852985c88b120e0005edd09f2335aa6b59ff4723e1262b2192adaa5e3e56f79e662f07041f04c2033577f3e2c5bb0e58746980a07cdfad2f872e2b9a10bcc27b7c678c85576df8420f0f04180d15b6eaa0c43e62380084c75ad773d790700a7120c6c4da1fc51693000fd720100209648e8f10a5ff4c209009b9a09697babbe1b2150d0948c1970a560282a1bfa4720988af8f34859dd8309bffea0b1dff9c8cef0b9b0d6a1852d40786627729ae7be00206ebf4f1b7861bca041cbb8feca75158511ca43a1810d17e1e3017468e8cef0de20cac93064090a7da09f8202c17d1e6cbb9a16eb43afcb032e80719cbf05b3446d2019b76a10b91fb99ec08814e8108e5490b879fb09a190cb2c129dfd98335bd5de000020b1da1198bacacf2adc0d863929d77c285ce3a26e736203d0c0a69a1312255fb2207ee8aa092f49348bd89f9c4bf004b0bee2241a2d0acfe7b3ce08e414b04a5717205b0dda71eac8a4e4cdc6a7b939748c0a78abb54f2547a780e6df67b25530330f000020fc358fb9d1e0d36461e015ac8e35f97072a9f9e750a3c25722a2b1a858fcb82d203c52c9fac6d4694b351390158334a9166bc3478ceb9bea2b0b244915f918239e20d526344a24ff19ee6a9f5c5beb833f4eb6d51191590350e26fa50b138493473f005200000000000000000000002077c404fec0a4265568951dbd096572787d109fab105213f4f292a5f53ce72fca00000020b8d1c7a386eaba83ce83ee0700d4ca9b86e75d147d670ea05123e438231d895000004801250b090a0a010b0f0c0305030c090c05040e02010d0f0f0b0407000f06050d090c02020a0006202af2097cf9d3f42e49f6b3c3dd254e7cbdab3485b029721cbbbf1ad0455a810852000000000000002055170506f4b18bc573a909b51cb21bdd5d303ec511f6cdfb1c6a1ab8d8a1dad020ee774c1b9fe1d8ea8d05823837d959da48af74f384d52f06c42c9d146c5258e300000000000000000072000000204457a6fe530ee953ad1f9caf63daf7f86719c9986df2d0b6917021eb379800f00020406bfc79da4ba6f37452a679d13cca252585d34f7e94a480b047bad9427f233e00000000201ce15a2373d28e0dc5f2000cf308f155d06f72070a29e5af1528c8f05f29d248000000000000004301200601060c0601060e06030605040f0700000000000000000000000000000000072091b83866bbd7450115b462e8d48601af3c3e9a35e7018d2b98a23e107c15c200090307000410a328e800", - "success" : true - }`) + js := []byte(`"Bfn///8SBiQBAQ8D6yfHa4wV24kQ9eXarzY5Bw55VFzysUbkJjrz5FipqkjSAAQEBAQEBAMcbFvhto6QJgYoJs/uzqTrZNrPxpkgNiF5Z/ME98copwPQ4q6ZqLA8S7XUXNCrJNF68vMu8Gx3W8Ooo3qwMomm0gQDiT6zHh/siCZ0c2bfBEymPmRNTiXSAKFIammjmnnBnJYD+CNwgcEzBJqYfnc7RMhr8cPhffKN0281w0M7XLQ9BO4D7W+t3cleDNdiNc6tqWR8jyIP+bolh5QnZIyKXPwGHjsEBAQDcpxkuWYJr6g3ilENTh1sztlZsXZvt6Eedmyy6kI2gQoEKQEGDw8PDw8PA33qzf1Q5ILAwmYxBnM2N80A8JtFHKR7UHhVEqo5nQ0eUgADbChDXdc7hSDZpD9xbhYGuJxVxRWqhsVRTR2dE+18gd4DG5gRFexXofB0aNb6G2kzQUSTD+aWVsfmnKGf4HHivzAEBAQEBAQEBAQEBAQEBARSAAQEA2IMPmRKP0b2BqhMB6IgtfpPeuXKJMdMze7Cr1TeJqbmA1vvqQgR5DN9ew+Zp/nc5SBQbjV5gEq7F/tIipWaQJ1hBAQEBAQEBAQEBAQEBAMCAR4="`) - var p GetProof + var p ProofWithKey require.NoError(t, json.Unmarshal(js, &p)) - require.Equal(t, 8, len(p.Result.Proof)) - for i := range p.Result.Proof { // smoke test that every chunk is correctly encoded node - r := io.NewBinReaderFromBuf(p.Result.Proof[i]) + require.Equal(t, 6, len(p.Proof)) + for i := range p.Proof { // smoke test that every chunk is correctly encoded node + r := io.NewBinReaderFromBuf(p.Proof[i]) var n mpt.NodeObject n.DecodeBinary(r) require.NoError(t, r.Err) diff --git a/pkg/rpc/server/server.go b/pkg/rpc/server/server.go index a39bb4612..053c6d570 100644 --- a/pkg/rpc/server/server.go +++ b/pkg/rpc/server/server.go @@ -905,7 +905,7 @@ func (s *Server) getProof(ps request.Params) (interface{}, *response.Error) { if err != nil { return nil, response.ErrInvalidParams } - key, err := ps.Value(2).GetBytesHex() + key, err := ps.Value(2).GetBytesBase64() if err != nil { return nil, response.ErrInvalidParams } @@ -915,12 +915,9 @@ func (s *Server) getProof(ps request.Params) (interface{}, *response.Error) { } skey := makeStorageKey(cs.ID, key) proof, err := s.chain.GetStateModule().GetStateProof(root, skey) - return &result.GetProof{ - Result: result.ProofWithKey{ - Key: skey, - Proof: proof, - }, - Success: err == nil, + return &result.ProofWithKey{ + Key: skey, + Proof: proof, }, nil } diff --git a/pkg/rpc/server/server_test.go b/pkg/rpc/server/server_test.go index 3e3ecd01b..37b43bbb0 100644 --- a/pkg/rpc/server/server_test.go +++ b/pkg/rpc/server/server_test.go @@ -1335,20 +1335,19 @@ func testRPCProtocol(t *testing.T, doRPCCall func(string, string, *testing.T) [] r, err := chain.GetStateModule().GetStateRoot(3) require.NoError(t, err) - rpc := fmt.Sprintf(`{"jsonrpc": "2.0", "id": 1, "method": "getproof", "params": ["%s", "%s", "%x"]}`, - r.Root.StringLE(), testContractHash, []byte("testkey")) + rpc := fmt.Sprintf(`{"jsonrpc": "2.0", "id": 1, "method": "getproof", "params": ["%s", "%s", "%s"]}`, + r.Root.StringLE(), testContractHash, base64.StdEncoding.EncodeToString([]byte("testkey"))) body := doRPCCall(rpc, httpSrv.URL, t) rawRes := checkErrGetResult(t, body, false) - res := new(result.GetProof) + res := new(result.ProofWithKey) require.NoError(t, json.Unmarshal(rawRes, res)) - require.True(t, res.Success) h, _ := util.Uint160DecodeStringLE(testContractHash) skey := makeStorageKey(chain.GetContractState(h).ID, []byte("testkey")) - require.Equal(t, skey, res.Result.Key) - require.True(t, len(res.Result.Proof) > 0) + require.Equal(t, skey, res.Key) + require.True(t, len(res.Proof) > 0) rpc = fmt.Sprintf(`{"jsonrpc": "2.0", "id": 1, "method": "verifyproof", "params": ["%s", "%s"]}`, - r.Root.StringLE(), res.Result.String()) + r.Root.StringLE(), res.String()) body = doRPCCall(rpc, httpSrv.URL, t) rawRes = checkErrGetResult(t, body, false) vp := new(result.VerifyProof)