Saving server state

Author: tilenflare

.gitignore

@@ -3,3 +3,8 @@ coverage.out
 
 # Logs
 /logs
+
+# build info
+PROJECT_BUILD_DATE
+PROJECT_COMMIT_HASH
+PROJECT_VERSION

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/bradleyjkemp/cupaloy v2.3.0+incompatible
 	github.com/ethereum/go-ethereum v1.13.15
 	github.com/flare-foundation/go-flare-common v0.1.4
-	github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20241205095200-c7bd102cb88a
+	github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20250107115534-4624a5839a95
 	github.com/pkg/errors v0.9.1
 	github.com/stretchr/testify v1.9.0
 )

go.sum

@@ -23,8 +23,8 @@ github.com/ethereum/go-ethereum v1.13.15 h1:U7sSGYGo4SPjP6iNIifNoyIAiNjrmQkz6EwQ
 github.com/ethereum/go-ethereum v1.13.15/go.mod h1:TN8ZiHrdJwSe8Cb6x+p0hs5CxhJZPbqB7hHkaUXcmIU=
 github.com/flare-foundation/go-flare-common v0.1.4 h1:h/Xn56QkFwKhBjBkfpWG0qfPoHcez+OJHXbplRE+Q9g=
 github.com/flare-foundation/go-flare-common v0.1.4/go.mod h1:Pb1OAtNe8jNsD2fh6syJD6kVdqxAAXWESTGgd7uQlME=
-github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20241205095200-c7bd102cb88a h1:emHRp5TYgAeicX/nCqPa5ngG7ggK7KaGrvk4wiglb4s=
-github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20241205095200-c7bd102cb88a/go.mod h1:Ae/btCPhOtXEWf8Ua9V90mArNV5XPErUusDm/dgelSA=
+github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20250107115534-4624a5839a95 h1:XWrVdT4OWDFWsixVw8Rfv5uUdQArRyaSKM1J6XWg+Cg=
+github.com/flare-foundation/verifier-indexer-framework v0.0.2-0.20250107115534-4624a5839a95/go.mod h1:Ae/btCPhOtXEWf8Ua9V90mArNV5XPErUusDm/dgelSA=
 github.com/holiman/uint256 v1.2.4 h1:jUc4Nk8fm9jZabQuqr2JzednajVmBpC+oiTiXZJEApU=
 github.com/holiman/uint256 v1.2.4/go.mod h1:EOMSn4q6Nyt9P6efbI3bueV4e1b3dGlUCXeiRV4ng7E=
 github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=

internal/xrp/xrp.go

@@ -42,23 +42,23 @@ type XRPClient struct {
 	Headers http.Header
 }
 
-type LedgerRequest struct {
-	Method string       `json:"method"`
-	Params []XRPParamas `json:"params"`
+type XRPRequest struct {
+	Method string        `json:"method"`
+	Params []interface{} `json:"params"`
 }
 
-type XRPParamas struct {
+type LedgerParams struct {
 	LedgerIndex  string `json:"ledger_index"`
 	Transactions bool   `json:"transactions"`
 	Expand       bool   `json:"expand"`
 	OwnerFunds   bool   `json:"owner_funds"`
 }
 
 type LedgerResponse struct {
-	Result XRPResult `json:"result"`
+	Result LedgerResult `json:"result"`
 }
 
-type XRPResult struct {
+type LedgerResult struct {
 	LedgerIndex uint64    `json:"ledger_index"`
 	LedgerHash  string    `json:"ledger_hash"`
 	Validated   bool      `json:"validated"`
@@ -101,21 +101,39 @@ type XRPFields struct {
 	Balance json.RawMessage `json:"Balance"`
 }
 
-var getLatestStruct LedgerRequest
+type ServerInfoRequest struct {
+	Method string `json:"method"`
+}
+
+type ServerInfoResponse struct {
+	Result ServerInfoResult `json:"result"`
+}
+
+type ServerInfoResult struct {
+	Info ServerInfo `json:"info"`
+}
+
+type ServerInfo struct {
+	BuildVersion string `json:"build_version"`
+	ServerState  string `json:"server_state"`
+}
+
+var getLatestParams LedgerParams
+var getServerState XRPRequest
 
 func init() {
-	getLatestStruct = LedgerRequest{
-		Method: "ledger",
-		Params: []XRPParamas{{
-			LedgerIndex:  "validated",
-			Transactions: false,
-			Expand:       false,
-			OwnerFunds:   false,
-		}},
+	getLatestParams = LedgerParams{
+		LedgerIndex:  "validated",
+		Transactions: false,
+		Expand:       false,
+		OwnerFunds:   false,
+	}
+	getServerState = XRPRequest{
+		Method: "server_info",
 	}
 }
 
-func (c XRPClient) GetLedgerResponse(ctx context.Context, request LedgerRequest) (*LedgerResponse, error) {
+func (c XRPClient) GetResponse(ctx context.Context, request XRPRequest) ([]byte, error) {
 	getReq, err := json.Marshal(request)
 	if err != nil {
 		return nil, err
@@ -144,6 +162,20 @@ func (c XRPClient) GetLedgerResponse(ctx context.Context, request LedgerRequest)
 		return nil, err
 	}
 
+	return resBody, nil
+}
+
+func (c XRPClient) GetLedgerResponse(ctx context.Context, params LedgerParams) (*LedgerResponse, error) {
+	request := XRPRequest{
+		Method: "ledger",
+		Params: []interface{}{params},
+	}
+
+	resBody, err := c.GetResponse(ctx, request)
+	if err != nil {
+		return nil, err
+	}
+
 	var respStruct LedgerResponse
 	err = json.Unmarshal(resBody, &respStruct)
 	if err != nil {
@@ -154,7 +186,7 @@ func (c XRPClient) GetLedgerResponse(ctx context.Context, request LedgerRequest)
 }
 
 func (c XRPClient) GetLatestBlockInfo(ctx context.Context) (*indexer.BlockInfo, error) {
-	respStruct, err := c.GetLedgerResponse(ctx, getLatestStruct)
+	respStruct, err := c.GetLedgerResponse(ctx, getLatestParams)
 	if err != nil {
 		return nil, err
 	}
@@ -166,16 +198,13 @@ func (c XRPClient) GetLatestBlockInfo(ctx context.Context) (*indexer.BlockInfo,
 }
 
 func (c XRPClient) GetBlockTimestamp(ctx context.Context, blockNum uint64) (uint64, error) {
-	getBlockStruct := LedgerRequest{
-		Method: "ledger",
-		Params: []XRPParamas{{
-			LedgerIndex:  strconv.Itoa(int(blockNum)),
-			Transactions: false,
-			Expand:       false,
-			OwnerFunds:   false,
-		}},
+	getBlockParams := LedgerParams{
+		LedgerIndex:  strconv.Itoa(int(blockNum)),
+		Transactions: false,
+		Expand:       false,
+		OwnerFunds:   false,
 	}
-	respStruct, err := c.GetLedgerResponse(ctx, getBlockStruct)
+	respStruct, err := c.GetLedgerResponse(ctx, getBlockParams)
 	if err != nil {
 		return 0, err
 	}
@@ -185,16 +214,13 @@ func (c XRPClient) GetBlockTimestamp(ctx context.Context, blockNum uint64) (uint
 
 func (c XRPClient) GetBlockResult(ctx context.Context, blockNum uint64,
 ) (*indexer.BlockResult[Block, Transaction], error) {
-	getBlockStruct := LedgerRequest{
-		Method: "ledger",
-		Params: []XRPParamas{{
-			LedgerIndex:  strconv.Itoa(int(blockNum)),
-			Transactions: true,
-			Expand:       true,
-			OwnerFunds:   false,
-		}},
+	getBlockParams := LedgerParams{
+		LedgerIndex:  strconv.Itoa(int(blockNum)),
+		Transactions: true,
+		Expand:       true,
+		OwnerFunds:   false,
 	}
-	respStruct, err := c.GetLedgerResponse(ctx, getBlockStruct)
+	respStruct, err := c.GetLedgerResponse(ctx, getBlockParams)
 	if err != nil {
 		return nil, err
 	}
@@ -329,3 +355,17 @@ func sourceAddressesRoot(tx XRPTransaction) (string, error) {
 
 	return "", nil
 }
+
+func (c XRPClient) GetServerInfo(ctx context.Context) (string, error) {
+	resBody, err := c.GetResponse(ctx, getServerState)
+	if err != nil {
+		return "", err
+	}
+	var respStruct ServerInfoResponse
+	err = json.Unmarshal(resBody, &respStruct)
+	if err != nil {
+		return "", err
+	}
+
+	return respStruct.Result.Info.BuildVersion + "_" + respStruct.Result.Info.ServerState, nil
+}

internal/xrp/xrp_test.go

@@ -2,6 +2,7 @@ package xrp_test
 
 import (
 	"context"
+	"strconv"
 	"testing"
 	"time"
 
@@ -61,3 +62,18 @@ func TestGetBlockResult(t *testing.T) {
 
 	cupaloy.SnapshotT(t, blockResult)
 }
+
+func TestGetServerInfo(t *testing.T) {
+	cfg := xrp.Config{"https://s.altnet.rippletest.net:51234"}
+
+	chainClient, err := xrp.New(&cfg)
+	require.NoError(t, err)
+
+	ctx, cancelFunc := context.WithTimeout(context.Background(), 3*time.Second)
+	serverInfo, err := chainClient.GetServerInfo(ctx)
+	cancelFunc()
+	require.NoError(t, err)
+
+	_, err = strconv.Atoi(serverInfo[0:1])
+	require.NoError(t, err)
+}