Merge pull request #400 from tanmay4l/ws-fix

fix: keep websocket request IDs within JSON-safe range

Author: HealthyBuilder

rpc/ws/client.go

@@ -170,10 +170,12 @@ func getUint64(data []byte, keys ...string) (val uint64, err error) {
 	if e != nil {
 		return 0, e
 	}
-	if t != jsonparser.Number {
-		return 0, fmt.Errorf("value is not a number: %s", string(v))
+	switch t {
+	case jsonparser.Number, jsonparser.String:
+		return strconv.ParseUint(string(v), 10, 64)
+	default:
+		return 0, fmt.Errorf("value is not a number/string: type=%d data=%s", t, string(v))
 	}
-	return strconv.ParseUint(string(v), 10, 64)
 }
 
 func getUint64WithOk(data []byte, path ...string) (uint64, bool) {

rpc/ws/types.go

@@ -20,7 +20,7 @@ package ws
 import (
 	stdjson "encoding/json"
 	"fmt"
-	"math/rand"
+	rand "math/rand/v2"
 	"net/http"
 	"time"
 )
@@ -32,15 +32,17 @@ type request struct {
 	ID      uint64 `json:"id"`
 }
 
+const maxJSONSafeInteger = uint64(1<<53 - 1)
+
 func newRequest(params []any, method string, configuration map[string]any, shortID bool) *request {
 	if params != nil && configuration != nil {
 		params = append(params, configuration)
 	}
 	var ID uint64
 	if !shortID {
-		ID = uint64(rand.Int63())
+		ID = rand.Uint64N(maxJSONSafeInteger + 1)
 	} else {
-		ID = uint64(rand.Int31())
+		ID = uint64(rand.Uint32N(1 << 31))
 	}
 	return &request{
 		Version: "2.0",

rpc/ws/types_test.go

@@ -0,0 +1,34 @@
+package ws
+
+import (
+	"math"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewRequest_IDWithinJSONSafeInteger(t *testing.T) {
+	for range 2_000 {
+		req := newRequest(nil, "slotSubscribe", nil, false)
+		require.LessOrEqual(t, req.ID, maxJSONSafeInteger)
+	}
+}
+
+func TestNewRequest_ShortIDWithinInt31(t *testing.T) {
+	for range 2_000 {
+		req := newRequest(nil, "slotSubscribe", nil, true)
+		require.LessOrEqual(t, req.ID, uint64(math.MaxInt32))
+	}
+}
+
+func TestGetUint64_AcceptsNumberAndString(t *testing.T) {
+	numberPayload := []byte(`{"id":3338220398172203928}`)
+	id, err := getUint64(numberPayload, "id")
+	require.NoError(t, err)
+	require.Equal(t, uint64(3338220398172203928), id)
+
+	stringPayload := []byte(`{"id":"3338220398172203928"}`)
+	id, err = getUint64(stringPayload, "id")
+	require.NoError(t, err)
+	require.Equal(t, uint64(3338220398172203928), id)
+}