Merge pull request #640 from iotaledger/feat/activity-window

Activity Window from Protocol Parameters

Author: cyberphysic4l

pkg/core/account/accounts.go

@@ -125,8 +125,8 @@ func (a *Accounts) ForEach(callback func(id iotago.AccountID, pool *Pool) bool)
 	a.accountPools.ForEach(callback)
 }
 
-// SelectCommittee creates a new SeatedAccounts instance, that maintains the seats of the given members.
-func (a *Accounts) SelectCommittee(members ...iotago.AccountID) *SeatedAccounts {
+// SeatedAccounts creates a new SeatedAccounts instance, that maintains the seats of the given members.
+func (a *Accounts) SeatedAccounts(members ...iotago.AccountID) *SeatedAccounts {
 	return NewSeatedAccounts(a, members...)
 }
 

pkg/core/account/accounts_test.go

@@ -108,11 +108,11 @@ func TestAccounts(t *testing.T) {
 	// check "SelectCommittee"
 
 	// get 1 issuer
-	seated := accounts.SelectCommittee(accountIDs[0])
+	seated := accounts.SeatedAccounts(accountIDs[0])
 	require.Equal(t, 1, seated.SeatCount())
 
 	// get all issuers
-	seated = accounts.SelectCommittee(accountIDs...)
+	seated = accounts.SeatedAccounts(accountIDs...)
 	require.Equal(t, len(accountIDs), seated.SeatCount())
 
 	/*

pkg/protocol/engine/attestation/slotattestation/testframework_test.go

@@ -66,7 +66,7 @@ func NewTestFramework(test *testing.T) *TestFramework {
 			members = append(members, issuer.accountID)
 			return true
 		})
-		return accounts.SelectCommittee(members...), true
+		return accounts.SeatedAccounts(members...), true
 	}
 
 	t.testAPI = iotago.V3API(

pkg/protocol/engine/mempool/spenddag/tests/accounts_framework.go

@@ -21,7 +21,7 @@ type AccountsTestFramework struct {
 func NewAccountsTestFramework(test *testing.T, instance *account.Accounts) *AccountsTestFramework {
 	return &AccountsTestFramework{
 		Instance:  instance,
-		Committee: instance.SelectCommittee(),
+		Committee: instance.SeatedAccounts(),
 
 		test:              test,
 		identitiesByAlias: make(map[string]iotago.AccountID),

pkg/protocol/engine/mempool/v1/mempool_test.go

@@ -141,7 +141,7 @@ func newTestFramework(t *testing.T) *mempooltests.TestFramework {
 	workers := workerpool.NewGroup(t.Name())
 
 	ledgerState := ledgertests.New(ledgertests.NewMockedState(iotago.EmptyTransactionID, 0))
-	spendDAG := spenddagv1.New[iotago.TransactionID, mempool.StateID, vote.MockedRank](account.NewAccounts().SelectCommittee().SeatCount)
+	spendDAG := spenddagv1.New[iotago.TransactionID, mempool.StateID, vote.MockedRank](account.NewAccounts().SeatedAccounts().SeatCount)
 
 	mutationsFunc := func(index iotago.SlotIndex) (kvstore.KVStore, error) {
 		return mapdb.NewMapDB(), nil

pkg/protocol/sybilprotection/activitytracker/activitytrackerv1/activitytracker.go

@@ -22,17 +22,17 @@ type ActivityTracker struct {
 	lastActivityTime time.Time
 	activityMutex    syncutils.RWMutex
 
-	activityWindow time.Duration
+	apiProvider iotago.APIProvider
 }
 
-func NewActivityTracker(activityWindow time.Duration) *ActivityTracker {
+func NewActivityTracker(apiProvider iotago.APIProvider) *ActivityTracker {
 	return &ActivityTracker{
 		Events:          activitytracker.NewEvents(),
 		onlineCommittee: ds.NewSet[account.SeatIndex](),
 		inactivityQueue: timed.NewPriorityQueue[account.SeatIndex](true),
 		lastActivities:  shrinkingmap.New[account.SeatIndex, time.Time](),
 
-		activityWindow: activityWindow,
+		apiProvider: apiProvider,
 	}
 }
 
@@ -48,7 +48,10 @@ func (a *ActivityTracker) MarkSeatActive(seat account.SeatIndex, id iotago.Accou
 	a.activityMutex.Lock()
 	defer a.activityMutex.Unlock()
 
-	if lastActivity, exists := a.lastActivities.Get(seat); (exists && lastActivity.After(seatActivityTime)) || seatActivityTime.Before(a.lastActivityTime.Add(-a.activityWindow)) {
+	// activity window is given by min committable age in seconds from the protocol parameters
+	protocolParams := a.apiProvider.APIForTime(seatActivityTime).ProtocolParameters()
+	activityWindow := time.Duration(protocolParams.MinCommittableAge()*iotago.SlotIndex(protocolParams.SlotDurationInSeconds())) * time.Second
+	if lastActivity, exists := a.lastActivities.Get(seat); (exists && lastActivity.After(seatActivityTime)) || seatActivityTime.Before(a.lastActivityTime.Add(-activityWindow)) {
 		return
 	} else if !exists {
 		a.onlineCommittee.Add(seat)
@@ -65,7 +68,7 @@ func (a *ActivityTracker) MarkSeatActive(seat account.SeatIndex, id iotago.Accou
 
 	a.lastActivityTime = seatActivityTime
 
-	activityThreshold := seatActivityTime.Add(-a.activityWindow)
+	activityThreshold := seatActivityTime.Add(-activityWindow)
 	for _, inactiveSeat := range a.inactivityQueue.PopUntil(activityThreshold) {
 		if lastActivityForInactiveSeat, exists := a.lastActivities.Get(inactiveSeat); exists && lastActivityForInactiveSeat.After(activityThreshold) {
 			continue

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

@@ -40,7 +40,7 @@ func NewManualPOA(e iotago.APIProvider, committeeStore *epochstore.Store[*accoun
 		online:         ds.NewSet[account.SeatIndex](),
 		aliases:        shrinkingmap.New[string, iotago.AccountID](),
 	}
-	m.committee = m.accounts.SelectCommittee()
+	m.committee = m.accounts.SeatedAccounts()
 
 	return m
 }
@@ -71,7 +71,7 @@ func (m *ManualPOA) AddRandomAccount(alias string) iotago.AccountID {
 
 	m.aliases.Set(alias, id)
 
-	m.committee = m.accounts.SelectCommittee(m.accounts.IDs()...)
+	m.committee = m.accounts.SeatedAccounts(m.accounts.IDs()...)
 
 	if err := m.committeeStore.Store(0, m.accounts); err != nil {
 		panic(err)
@@ -90,7 +90,7 @@ func (m *ManualPOA) AddAccount(id iotago.AccountID, alias string) iotago.Account
 	}
 	m.aliases.Set(alias, id)
 
-	m.committee = m.accounts.SelectCommittee(m.accounts.IDs()...)
+	m.committee = m.accounts.SeatedAccounts(m.accounts.IDs()...)
 
 	if err := m.committeeStore.Store(0, m.accounts); err != nil {
 		panic(err)
@@ -152,7 +152,7 @@ func (m *ManualPOA) committeeInEpoch(epoch iotago.EpochIndex) (*account.SeatedAc
 		return nil, false
 	}
 
-	return c.SelectCommittee(c.IDs()...), true
+	return c.SeatedAccounts(c.IDs()...), true
 }
 
 func (m *ManualPOA) OnlineCommittee() ds.Set[account.SeatIndex] {
@@ -179,7 +179,7 @@ func (m *ManualPOA) RotateCommittee(epoch iotago.EpochIndex, validators accounts
 				return nil, ierrors.Wrapf(err, "error while setting pool for epoch %d for validator %s", epoch, validatorData.ID.String())
 			}
 		}
-		m.committee = m.accounts.SelectCommittee(m.accounts.IDs()...)
+		m.committee = m.accounts.SeatedAccounts(m.accounts.IDs()...)
 	}
 
 	if err := m.committeeStore.Store(epoch, m.accounts); err != nil {
@@ -189,10 +189,10 @@ func (m *ManualPOA) RotateCommittee(epoch iotago.EpochIndex, validators accounts
 	return m.committee, nil
 }
 
-func (m *ManualPOA) SetCommittee(epoch iotago.EpochIndex, validators *account.Accounts) error {
+func (m *ManualPOA) ReuseCommittee(epoch iotago.EpochIndex, validators *account.Accounts) error {
 	if m.committee == nil || m.accounts.Size() == 0 {
 		m.accounts = validators
-		m.committee = m.accounts.SelectCommittee(validators.IDs()...)
+		m.committee = m.accounts.SeatedAccounts(validators.IDs()...)
 	}
 
 	if err := m.committeeStore.Store(epoch, validators); err != nil {

pkg/protocol/sybilprotection/seatmanager/poa/options.go

@@ -1,19 +1,10 @@
 package poa
 
 import (
-	"time"
-
 	"github.com/iotaledger/hive.go/runtime/options"
 	iotago "github.com/iotaledger/iota.go/v4"
 )
 
-// WithActivityWindow sets the duration for which a validator is recognized as active after issuing a block.
-func WithActivityWindow(activityWindow time.Duration) options.Option[SeatManager] {
-	return func(p *SeatManager) {
-		p.optsActivityWindow = activityWindow
-	}
-}
-
 func WithOnlineCommitteeStartup(optsOnlineCommittee ...iotago.AccountID) options.Option[SeatManager] {
 	return func(p *SeatManager) {
 		p.optsOnlineCommitteeStartup = optsOnlineCommittee

pkg/protocol/sybilprotection/seatmanager/poa/poa.go

@@ -30,7 +30,6 @@ type SeatManager struct {
 
 	committeeMutex syncutils.RWMutex
 
-	optsActivityWindow         time.Duration
 	optsOnlineCommitteeStartup []iotago.AccountID
 
 	module.Module
@@ -44,10 +43,8 @@ func NewProvider(opts ...options.Option[SeatManager]) module.Provider[*engine.En
 				events:         seatmanager.NewEvents(),
 				apiProvider:    e,
 				committeeStore: e.Storage.Committee(),
-
-				optsActivityWindow: time.Second * 30,
 			}, opts, func(s *SeatManager) {
-				activityTracker := activitytrackerv1.NewActivityTracker(s.optsActivityWindow)
+				activityTracker := activitytrackerv1.NewActivityTracker(e)
 				s.activityTracker = activityTracker
 				s.events.OnlineCommitteeSeatAdded.LinkTo(activityTracker.Events.OnlineCommitteeSeatAdded)
 				s.events.OnlineCommitteeSeatRemoved.LinkTo(activityTracker.Events.OnlineCommitteeSeatRemoved)
@@ -97,7 +94,7 @@ func (s *SeatManager) RotateCommittee(epoch iotago.EpochIndex, validators accoun
 				return nil, ierrors.Wrapf(err, "error while setting committee for epoch %d for validator %s", epoch, validatorData.ID.String())
 			}
 		}
-		s.committee = committeeAccounts.SelectCommittee(committeeAccounts.IDs()...)
+		s.committee = committeeAccounts.SeatedAccounts(committeeAccounts.IDs()...)
 	}
 
 	accounts, err := s.committee.Accounts()
@@ -138,7 +135,7 @@ func (s *SeatManager) committeeInEpoch(epoch iotago.EpochIndex) (*account.Seated
 		return nil, false
 	}
 
-	return c.SelectCommittee(c.IDs()...), true
+	return c.SeatedAccounts(c.IDs()...), true
 }
 
 // OnlineCommittee returns the set of validators selected to be part of the committee that has been seen recently.
@@ -174,7 +171,7 @@ func (s *SeatManager) InitializeCommittee(epoch iotago.EpochIndex, activityTime
 	}
 
 	committeeAccountsIDs := committeeAccounts.IDs()
-	s.committee = committeeAccounts.SelectCommittee(committeeAccountsIDs...)
+	s.committee = committeeAccounts.SeatedAccounts(committeeAccountsIDs...)
 
 	// Set validators that are part of the committee as active.
 	onlineValidators := committeeAccountsIDs
@@ -195,11 +192,11 @@ func (s *SeatManager) InitializeCommittee(epoch iotago.EpochIndex, activityTime
 	return nil
 }
 
-func (s *SeatManager) SetCommittee(epoch iotago.EpochIndex, validators *account.Accounts) error {
+func (s *SeatManager) ReuseCommittee(epoch iotago.EpochIndex, validators *account.Accounts) error {
 	s.committeeMutex.Lock()
 	defer s.committeeMutex.Unlock()
 
-	s.committee = validators.SelectCommittee(validators.IDs()...)
+	s.committee = validators.SeatedAccounts(validators.IDs()...)
 
 	accounts, err := s.committee.Accounts()
 	if err != nil {

pkg/protocol/sybilprotection/seatmanager/seatmanager.go

@@ -15,9 +15,8 @@ type SeatManager interface {
 	// RotateCommittee rotates the committee evaluating the given set of candidates to produce the new committee.
 	RotateCommittee(epoch iotago.EpochIndex, candidates accounts.AccountsData) (*account.SeatedAccounts, error)
 
-	// SetCommittee sets the committee for a given slot.
-	// This is used when re-using the same committee for consecutive epochs.
-	SetCommittee(epoch iotago.EpochIndex, committee *account.Accounts) error
+	// ReuseCommittee reuses the committee from a previous epoch.
+	ReuseCommittee(epoch iotago.EpochIndex, committee *account.Accounts) error
 
 	// InitializeCommittee initializes the committee for the current slot by marking whole or a subset of the committee as active.
 	// This is used when initializing committee after node startup (loaded from snapshot or database).