vm, api: add smesherID to rewards (#5199)

## Motivation See #4863 Based on #4850 Closes #4529 Closes #4850 Closes #4863 Closes #4964 Closes #5183 ## Changes - Refactors `rewards` table. Adds smesherID column, migrates data. Does not update old data (smesherID will be NULL for old data, unless resynced). - Updates database queries. - Returns smesherID in all API queries Co-authored-by: Piers Powlesland <[email protected]> Co-authored-by: piersy <[email protected]> Co-authored-by: Dmitry Shulyak <[email protected]>
spacemeshos · Dec 2, 2023 · d424b78 · d424b78
1 parent 3ae2bf3
commit d424b78
Show file tree

Hide file tree

Showing 23 changed files with 496 additions and 151 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,13 @@ See [RELEASE](./RELEASE.md) for workflow instructions.
 
 ### Improvements
 
+* [#5199](https://github.com/spacemeshos/go-spacemesh/pull/5199) Adds smesherID to rewards table. Historically rewards
+  were keyed by (coinbase, layer). Now the primary key has changed to (smesherID, layer), which allows querying rewards
+  by any subset of layer, smesherID, and coinbase. While this change does add smesherID to existing API endpoints
+  (`GlobalStateService.{AccountDataQuery,AccountDataStream,GlobalStateStream}`), it does not yet expose an endpoint to
+  query rewards by smesherID. Additionally, it does not re-index old data. Rewards will contain smesherID going forward,
+  but to refresh data for all rewards, a node will have to delete its database and resync from genesis.
+
 ## 1.3.0
 
 ### Upgrade information

diff --git a/api/grpcserver/globalstate_service.go b/api/grpcserver/globalstate_service.go
@@ -143,7 +143,7 @@ func (s GlobalStateService) AccountDataQuery(
 	// if filterTxReceipt {}
 
 	if filterReward {
-		dbRewards, err := s.mesh.GetRewards(addr)
+		dbRewards, err := s.mesh.GetRewardsByCoinbase(addr)
 		if err != nil {
 			return nil, status.Errorf(codes.Internal, "error getting rewards data")
 		}
@@ -153,10 +153,8 @@ func (s GlobalStateService) AccountDataQuery(
 					Layer:       &pb.LayerNumber{Number: r.Layer.Uint32()},
 					Total:       &pb.Amount{Value: r.TotalReward},
 					LayerReward: &pb.Amount{Value: r.LayerReward},
-					// Leave this out for now as this is changing
-					// See https://github.com/spacemeshos/go-spacemesh/issues/2275
-					// LayerComputed: 0,
-					Coinbase: &pb.AccountId{Address: addr.String()},
+					Coinbase:    &pb.AccountId{Address: addr.String()},
+					Smesher:     &pb.SmesherId{Id: r.SmesherID[:]},
 				},
 			}})
 		}
@@ -291,10 +289,8 @@ func (s GlobalStateService) AccountDataStream(
 						Layer:       &pb.LayerNumber{Number: reward.Layer.Uint32()},
 						Total:       &pb.Amount{Value: reward.Total},
 						LayerReward: &pb.Amount{Value: reward.LayerReward},
-						// Leave this out for now as this is changing
-						// See https://github.com/spacemeshos/go-spacemesh/issues/2275
-						// LayerComputed: 0,
-						Coinbase: &pb.AccountId{Address: addr.String()},
+						Coinbase:    &pb.AccountId{Address: addr.String()},
+						Smesher:     &pb.SmesherId{Id: reward.SmesherID[:]},
 					},
 				}}}
 				if err := stream.Send(resp); err != nil {
@@ -424,10 +420,8 @@ func (s GlobalStateService) GlobalStateStream(
 					Layer:       &pb.LayerNumber{Number: reward.Layer.Uint32()},
 					Total:       &pb.Amount{Value: reward.Total},
 					LayerReward: &pb.Amount{Value: reward.LayerReward},
-					// Leave this out for now as this is changing
-					// See https://github.com/spacemeshos/go-spacemesh/issues/2275
-					// LayerComputed: 0,
-					Coinbase: &pb.AccountId{Address: reward.Coinbase.String()},
+					Coinbase:    &pb.AccountId{Address: reward.Coinbase.String()},
+					Smesher:     &pb.SmesherId{Id: reward.SmesherID[:]},
 				},
 			}}}
 			if err := stream.Send(resp); err != nil {

diff --git a/api/grpcserver/globalstate_service_test.go b/api/grpcserver/globalstate_service_test.go
@@ -100,7 +100,7 @@ func TestGlobalStateService(t *testing.T) {
 		t.Parallel()
 		c, ctx := setupGlobalStateService(t)
 
-		c.meshAPI.EXPECT().GetRewards(addr1).Return([]*types.Reward{
+		c.meshAPI.EXPECT().GetRewardsByCoinbase(addr1).Return([]*types.Reward{
 			{
 				Layer:       layerFirst,
 				TotalReward: rewardAmount,
@@ -130,7 +130,7 @@ func TestGlobalStateService(t *testing.T) {
 		t.Parallel()
 		c, ctx := setupGlobalStateService(t)
 
-		c.meshAPI.EXPECT().GetRewards(addr1).Return([]*types.Reward{
+		c.meshAPI.EXPECT().GetRewardsByCoinbase(addr1).Return([]*types.Reward{
 			{
 				Layer:       layerFirst,
 				TotalReward: rewardAmount,
@@ -159,12 +159,13 @@ func TestGlobalStateService(t *testing.T) {
 		t.Parallel()
 		c, ctx := setupGlobalStateService(t)
 
-		c.meshAPI.EXPECT().GetRewards(addr1).Return([]*types.Reward{
+		c.meshAPI.EXPECT().GetRewardsByCoinbase(addr1).Return([]*types.Reward{
 			{
 				Layer:       layerFirst,
 				TotalReward: rewardAmount,
 				LayerReward: rewardAmount,
 				Coinbase:    addr1,
+				SmesherID:   rewardSmesherID,
 			},
 		}, nil)
 		c.conStateAPI.EXPECT().GetBalance(addr1).Return(accountBalance, nil)
@@ -188,12 +189,13 @@ func TestGlobalStateService(t *testing.T) {
 		t.Parallel()
 		c, ctx := setupGlobalStateService(t)
 
-		c.meshAPI.EXPECT().GetRewards(addr1).Return([]*types.Reward{
+		c.meshAPI.EXPECT().GetRewardsByCoinbase(addr1).Return([]*types.Reward{
 			{
 				Layer:       layerFirst,
 				TotalReward: rewardAmount,
 				LayerReward: rewardAmount,
 				Coinbase:    addr1,
+				SmesherID:   rewardSmesherID,
 			},
 		}, nil)
 		c.conStateAPI.EXPECT().GetBalance(addr1).Return(accountBalance, nil)

diff --git a/api/grpcserver/grpcserver_test.go b/api/grpcserver/grpcserver_test.go
@@ -78,23 +78,24 @@ var (
 	postGenesisEpoch = types.EpochID(2)
 	genesisID        = types.Hash20{}
 
-	addr1       types.Address
-	addr2       types.Address
-	prevAtxID   = types.ATXID(types.HexToHash32("44444"))
-	chlng       = types.HexToHash32("55555")
-	poetRef     = []byte("66666")
-	nipost      = newNIPostWithChallenge(&chlng, poetRef)
-	challenge   = newChallenge(1, prevAtxID, prevAtxID, postGenesisEpoch)
-	globalAtx   *types.VerifiedActivationTx
-	globalAtx2  *types.VerifiedActivationTx
-	globalTx    *types.Transaction
-	globalTx2   *types.Transaction
-	ballot1     = genLayerBallot(types.LayerID(11))
-	block1      = genLayerBlock(types.LayerID(11), nil)
-	block2      = genLayerBlock(types.LayerID(11), nil)
-	block3      = genLayerBlock(types.LayerID(11), nil)
-	meshAPIMock = &MeshAPIMock{}
-	conStateAPI = &ConStateAPIMock{
+	addr1           types.Address
+	addr2           types.Address
+	rewardSmesherID = types.RandomNodeID()
+	prevAtxID       = types.ATXID(types.HexToHash32("44444"))
+	chlng           = types.HexToHash32("55555")
+	poetRef         = []byte("66666")
+	nipost          = newNIPostWithChallenge(&chlng, poetRef)
+	challenge       = newChallenge(1, prevAtxID, prevAtxID, postGenesisEpoch)
+	globalAtx       *types.VerifiedActivationTx
+	globalAtx2      *types.VerifiedActivationTx
+	globalTx        *types.Transaction
+	globalTx2       *types.Transaction
+	ballot1         = genLayerBallot(types.LayerID(11))
+	block1          = genLayerBlock(types.LayerID(11), nil)
+	block2          = genLayerBlock(types.LayerID(11), nil)
+	block3          = genLayerBlock(types.LayerID(11), nil)
+	meshAPIMock     = &MeshAPIMock{}
+	conStateAPI     = &ConStateAPIMock{
 		returnTx:      make(map[types.TransactionID]*types.Transaction),
 		layerApplied:  make(map[types.TransactionID]*types.LayerID),
 		balances:      make(map[types.Address]*big.Int),
@@ -260,13 +261,26 @@ func (m *MeshAPIMock) ProcessedLayer() types.LayerID {
 	return layerVerified
 }
 
-func (m *MeshAPIMock) GetRewards(types.Address) (rewards []*types.Reward, err error) {
+func (m *MeshAPIMock) GetRewardsByCoinbase(types.Address) (rewards []*types.Reward, err error) {
 	return []*types.Reward{
 		{
 			Layer:       layerFirst,
 			TotalReward: rewardAmount,
 			LayerReward: rewardAmount,
 			Coinbase:    addr1,
+			SmesherID:   rewardSmesherID,
+		},
+	}, nil
+}
+
+func (m *MeshAPIMock) GetRewardsBySmesherId(types.NodeID) (rewards []*types.Reward, err error) {
+	return []*types.Reward{
+		{
+			Layer:       layerFirst,
+			TotalReward: rewardAmount,
+			LayerReward: rewardAmount,
+			Coinbase:    addr1,
+			SmesherID:   rewardSmesherID,
 		},
 	}, nil
 }
@@ -1728,6 +1742,7 @@ func TestAccountDataStream_comprehensive(t *testing.T) {
 		Total:       rewardAmount,
 		LayerReward: rewardAmount * 2,
 		Coinbase:    addr1,
+		SmesherID:   rewardSmesherID,
 	})
 
 	res, err := stream.Recv()
@@ -1783,6 +1798,7 @@ func TestGlobalStateStream_comprehensive(t *testing.T) {
 		Total:       rewardAmount,
 		LayerReward: rewardAmount * 2,
 		Coinbase:    addr1,
+		SmesherID:   rewardSmesherID,
 	})
 	res, err := stream.Recv()
 	require.NoError(t, err, "got error from stream")
@@ -1894,7 +1910,7 @@ func checkAccountDataQueryItemReward(t *testing.T, dataItem any) {
 	require.Equal(t, uint64(rewardAmount), x.Reward.Total.Value)
 	require.Equal(t, uint64(rewardAmount), x.Reward.LayerReward.Value)
 	require.Equal(t, addr1.String(), x.Reward.Coinbase.Address)
-	require.Nil(t, x.Reward.Smesher)
+	require.Equal(t, rewardSmesherID.Bytes(), x.Reward.Smesher.Id)
 }
 
 func checkAccountMeshDataItemTx(t *testing.T, dataItem any) {
@@ -1925,6 +1941,7 @@ func checkAccountDataItemReward(t *testing.T, dataItem any) {
 	require.Equal(t, layerFirst.Uint32(), x.Reward.Layer.Number)
 	require.Equal(t, uint64(rewardAmount*2), x.Reward.LayerReward.Value)
 	require.Equal(t, addr1.String(), x.Reward.Coinbase.Address)
+	require.Equal(t, rewardSmesherID.Bytes(), x.Reward.Smesher.Id)
 }
 
 func checkAccountDataItemAccount(t *testing.T, dataItem any) {
@@ -1946,6 +1963,7 @@ func checkGlobalStateDataReward(t *testing.T, dataItem any) {
 	require.Equal(t, layerFirst.Uint32(), x.Reward.Layer.Number)
 	require.Equal(t, uint64(rewardAmount*2), x.Reward.LayerReward.Value)
 	require.Equal(t, addr1.String(), x.Reward.Coinbase.Address)
+	require.Equal(t, rewardSmesherID.Bytes(), x.Reward.Smesher.Id)
 }
 
 func checkGlobalStateDataAccountWrapper(t *testing.T, dataItem any) {

diff --git a/api/grpcserver/interface.go b/api/grpcserver/interface.go
@@ -79,7 +79,8 @@ type genesisTimeAPI interface {
 type meshAPI interface {
 	GetATXs(context.Context, []types.ATXID) (map[types.ATXID]*types.VerifiedActivationTx, []types.ATXID)
 	GetLayer(types.LayerID) (*types.Layer, error)
-	GetRewards(types.Address) ([]*types.Reward, error)
+	GetRewardsByCoinbase(types.Address) ([]*types.Reward, error)
+	GetRewardsBySmesherId(id types.NodeID) ([]*types.Reward, error)
 	LatestLayer() types.LayerID
 	LatestLayerInState() types.LayerID
 	ProcessedLayer() types.LayerID

diff --git a/api/grpcserver/mocks.go b/api/grpcserver/mocks.go
diff --git a/cmd/bootstrapper/generator_test.go b/cmd/bootstrapper/generator_test.go
@@ -15,6 +15,7 @@ import (
 	pb "github.com/spacemeshos/api/release/go/spacemesh/v1"
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/require"
+	"go.uber.org/mock/gomock"
 	"go.uber.org/zap/zaptest"
 
 	"github.com/spacemeshos/go-spacemesh/api/grpcserver"
@@ -44,22 +45,6 @@ var bitcoinResponse1 string
 //go:embed bitcoinResponse2.json
 var bitcoinResponse2 string
 
-type MeshAPIMock struct{}
-
-func (m *MeshAPIMock) LatestLayer() types.LayerID                        { panic("not implemented") }
-func (m *MeshAPIMock) LatestLayerInState() types.LayerID                 { panic("not implemented") }
-func (m *MeshAPIMock) ProcessedLayer() types.LayerID                     { panic("not implemented") }
-func (m *MeshAPIMock) GetRewards(types.Address) ([]*types.Reward, error) { panic("not implemented") }
-func (m *MeshAPIMock) GetLayer(types.LayerID) (*types.Layer, error)      { panic("not implemented") }
-
-func (m *MeshAPIMock) GetATXs(
-	context.Context,
-	[]types.ATXID,
-) (map[types.ATXID]*types.VerifiedActivationTx, []types.ATXID) {
-	panic("not implemented")
-}
-func (m *MeshAPIMock) MeshHash(types.LayerID) (types.Hash32, error) { panic("not implemented") }
-
 func createAtxs(tb testing.TB, db sql.Executor, epoch types.EpochID, atxids []types.ATXID) {
 	for _, id := range atxids {
 		atx := &types.ActivationTx{InnerActivationTx: types.InnerActivationTx{
@@ -82,7 +67,8 @@ func launchServer(tb testing.TB, cdb *datastore.CachedDB) (grpcserver.Config, fu
 	cfg := grpcserver.DefaultTestConfig()
 	grpcService := grpcserver.New("127.0.0.1:0", zaptest.NewLogger(tb).Named("grpc"), cfg)
 	jsonService := grpcserver.NewJSONHTTPServer("127.0.0.1:0", zaptest.NewLogger(tb).Named("grpc.JSON"))
-	s := grpcserver.NewMeshService(cdb, &MeshAPIMock{}, nil, nil, 0, types.Hash20{}, 0, 0, 0)
+	s := grpcserver.NewMeshService(cdb, grpcserver.NewMockmeshAPI(gomock.NewController(tb)), nil, nil,
+		0, types.Hash20{}, 0, 0, 0)
 
 	pb.RegisterMeshServiceServer(grpcService.GrpcServer, s)
 	// start gRPC and json servers

diff --git a/common/types/block.go b/common/types/block.go
@@ -106,10 +106,11 @@ type AnyReward struct {
 	Weight RatNum
 }
 
-// CoinbaseReward contains the reward information by coinbase, used as an interface to VM.
+// CoinbaseReward contains the reward information by coinbase and smesher, used as an interface to VM.
 type CoinbaseReward struct {
-	Coinbase Address
-	Weight   RatNum
+	SmesherID NodeID
+	Coinbase  Address
+	Weight    RatNum
 }
 
 // Initialize calculates and sets the Block's cached blockID.

diff --git a/common/types/transaction.go b/common/types/transaction.go
@@ -148,6 +148,7 @@ type Reward struct {
 	TotalReward uint64
 	LayerReward uint64
 	Coinbase    Address
+	SmesherID   NodeID
 }
 
 // NewRawTx computes id from raw bytes and returns the object.