feat: add last synced block to status endpoint result (#4710)

openapi/SwarmCommon.yaml

@@ -849,7 +849,7 @@ components:
         reserveSize:
           type: integer
         reserveSizeWithinRadius:
-          type: interger
+          type: integer
         pullsyncRate:
           type: number
         storageRadius:
@@ -865,6 +865,8 @@ components:
           type: integer
         isReachable:
           type: boolean
+        lastSyncedBlock:
+          type: integer
 
     StatusResponse:
       type: object

pkg/api/status.go

@@ -29,6 +29,7 @@ type statusSnapshotResponse struct {
 	RequestFailed           bool    `json:"requestFailed,omitempty"`
 	BatchCommitment         uint64  `json:"batchCommitment"`
 	IsReachable             bool    `json:"isReachable"`
+	LastSyncedBlock         uint64  `json:"lastSyncedBlock"`
 }
 
 type statusResponse struct {
@@ -82,6 +83,7 @@ func (s *Service) statusGetHandler(w http.ResponseWriter, _ *http.Request) {
 		NeighborhoodSize:        ss.NeighborhoodSize,
 		BatchCommitment:         ss.BatchCommitment,
 		IsReachable:             ss.IsReachable,
+		LastSyncedBlock:         ss.LastSyncedBlock,
 	})
 }
 
@@ -128,6 +130,7 @@ func (s *Service) statusGetPeersHandler(w http.ResponseWriter, r *http.Request)
 				snapshot.NeighborhoodSize = ss.NeighborhoodSize
 				snapshot.BatchCommitment = ss.BatchCommitment
 				snapshot.IsReachable = ss.IsReachable
+				snapshot.LastSyncedBlock = ss.LastSyncedBlock
 			}
 
 			mu.Lock()

pkg/api/status_test.go

@@ -12,6 +12,7 @@ import (
 	"github.com/ethersphere/bee/v2/pkg/jsonhttp"
 	"github.com/ethersphere/bee/v2/pkg/jsonhttp/jsonhttptest"
 	"github.com/ethersphere/bee/v2/pkg/log"
+	"github.com/ethersphere/bee/v2/pkg/postage"
 	"github.com/ethersphere/bee/v2/pkg/status"
 	"github.com/ethersphere/bee/v2/pkg/topology"
 )
@@ -36,6 +37,7 @@ func TestGetStatus(t *testing.T) {
 			NeighborhoodSize:        1,
 			BatchCommitment:         1,
 			IsReachable:             true,
+			LastSyncedBlock:         6092500,
 		}
 
 		ssMock := &statusSnapshotMock{
@@ -44,6 +46,7 @@ func TestGetStatus(t *testing.T) {
 			reserveSizeWithinRadius: ssr.ReserveSizeWithinRadius,
 			storageRadius:           ssr.StorageRadius,
 			commitment:              ssr.BatchCommitment,
+			chainState:              &postage.ChainState{Block: ssr.LastSyncedBlock},
 		}
 
 		statusSvc := status.NewService(
@@ -115,12 +118,14 @@ type statusSnapshotMock struct {
 	reserveSizeWithinRadius uint64
 	storageRadius           uint8
 	commitment              uint64
+	chainState              *postage.ChainState
 }
 
-func (m *statusSnapshotMock) SyncRate() float64           { return m.syncRate }
-func (m *statusSnapshotMock) ReserveSize() int            { return m.reserveSize }
-func (m *statusSnapshotMock) StorageRadius() uint8        { return m.storageRadius }
-func (m *statusSnapshotMock) Commitment() (uint64, error) { return m.commitment, nil }
+func (m *statusSnapshotMock) SyncRate() float64                  { return m.syncRate }
+func (m *statusSnapshotMock) ReserveSize() int                   { return m.reserveSize }
+func (m *statusSnapshotMock) StorageRadius() uint8               { return m.storageRadius }
+func (m *statusSnapshotMock) Commitment() (uint64, error)        { return m.commitment, nil }
+func (m *statusSnapshotMock) GetChainState() *postage.ChainState { return m.chainState }
 func (m *statusSnapshotMock) ReserveSizeWithinRadius() uint64 {
 	return m.reserveSizeWithinRadius
 }

pkg/postage/interface.go

@@ -42,7 +42,6 @@ type ChainSnapshot struct {
 // on the current (highest available) block.
 type Storer interface {
 	ChainStateGetter
-	CommitmentGetter
 
 	Radius() uint8
 
@@ -80,6 +79,7 @@ type CommitmentGetter interface {
 }
 
 type ChainStateGetter interface {
+	CommitmentGetter
 	// GetChainState returns the stored chain state from the store.
 	GetChainState() *ChainState
 }

pkg/status/internal/pb/status.proto

@@ -24,4 +24,5 @@ message Snapshot {
   uint64 BatchCommitment = 7;
   bool IsReachable = 8;
   uint64 ReserveSizeWithinRadius = 9;
+  uint64 LastSyncedBlock = 10;
 }

pkg/status/status.go

@@ -22,7 +22,7 @@ const loggerName = "status"
 
 const (
 	protocolName    = "status"
-	protocolVersion = "1.1.0"
+	protocolVersion = "1.1.1"
 	streamName      = "status"
 )
 
@@ -55,7 +55,7 @@ type Service struct {
 	beeMode    string
 	reserve    Reserve
 	sync       SyncReporter
-	commitment postage.CommitmentGetter
+	chainState postage.ChainStateGetter
 }
 
 // NewService creates a new status service.
@@ -64,15 +64,15 @@ func NewService(
 	streamer p2p.Streamer,
 	topology topologyDriver,
 	beeMode string,
-	commitment postage.CommitmentGetter,
+	chainState postage.ChainStateGetter,
 	reserve Reserve,
 ) *Service {
 	return &Service{
 		logger:         logger.WithName(loggerName).Register(),
 		streamer:       streamer,
 		topologyDriver: topology,
 		beeMode:        beeMode,
-		commitment:     commitment,
+		chainState:     chainState,
 		reserve:        reserve,
 	}
 }
@@ -98,7 +98,7 @@ func (s *Service) LocalSnapshot() (*Snapshot, error) {
 		syncRate = s.sync.SyncRate()
 	}
 
-	commitment, err := s.commitment.Commitment()
+	commitment, err := s.chainState.Commitment()
 	if err != nil {
 		return nil, fmt.Errorf("batchstore commitment: %w", err)
 	}
@@ -127,6 +127,7 @@ func (s *Service) LocalSnapshot() (*Snapshot, error) {
 		NeighborhoodSize:        neighborhoodSize + 1, // include self
 		BatchCommitment:         commitment,
 		IsReachable:             s.topologyDriver.IsReachable(),
+		LastSyncedBlock:         s.chainState.GetChainState().Block,
 	}, nil
 }
 
@@ -150,7 +151,6 @@ func (s *Service) PeerSnapshot(ctx context.Context, peer swarm.Address) (*Snapsh
 	if err := r.ReadMsgWithContext(ctx, ss); err != nil {
 		return nil, fmt.Errorf("read message failed: %w", err)
 	}
-
 	return (*Snapshot)(ss), nil
 }
 

pkg/status/status_test.go

@@ -13,6 +13,7 @@ import (
 	"github.com/ethersphere/bee/v2/pkg/log"
 	"github.com/ethersphere/bee/v2/pkg/p2p/protobuf"
 	"github.com/ethersphere/bee/v2/pkg/p2p/streamtest"
+	"github.com/ethersphere/bee/v2/pkg/postage"
 	"github.com/ethersphere/bee/v2/pkg/status"
 	"github.com/ethersphere/bee/v2/pkg/status/internal/pb"
 	"github.com/ethersphere/bee/v2/pkg/swarm"
@@ -31,6 +32,7 @@ func TestStatus(t *testing.T) {
 		BatchCommitment:  1024,
 		NeighborhoodSize: 1,
 		IsReachable:      true,
+		LastSyncedBlock:  6092500,
 	}
 
 	sssMock := &statusSnapshotMock{want}
@@ -104,13 +106,15 @@ func TestStatusLightNode(t *testing.T) {
 		BatchCommitment:  1024,
 		IsReachable:      true,
 		NeighborhoodSize: 1,
+		LastSyncedBlock:  6092500,
 	}
 
 	sssMock := &statusSnapshotMock{&pb.Snapshot{
 		ReserveSize:     100, // should be ignored
 		PullsyncRate:    100, // should be ignored
 		StorageRadius:   100, // should be ignored
 		BatchCommitment: 1024,
+		LastSyncedBlock: 6092500,
 	}}
 
 	peersIterMock := new(topologyPeersIterNoopMock)
@@ -193,6 +197,9 @@ func (m *statusSnapshotMock) SyncRate() float64           { return m.Snapshot.Pu
 func (m *statusSnapshotMock) ReserveSize() int            { return int(m.Snapshot.ReserveSize) }
 func (m *statusSnapshotMock) StorageRadius() uint8        { return uint8(m.Snapshot.StorageRadius) }
 func (m *statusSnapshotMock) Commitment() (uint64, error) { return m.Snapshot.BatchCommitment, nil }
+func (m *statusSnapshotMock) GetChainState() *postage.ChainState {
+	return &postage.ChainState{Block: m.Snapshot.LastSyncedBlock}
+}
 func (m *statusSnapshotMock) ReserveSizeWithinRadius() uint64 {
 	return m.Snapshot.ReserveSizeWithinRadius
 }