test(protocol): localstatequery using cardano blueprint tests (#1001)

Adds cardano-blueprint submodule that contains first examples of local
state query query and result data.

The included getSystemStart result example was generated using the
actual data type used by the haskell server implementation. To make the
example roundtrip, big integers (> int64) must be supported.

Signed-off-by: Sebastian Nagel <[email protected]>
Co-authored-by: Sebastian Nagel <[email protected]>

Author: wolf31o2

.github/workflows/go-test.yml

@@ -21,6 +21,8 @@ jobs:
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go-version }}

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "cardano-blueprint"]
+	path = cardano-blueprint
+	url = [email protected]:cardano-scaling/cardano-blueprint

cardano-blueprint

@@ -124,7 +124,9 @@ func testQuery(f *globalFlags) {
 			os.Exit(1)
 		}
 		fmt.Printf(
-			"system-start: year = %d, day = %d, picoseconds = %d\n",
+			// REVIEW: %d should work for big/Int, but warns and produces output
+			// like {%!d(bool=false) [2025]}
+			"system-start: year = %v, day = %d, picoseconds = %v\n",
 			systemStart.Year,
 			systemStart.Day,
 			systemStart.Picoseconds,

cmd/gouroboros/query.go

@@ -17,6 +17,7 @@ package localstatequery_test
 import (
 	"encoding/json"
 	"fmt"
+	"math/big"
 	"reflect"
 	"testing"
 	"time"
@@ -290,9 +291,9 @@ func TestGetUTxOByAddress(t *testing.T) {
 func TestGenesisConfigJSON(t *testing.T) {
 	genesisConfig := localstatequery.GenesisConfigResult{
 		Start: localstatequery.SystemStartResult{
-			Year:        2024,
+			Year:        *big.NewInt(2024),
 			Day:         35,
-			Picoseconds: 1234567890123456,
+			Picoseconds: *big.NewInt(1234567890123456),
 		},
 		NetworkMagic:      764824073,
 		NetworkId:         1,

protocol/localstatequery/client_test.go

@@ -16,6 +16,9 @@ package localstatequery
 
 import (
 	"encoding/hex"
+	"fmt"
+	"math/big"
+	"os"
 	"reflect"
 	"testing"
 
@@ -28,6 +31,7 @@ type testDefinition struct {
 	CborHex     string
 	Message     protocol.Message
 	MessageType uint
+	Result      interface{}
 }
 
 var tests = []testDefinition{
@@ -92,6 +96,26 @@ var tests = []testDefinition{
 		Message:     NewMsgReAcquireVolatileTip(),
 		MessageType: MessageTypeReacquireVolatileTip,
 	},
+	{
+		CborHex:     string(readFile("../../cardano-blueprint/src/api/examples/getSystemStart/query.cbor")),
+		Message:     NewMsgQuery(&SystemStartQuery{simpleQueryBase{Type: QueryTypeSystemStart}}),
+		MessageType: MessageTypeQuery,
+	},
+	{
+		CborHex: string(readFile("../../cardano-blueprint/src/api/examples/getSystemStart/result.cbor")),
+		Message: NewMsgResult(unsafeCbor(
+			SystemStartResult{
+				Year:        unsafeBigInt([]byte("703941703872597091335551638723343370661404331303175992839224705786473148")),
+				Day:         -4205646576720553090,
+				Picoseconds: unsafeBigInt([]byte("-554918151390414980540174869115975093799476848534297657333456993160799627")),
+			})),
+		MessageType: MessageTypeResult,
+		Result: SystemStartResult{
+			Year:        unsafeBigInt([]byte("703941703872597091335551638723343370661404331303175992839224705786473148")),
+			Day:         -4205646576720553090,
+			Picoseconds: unsafeBigInt([]byte("-554918151390414980540174869115975093799476848534297657333456993160799627")),
+		},
+	},
 }
 
 func TestDecode(t *testing.T) {
@@ -104,6 +128,23 @@ func TestDecode(t *testing.T) {
 		if err != nil {
 			t.Fatalf("failed to decode CBOR: %s", err)
 		}
+		// cast msg to MsgResult and further try to decode cbor
+		if m, ok := msg.(*MsgResult); ok && test.Result != nil {
+			var decoded = reflect.New(reflect.TypeOf(test.Result))
+			_, err := cbor.Decode(m.Result, decoded.Interface())
+			if err != nil {
+				t.Fatalf("failed to decode result: %s", err)
+			}
+			var actual = reflect.Indirect(decoded).Interface()
+			if !reflect.DeepEqual(actual, test.Result) {
+				t.Fatalf(
+					"MsgResult content did not decode to expected Result object\n  got:    %#v\n  wanted: %#v",
+					actual,
+					test.Result,
+				)
+			}
+		}
+
 		// Set the raw CBOR so the comparison should succeed
 		test.Message.SetCbor(cborData)
 		if m, ok := msg.(*MsgQuery); ok {
@@ -135,3 +176,30 @@ func TestEncode(t *testing.T) {
 		}
 	}
 }
+
+// Helper function to encode to cbor or panic
+func unsafeCbor(data interface{}) []byte {
+	cborData, err := cbor.Encode(data)
+	if err != nil {
+		panic(fmt.Sprintf("error encoding to CBOR: %s", err))
+	}
+	return cborData
+}
+
+func unsafeBigInt(text []byte) big.Int {
+	var i big.Int
+	err := i.UnmarshalText(text)
+	if err != nil {
+		panic(fmt.Sprintf("error unmarshalling text to big.Int: %s", err))
+	}
+	return i
+}
+
+// Helper function to allow inline reading of a file without capturing the error
+func readFile(path string) []byte {
+	data, err := os.ReadFile(path)
+	if err != nil {
+		panic(fmt.Sprintf("error reading file: %s", err))
+	}
+	return data
+}

protocol/localstatequery/messages_test.go

@@ -15,7 +15,9 @@
 package localstatequery
 
 import (
+	"encoding/json"
 	"fmt"
+	"math/big"
 
 	"github.com/blinklabs-io/gouroboros/cbor"
 	"github.com/blinklabs-io/gouroboros/ledger"
@@ -416,9 +418,40 @@ type SystemStartQuery struct {
 type SystemStartResult struct {
 	// Tells the CBOR decoder to convert to/from a struct and a CBOR array
 	_           struct{} `cbor:",toarray"`
-	Year        int
+	Year        big.Int
 	Day         int
-	Picoseconds uint64
+	Picoseconds big.Int
+}
+
+func (s SystemStartResult) String() string {
+	return fmt.Sprintf("SystemStart %s %d %s", s.Year.String(), s.Day, s.Picoseconds.String())
+}
+
+func (s SystemStartResult) MarshalJSON() ([]byte, error) {
+	return json.Marshal(struct {
+		Year        string `json:"year"`
+		Day         int    `json:"day"`
+		Picoseconds string `json:"picoseconds"`
+	}{
+		Year:        s.Year.String(),
+		Day:         s.Day,
+		Picoseconds: s.Picoseconds.String(),
+	})
+}
+
+func (s *SystemStartResult) UnmarshalJSON(data []byte) error {
+	var tmp struct {
+		Year        string `json:"year"`
+		Day         int    `json:"day"`
+		Picoseconds string `json:"picoseconds"`
+	}
+	if err := json.Unmarshal(data, &tmp); err != nil {
+		return err
+	}
+	s.Year.SetString(tmp.Year, 10)
+	s.Day = tmp.Day
+	s.Picoseconds.SetString(tmp.Picoseconds, 10)
+	return nil
 }
 
 type ChainBlockNoQuery struct {