Adjust TipManager to receive a CommitteeInSlot retriever and wire up events to start tracking of validators in TipManager

Author: jonastheis

pkg/protocol/engine/tipmanager/tests/testframework.go

@@ -7,11 +7,15 @@ import (
 	"github.com/stretchr/testify/require"
 
 	"github.com/iotaledger/hive.go/ds"
+	"github.com/iotaledger/hive.go/kvstore/mapdb"
 	"github.com/iotaledger/hive.go/lo"
+	"github.com/iotaledger/iota-core/pkg/core/account"
 	"github.com/iotaledger/iota-core/pkg/model"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
 	tipmanagerv1 "github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager/v1"
+	"github.com/iotaledger/iota-core/pkg/protocol/sybilprotection/seatmanager/mock"
+	"github.com/iotaledger/iota-core/pkg/storage/prunable/epochstore"
 	iotago "github.com/iotaledger/iota.go/v4"
 	"github.com/iotaledger/iota.go/v4/builder"
 	"github.com/iotaledger/iota.go/v4/tpkg"
@@ -23,10 +27,11 @@ type TestFramework struct {
 	blockIDsByAlias    map[string]iotago.BlockID
 	tipMetadataByAlias map[string]tipmanager.TipMetadata
 	blocksByID         map[iotago.BlockID]*blocks.Block
-	validatorByAlias   map[string]iotago.AccountID
 	test               *testing.T
 	time               time.Time
 
+	manualPOA mock.ManualPOA
+
 	API iotago.API
 }
 
@@ -35,36 +40,42 @@ func NewTestFramework(test *testing.T) *TestFramework {
 		blockIDsByAlias:    make(map[string]iotago.BlockID),
 		tipMetadataByAlias: make(map[string]tipmanager.TipMetadata),
 		blocksByID:         make(map[iotago.BlockID]*blocks.Block),
-		validatorByAlias:   make(map[string]iotago.AccountID),
 		test:               test,
 		API:                tpkg.ZeroCostTestAPI,
 		time:               time.Now(),
+		manualPOA: *mock.NewManualPOA(iotago.SingleVersionProvider(tpkg.ZeroCostTestAPI),
+			epochstore.NewStore[*account.Accounts](
+				nil,
+				mapdb.NewMapDB(),
+				func(index iotago.EpochIndex) iotago.EpochIndex { return index },
+				(*account.Accounts).Bytes,
+				account.AccountsFromBytes),
+		),
 	}
 
 	t.blockIDsByAlias["Genesis"] = iotago.EmptyBlockID
 
 	t.Instance = tipmanagerv1.New(func(blockID iotago.BlockID) (block *blocks.Block, exists bool) {
 		block, exists = t.blocksByID[blockID]
 		return block, exists
-	})
+	}, t.manualPOA.CommitteeInSlot)
 
 	return t
 }
 
 func (t *TestFramework) Validator(alias string) iotago.AccountID {
-	validator, validatorExists := t.validatorByAlias[alias]
-	require.True(t.test, validatorExists)
-
-	return validator
+	return t.manualPOA.AccountID(alias)
 }
 
 func (t *TestFramework) AddValidator(alias string) {
-	accountID := iotago.AccountID(tpkg.Rand32ByteArray())
-	accountID.RegisterAlias(alias)
+	t.manualPOA.AddRandomAccount(alias)
 
-	t.validatorByAlias[alias] = accountID
+	seat, exists := t.manualPOA.GetSeat(alias)
+	if !exists {
+		panic("seat does not exist")
+	}
 
-	t.Instance.AddValidator(accountID)
+	t.Instance.AddSeat(seat)
 }
 
 func (t *TestFramework) AddBlock(alias string) tipmanager.TipMetadata {

pkg/protocol/engine/tipmanager/tipmanager.go

@@ -2,6 +2,7 @@ package tipmanager
 
 import (
 	"github.com/iotaledger/hive.go/runtime/module"
+	"github.com/iotaledger/iota-core/pkg/core/account"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
 	iotago "github.com/iotaledger/iota.go/v4"
 )
@@ -27,11 +28,11 @@ type TipManager interface {
 	// OnBlockAdded registers a callback that is triggered whenever a new Block was added to the TipManager.
 	OnBlockAdded(handler func(block TipMetadata)) (unsubscribe func())
 
-	// AddValidator adds a validator to the tracking of the TipManager.
-	AddValidator(accountID iotago.AccountID) (added bool)
+	// AddSeat adds a validator seat to the tracking of the TipManager.
+	AddSeat(seat account.SeatIndex)
 
-	// RemoveValidator removes a validator from the tracking of the TipManager.
-	RemoveValidator(accountID iotago.AccountID) (removed bool)
+	// RemoveSeat removes a validator seat from the tracking of the TipManager.
+	RemoveSeat(seat account.SeatIndex)
 
 	// ValidationTips returns the validation tips of the TipManager (with an optional limit).
 	ValidationTips(optAmount ...int) []TipMetadata

pkg/protocol/engine/tipmanager/v1/provider.go

@@ -5,21 +5,29 @@ import (
 	"github.com/iotaledger/hive.go/runtime/event"
 	"github.com/iotaledger/hive.go/runtime/module"
 	"github.com/iotaledger/hive.go/runtime/workerpool"
+	"github.com/iotaledger/iota-core/pkg/core/account"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
+	iotago "github.com/iotaledger/iota.go/v4"
 )
 
 // NewProvider creates a new TipManager provider, that can be used to inject the component into an engine.
 func NewProvider() module.Provider[*engine.Engine, tipmanager.TipManager] {
 	return module.Provide(func(e *engine.Engine) tipmanager.TipManager {
-		t := New(e.BlockCache.Block)
+		t := New(e.BlockCache.Block, e.SybilProtection.SeatManager().CommitteeInSlot)
 
 		e.Constructed.OnTrigger(func() {
 			tipWorker := e.Workers.CreatePool("AddTip", workerpool.WithWorkerCount(2))
+
 			e.Events.Scheduler.BlockScheduled.Hook(lo.Void(t.AddBlock), event.WithWorkerPool(tipWorker))
 			e.Events.Scheduler.BlockSkipped.Hook(lo.Void(t.AddBlock), event.WithWorkerPool(tipWorker))
 			e.BlockCache.Evict.Hook(t.Evict)
 
+			e.Events.SeatManager.OnlineCommitteeSeatAdded.Hook(func(index account.SeatIndex, _ iotago.AccountID) {
+				t.AddSeat(index)
+			})
+			e.Events.SeatManager.OnlineCommitteeSeatRemoved.Hook(t.RemoveSeat)
+
 			e.Events.TipManager.BlockAdded.LinkTo(t.blockAdded)
 
 			t.TriggerInitialized()

pkg/protocol/engine/tipmanager/v1/tipmanager.go

@@ -10,6 +10,7 @@ import (
 	"github.com/iotaledger/hive.go/runtime/event"
 	"github.com/iotaledger/hive.go/runtime/module"
 	"github.com/iotaledger/hive.go/runtime/syncutils"
+	"github.com/iotaledger/iota-core/pkg/core/account"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
 	iotago "github.com/iotaledger/iota.go/v4"
@@ -20,11 +21,14 @@ type TipManager struct {
 	// retrieveBlock is a function that retrieves a Block from the Tangle.
 	retrieveBlock func(blockID iotago.BlockID) (block *blocks.Block, exists bool)
 
+	// retrieveCommitteeInSlot is a function that retrieves the committee in a given slot.
+	retrieveCommitteeInSlot func(slot iotago.SlotIndex) (*account.SeatedAccounts, bool)
+
 	// tipMetadataStorage contains the TipMetadata of all Blocks that are managed by the TipManager.
 	tipMetadataStorage *shrinkingmap.ShrinkingMap[iotago.SlotIndex, *shrinkingmap.ShrinkingMap[iotago.BlockID, *TipMetadata]]
 
 	// latestValidatorBlocks contains a Variable for each validator that stores the latest validator block.
-	latestValidatorBlocks *shrinkingmap.ShrinkingMap[iotago.AccountID, reactive.Variable[*TipMetadata]]
+	latestValidatorBlocks *shrinkingmap.ShrinkingMap[account.SeatIndex, reactive.Variable[*TipMetadata]]
 
 	// validatorTipSet contains the subset of blocks from the strong tip set that reference the latest validator block.
 	validatorTipSet *randommap.RandomMap[iotago.BlockID, *TipMetadata]
@@ -49,15 +53,19 @@ type TipManager struct {
 }
 
 // New creates a new TipManager.
-func New(blockRetriever func(blockID iotago.BlockID) (block *blocks.Block, exists bool)) *TipManager {
+func New(
+	blockRetriever func(blockID iotago.BlockID) (block *blocks.Block, exists bool),
+	retrieveCommitteeInSlot func(slot iotago.SlotIndex) (*account.SeatedAccounts, bool),
+) *TipManager {
 	t := &TipManager{
-		retrieveBlock:         blockRetriever,
-		tipMetadataStorage:    shrinkingmap.New[iotago.SlotIndex, *shrinkingmap.ShrinkingMap[iotago.BlockID, *TipMetadata]](),
-		latestValidatorBlocks: shrinkingmap.New[iotago.AccountID, reactive.Variable[*TipMetadata]](),
-		validatorTipSet:       randommap.New[iotago.BlockID, *TipMetadata](),
-		strongTipSet:          randommap.New[iotago.BlockID, *TipMetadata](),
-		weakTipSet:            randommap.New[iotago.BlockID, *TipMetadata](),
-		blockAdded:            event.New1[tipmanager.TipMetadata](),
+		retrieveBlock:           blockRetriever,
+		retrieveCommitteeInSlot: retrieveCommitteeInSlot,
+		tipMetadataStorage:      shrinkingmap.New[iotago.SlotIndex, *shrinkingmap.ShrinkingMap[iotago.BlockID, *TipMetadata]](),
+		latestValidatorBlocks:   shrinkingmap.New[account.SeatIndex, reactive.Variable[*TipMetadata]](),
+		validatorTipSet:         randommap.New[iotago.BlockID, *TipMetadata](),
+		strongTipSet:            randommap.New[iotago.BlockID, *TipMetadata](),
+		weakTipSet:              randommap.New[iotago.BlockID, *TipMetadata](),
+		blockAdded:              event.New1[tipmanager.TipMetadata](),
 	}
 
 	t.TriggerConstructed()
@@ -89,23 +97,20 @@ func (t *TipManager) OnBlockAdded(handler func(block tipmanager.TipMetadata)) (u
 	return t.blockAdded.Hook(handler).Unhook
 }
 
-// AddValidator adds a validator to the tracking of the TipManager.
-func (t *TipManager) AddValidator(accountID iotago.AccountID) (added bool) {
-	_, added = t.latestValidatorBlocks.GetOrCreate(accountID, func() reactive.Variable[*TipMetadata] {
+// AddSeat adds a validator to the tracking of the TipManager.
+func (t *TipManager) AddSeat(seat account.SeatIndex) {
+	t.latestValidatorBlocks.GetOrCreate(seat, func() reactive.Variable[*TipMetadata] {
 		return reactive.NewVariable[*TipMetadata]()
 	})
-
-	return added
 }
 
-// RemoveValidator removes a validator from the tracking of the TipManager.
-func (t *TipManager) RemoveValidator(accountID iotago.AccountID) (removed bool) {
-	latestValidatorBlock, removed := t.latestValidatorBlocks.DeleteAndReturn(accountID)
+// RemoveSeat removes a validator from the tracking of the TipManager.
+func (t *TipManager) RemoveSeat(seat account.SeatIndex) {
+	latestValidatorBlock, removed := t.latestValidatorBlocks.DeleteAndReturn(seat)
 	if removed {
 		latestValidatorBlock.Set(nil)
 	}
 
-	return removed
 }
 
 func (t *TipManager) ValidationTips(optAmount ...int) []tipmanager.TipMetadata {
@@ -200,8 +205,18 @@ func (t *TipManager) trackLatestValidatorBlock(tipMetadata *TipMetadata) (teardo
 		return
 	}
 
-	// We only track the validation blocks of validators that are tracked by the TipManager (via AddValidator).
-	latestValidatorBlock, exists := t.latestValidatorBlocks.Get(tipMetadata.Block().ProtocolBlock().Header.IssuerID)
+	committee, exists := t.retrieveCommitteeInSlot(tipMetadata.Block().ID().Slot())
+	if !exists {
+		return
+	}
+
+	seat, exists := committee.GetSeat(tipMetadata.Block().ProtocolBlock().Header.IssuerID)
+	if !exists {
+		return
+	}
+
+	// We only track the validation blocks of validators that are tracked by the TipManager (via AddSeat).
+	latestValidatorBlock, exists := t.latestValidatorBlocks.Get(seat)
 	if !exists {
 		return
 	}

pkg/protocol/sybilprotection/seatmanager/mock/mockseatmanager.go

@@ -108,6 +108,10 @@ func (m *ManualPOA) AccountID(alias string) iotago.AccountID {
 	return id
 }
 
+func (m *ManualPOA) GetSeat(alias string) (account.SeatIndex, bool) {
+	return m.committee.GetSeat(m.AccountID(alias))
+}
+
 func (m *ManualPOA) SetOnline(aliases ...string) {
 	for _, alias := range aliases {
 		seat, exists := m.committee.GetSeat(m.AccountID(alias))