Use canonical json for JSON RPC request and response marshaling (#1610)

* Use cannonical json for jsonrpc2 request&response marshalling

* Update tests

Author: DeividasK

go.mod

@@ -12,6 +12,7 @@ require (
 	github.com/dominikbraun/graph v0.23.0
 	github.com/fxamacker/cbor/v2 v2.7.0
 	github.com/gagliardetto/utilz v0.1.3
+	github.com/gibson042/canonicaljson-go v1.0.3
 	github.com/go-json-experiment/json v0.0.0-20250223041408-d3c622f1b874
 	github.com/go-playground/validator/v10 v10.26.0
 	github.com/go-viper/mapstructure/v2 v2.4.0

go.sum

@@ -68,6 +68,8 @@ github.com/gabriel-vasile/mimetype v1.4.8/go.mod h1:ByKUIKGjh1ODkGM1asKUbQZOLGrP
 github.com/gagliardetto/hashsearch v0.0.0-20191005111333-09dd671e19f9/go.mod h1:513DXpQPzeRo7d4dsCP3xO3XI8hgvruMl9njxyQeraQ=
 github.com/gagliardetto/utilz v0.1.3 h1:A+asc+6/3a9qNBrgticApj3yW5F7y4TaJd8Ijg+o0zM=
 github.com/gagliardetto/utilz v0.1.3/go.mod h1:b+rGFkRHz3HWJD0RYMzat47JyvbTtpE0iEcYTRJTLLA=
+github.com/gibson042/canonicaljson-go v1.0.3 h1:EAyF8L74AWabkyUmrvEFHEt/AGFQeD6RfwbAuf0j1bI=
+github.com/gibson042/canonicaljson-go v1.0.3/go.mod h1:DsLpJTThXyGNO+KZlI85C1/KDcImpP67k/RKVjcaEqo=
 github.com/go-json-experiment/json v0.0.0-20250223041408-d3c622f1b874 h1:F8d1AJ6M9UQCavhwmO6ZsrYLfG8zVFWfEfMS2MXPkSY=
 github.com/go-json-experiment/json v0.0.0-20250223041408-d3c622f1b874/go.mod h1:TiCD2a1pcmjd7YnhGH0f/zKNcCD06B029pHhzV23c2M=
 github.com/go-kit/log v0.1.0/go.mod h1:zbhenjAZHb184qTLMA9ZjW7ThYL0H2mk7Q6pNt4vbaY=

pkg/jsonrpc2/types.go

@@ -6,6 +6,8 @@ import (
 	"encoding/json"
 	"fmt"
 	"strings"
+
+	canonicaljson "github.com/gibson042/canonicaljson-go"
 )
 
 const (
@@ -59,9 +61,9 @@ func (r *Request[Params]) ServiceName() string {
 }
 
 // Digest returns a digest of the request. This is used for signature verification.
-// The digest is a SHA256 hash of the JSON string of the request.
+// The digest is a SHA256 hash of the canonical JSON string of the request excluding the auth field.
 func (r *Request[Params]) Digest() (string, error) {
-	canonicalJSONBytes, err := json.Marshal(Request[Params]{
+	canonicalJSONBytes, err := canonicaljson.Marshal(Request[Params]{
 		Version: r.Version,
 		ID:      r.ID,
 		Method:  r.Method,
@@ -87,8 +89,10 @@ type Response[Result any] struct {
 	Error   *WireError `json:"error,omitempty"`
 }
 
+// Digest returns a digest of the response. This is used for signature verification.
+// The digest is a SHA256 hash of the canonical JSON string of the response.
 func (r *Response[Result]) Digest() (string, error) {
-	canonicalJSONBytes, err := json.Marshal(r)
+	canonicalJSONBytes, err := canonicaljson.Marshal(r)
 	if err != nil {
 		return "", fmt.Errorf("error marshaling JSON: %w", err)
 	}

pkg/jsonrpc2/types_test.go

@@ -26,7 +26,7 @@ func TestTypes(t *testing.T) {
 		}
 		digest, err := req.Digest()
 		require.NoError(t, err)
-		require.Equal(t, "01025753dbedc82b0771489d77f87b4fe8bbe7255be218caafce6704cc4b45a6", digest)
+		require.Equal(t, "0d390d82191fcc4fe7b321124f55e3880bf3f754c725d10bcc0668cebf6a6ded", digest)
 	})
 
 	t.Run("Request.Digest - JSON marshal error", func(t *testing.T) {
@@ -47,7 +47,7 @@ func TestTypes(t *testing.T) {
 
 		digest, err := req.Digest()
 		require.Error(t, err)
-		require.Equal(t, "error marshaling JSON: json: unsupported type: chan string", err.Error())
+		require.Equal(t, "error marshaling JSON: canonicaljson: unsupported type: chan string", err.Error())
 		require.Empty(t, digest)
 	})
 
@@ -79,7 +79,7 @@ func TestResponseDigest(t *testing.T) {
 		digest, err := resp.Digest()
 		require.NoError(t, err)
 		require.NotEmpty(t, digest)
-		require.Equal(t, "4d255b455d6394594ea08abb31f02cbc09d6a33b84cb9617edb34d5b489e46a9", digest)
+		require.Equal(t, "b2915f4ca34315c3cade73ce8e1d69225d3512550a12819374e287ed8327ba25", digest)
 	})
 
 	t.Run("Response.Digest - with error", func(t *testing.T) {
@@ -95,7 +95,7 @@ func TestResponseDigest(t *testing.T) {
 		digest, err := resp.Digest()
 		require.NoError(t, err)
 		require.NotEmpty(t, digest)
-		require.Equal(t, "71f971121945d17b6f32a486ebfc2576c1eaf6d26e46987af46c898fc7fa9166", digest)
+		require.Equal(t, "a8e6e0e131f05fc98fedc4826550a13bbdeb93b01bd9b97aa462a2411860e7d9", digest)
 	})
 
 	t.Run("Response.Digest - JSON marshal error", func(t *testing.T) {