Add dynamic liveness threshold to TipSelection

go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/iotaledger/hive.go/stringify v0.0.0-20230926122307-d671b36a4a65
 	github.com/iotaledger/inx-app v1.0.0-rc.3.0.20230927140518-622f63be6182
 	github.com/iotaledger/inx/go v1.0.0-rc.2.0.20230927140257-bfa0bb0af2bd
-	github.com/iotaledger/iota.go/v4 v4.0.0-20230927125610-ddf51789ec4d
+	github.com/iotaledger/iota.go/v4 v4.0.0-20230928093005-fe74b3839c5d
 	github.com/labstack/echo/v4 v4.11.1
 	github.com/labstack/gommon v0.4.0
 	github.com/libp2p/go-libp2p v0.30.0

go.sum

@@ -305,8 +305,8 @@ github.com/iotaledger/inx-app v1.0.0-rc.3.0.20230927140518-622f63be6182 h1:lQikt
 github.com/iotaledger/inx-app v1.0.0-rc.3.0.20230927140518-622f63be6182/go.mod h1:q24QEsS887ZWJVX76w2kwSgC84KS7wIKOy1otuqZ2ZM=
 github.com/iotaledger/inx/go v1.0.0-rc.2.0.20230927140257-bfa0bb0af2bd h1:nFG3Zq/zFA4KhBYFX2IezX1C74zfE0DqCt0LrgTa9Ig=
 github.com/iotaledger/inx/go v1.0.0-rc.2.0.20230927140257-bfa0bb0af2bd/go.mod h1:c5778OnWpLq108YE+Eb2m8Ri/t/4ydV0TvI/Sy5YivQ=
-github.com/iotaledger/iota.go/v4 v4.0.0-20230927125610-ddf51789ec4d h1:lhYbBhVORcS2LLNviaO/yTmom1suDskJLA1wSvvsLiU=
-github.com/iotaledger/iota.go/v4 v4.0.0-20230927125610-ddf51789ec4d/go.mod h1:wR9xBbsofns9hFyRHFZ2bDYIb861qsfmQPVMBKcPvDo=
+github.com/iotaledger/iota.go/v4 v4.0.0-20230928093005-fe74b3839c5d h1:YvE8rOrBJQu9wryUAOwEEl4mu91rpocO23qKpffKdi8=
+github.com/iotaledger/iota.go/v4 v4.0.0-20230928093005-fe74b3839c5d/go.mod h1:wR9xBbsofns9hFyRHFZ2bDYIb861qsfmQPVMBKcPvDo=
 github.com/ipfs/boxo v0.10.0 h1:tdDAxq8jrsbRkYoF+5Rcqyeb91hgWe2hp7iLu7ORZLY=
 github.com/ipfs/boxo v0.10.0/go.mod h1:Fg+BnfxZ0RPzR0nOodzdIq3A7KgoWAOWsEIImrIQdBM=
 github.com/ipfs/go-cid v0.4.1 h1:A/T3qGvxi4kpKWWcPC/PgbvDA2bjVLO7n4UeVwnbs/s=

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

@@ -72,7 +72,7 @@ func NewTestFramework(test *testing.T) *TestFramework {
 		iotago.NewV3ProtocolParameters(
 			iotago.WithNetworkOptions("TestJungle", "tgl"),
 			iotago.WithSupplyOptions(10000, 0, 0, 0, 0, 0, 0),
-			iotago.WithLivenessOptions(1, 1, 2, 8),
+			iotago.WithLivenessOptions(10, 10, 1, 2, 8),
 		),
 	)
 

pkg/protocol/engine/blocks/block.go

@@ -383,6 +383,13 @@ func (b *Block) AddWitness(seat account.SeatIndex) (added bool) {
 	return b.witnesses.Add(seat)
 }
 
+func (b *Block) WitnessCount() int {
+	b.mutex.RLock()
+	defer b.mutex.RUnlock()
+
+	return b.witnesses.Size()
+}
+
 func (b *Block) Witnesses() []account.SeatIndex {
 	b.mutex.RLock()
 	defer b.mutex.RUnlock()

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

@@ -20,21 +20,26 @@ import (
 type TestFramework struct {
 	Instance *tipmanagerv1.TipManager
 
-	blockIDsByAlias map[string]iotago.BlockID
-	blocksByID      map[iotago.BlockID]*blocks.Block
-	test            *testing.T
+	blockIDsByAlias    map[string]iotago.BlockID
+	tipMetadataByAlias map[string]tipmanager.TipMetadata
+	blocksByID         map[iotago.BlockID]*blocks.Block
+	test               *testing.T
+
+	API iotago.API
 }
 
 func NewTestFramework(test *testing.T) *TestFramework {
 	t := &TestFramework{
-		blockIDsByAlias: make(map[string]iotago.BlockID),
-		blocksByID:      make(map[iotago.BlockID]*blocks.Block),
-		test:            test,
+		blockIDsByAlias:    make(map[string]iotago.BlockID),
+		tipMetadataByAlias: make(map[string]tipmanager.TipMetadata),
+		blocksByID:         make(map[iotago.BlockID]*blocks.Block),
+		test:               test,
+		API:                tpkg.TestAPI,
 	}
 
 	t.blockIDsByAlias["Genesis"] = iotago.EmptyBlockID()
 
-	t.Instance = tipmanagerv1.NewTipManager(func(blockID iotago.BlockID) (block *blocks.Block, exists bool) {
+	t.Instance = tipmanagerv1.New(func(blockID iotago.BlockID) (block *blocks.Block, exists bool) {
 		block, exists = t.blocksByID[blockID]
 		return block, exists
 	})
@@ -43,11 +48,13 @@ func NewTestFramework(test *testing.T) *TestFramework {
 }
 
 func (t *TestFramework) AddBlock(alias string) tipmanager.TipMetadata {
-	return t.Instance.AddBlock(t.Block(alias))
+	t.tipMetadataByAlias[alias] = t.Instance.AddBlock(t.Block(alias))
+
+	return t.tipMetadataByAlias[alias]
 }
 
-func (t *TestFramework) CreateBlock(alias string, parents map[iotago.ParentsType][]string) *blocks.Block {
-	blockBuilder := builder.NewBasicBlockBuilder(tpkg.TestAPI)
+func (t *TestFramework) CreateBlock(alias string, parents map[iotago.ParentsType][]string, optBlockBuilder ...func(*builder.BasicBlockBuilder)) *blocks.Block {
+	blockBuilder := builder.NewBasicBlockBuilder(t.API)
 	blockBuilder.IssuingTime(time.Now())
 
 	if strongParents, strongParentsExist := parents[iotago.StrongParentType]; strongParentsExist {
@@ -60,6 +67,10 @@ func (t *TestFramework) CreateBlock(alias string, parents map[iotago.ParentsType
 		blockBuilder.ShallowLikeParents(lo.Map(shallowLikeParents, t.BlockID))
 	}
 
+	if len(optBlockBuilder) > 0 {
+		optBlockBuilder[0](blockBuilder)
+	}
+
 	block, err := blockBuilder.Build()
 	require.NoError(t.test, err)
 
@@ -82,17 +93,28 @@ func (t *TestFramework) Block(alias string) *blocks.Block {
 	return block
 }
 
+func (t *TestFramework) TipMetadata(alias string) tipmanager.TipMetadata {
+	tipMetadata, tipMetadataExists := t.tipMetadataByAlias[alias]
+	require.True(t.test, tipMetadataExists)
+
+	return tipMetadata
+}
+
 func (t *TestFramework) BlockID(alias string) iotago.BlockID {
 	blockID, blockIDExists := t.blockIDsByAlias[alias]
 	require.True(t.test, blockIDExists, "blockID for alias '%s' does not exist", alias)
 
 	return blockID
 }
 
-func (t *TestFramework) AssertStrongTips(aliases ...string) {
+func (t *TestFramework) RequireStrongTips(aliases ...string) {
 	for _, alias := range aliases {
 		require.True(t.test, ds.NewSet(lo.Map(t.Instance.StrongTips(), tipmanager.TipMetadata.ID)...).Has(t.BlockID(alias)), "strongTips does not contain block '%s'", alias)
 	}
 
 	require.Equal(t.test, len(aliases), len(t.Instance.StrongTips()), "strongTips size does not match")
 }
+
+func (t *TestFramework) RequireLivenessThresholdReached(alias string, expected bool) {
+	require.Equal(t.test, expected, t.TipMetadata(alias).LivenessThresholdReached().Get())
+}

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

@@ -21,13 +21,13 @@ func TestTipManager(t *testing.T) {
 	})
 
 	tf.AddBlock("Bernd").TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("Bernd")
+	tf.RequireStrongTips("Bernd")
 
 	tf.AddBlock("Bernd1").TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("Bernd1")
+	tf.RequireStrongTips("Bernd1")
 
 	tf.AddBlock("Bernd1.1").TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("Bernd1", "Bernd1.1")
+	tf.RequireStrongTips("Bernd1", "Bernd1.1")
 }
 
 func Test_Orphanage(t *testing.T) {
@@ -44,15 +44,15 @@ func Test_Orphanage(t *testing.T) {
 	})
 
 	tf.AddBlock("A").TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("A")
+	tf.RequireStrongTips("A")
 
 	blockB := tf.AddBlock("B")
 	blockB.TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("A", "B")
+	tf.RequireStrongTips("A", "B")
 
 	tf.AddBlock("C").TipPool().Set(tipmanager.StrongTipPool)
-	tf.AssertStrongTips("C")
+	tf.RequireStrongTips("C")
 
 	blockB.LivenessThresholdReached().Trigger()
-	tf.AssertStrongTips("A")
+	tf.RequireStrongTips("A")
 }

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

@@ -4,15 +4,14 @@ import (
 	"github.com/iotaledger/hive.go/lo"
 	"github.com/iotaledger/hive.go/runtime/event"
 	"github.com/iotaledger/hive.go/runtime/module"
-	"github.com/iotaledger/hive.go/runtime/options"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
 )
 
 // NewProvider creates a new TipManager provider, that can be used to inject the component into an engine.
-func NewProvider(opts ...options.Option[TipManager]) module.Provider[*engine.Engine, tipmanager.TipManager] {
+func NewProvider() module.Provider[*engine.Engine, tipmanager.TipManager] {
 	return module.Provide(func(e *engine.Engine) tipmanager.TipManager {
-		t := NewTipManager(e.BlockCache.Block, opts...)
+		t := New(e.BlockCache.Block)
 
 		e.HookConstructed(func() {
 			tipWorker := e.Workers.CreatePool("AddTip", 2)

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

@@ -6,7 +6,6 @@ import (
 	"github.com/iotaledger/hive.go/lo"
 	"github.com/iotaledger/hive.go/runtime/event"
 	"github.com/iotaledger/hive.go/runtime/module"
-	"github.com/iotaledger/hive.go/runtime/options"
 	"github.com/iotaledger/hive.go/runtime/syncutils"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
@@ -40,15 +39,20 @@ type TipManager struct {
 	module.Module
 }
 
-// NewTipManager creates a new TipManager.
-func NewTipManager(blockRetriever func(blockID iotago.BlockID) (block *blocks.Block, exists bool), opts ...options.Option[TipManager]) *TipManager {
-	return options.Apply(&TipManager{
+// New creates a new TipManager.
+func New(blockRetriever func(blockID iotago.BlockID) (block *blocks.Block, exists bool)) *TipManager {
+	t := &TipManager{
 		retrieveBlock:      blockRetriever,
 		tipMetadataStorage: shrinkingmap.New[iotago.SlotIndex, *shrinkingmap.ShrinkingMap[iotago.BlockID, *TipMetadata]](),
 		strongTipSet:       randommap.New[iotago.BlockID, *TipMetadata](),
 		weakTipSet:         randommap.New[iotago.BlockID, *TipMetadata](),
 		blockAdded:         event.New1[tipmanager.TipMetadata](),
-	}, opts, (*TipManager).TriggerConstructed)
+	}
+
+	t.TriggerConstructed()
+	t.TriggerInitialized()
+
+	return t
 }
 
 // AddBlock adds a Block to the TipManager and returns the TipMetadata if the Block was added successfully.
@@ -99,8 +103,11 @@ func (t *TipManager) Evict(slot iotago.SlotIndex) {
 	}
 }
 
-// Shutdown does nothing but is required by the module.Interface.
-func (t *TipManager) Shutdown() {}
+// Shutdown marks the TipManager as shutdown.
+func (t *TipManager) Shutdown() {
+	t.TriggerShutdown()
+	t.TriggerStopped()
+}
 
 // setupBlockMetadata sets up the behavior of the given Block.
 func (t *TipManager) setupBlockMetadata(tipMetadata *TipMetadata) {
@@ -139,7 +146,13 @@ func (t *TipManager) forEachParentByType(block *blocks.Block, consumer func(pare
 
 	for _, parent := range block.ParentsWithType() {
 		if metadataStorage := t.metadataStorage(parent.ID.Slot()); metadataStorage != nil {
-			if parentMetadata, created := metadataStorage.GetOrCreate(parent.ID, func() *TipMetadata { return NewBlockMetadata(lo.Return1(t.retrieveBlock(parent.ID))) }); parentMetadata.Block() != nil {
+			// Make sure we don't add rootblocks back to the tips.
+			parentBlock, exists := t.retrieveBlock(parent.ID)
+			if !exists || parentBlock.IsRootBlock() {
+				continue
+			}
+
+			if parentMetadata, created := metadataStorage.GetOrCreate(parent.ID, func() *TipMetadata { return NewBlockMetadata(parentBlock) }); parentMetadata.Block() != nil {
 				consumer(parent.Type, parentMetadata)
 
 				if created {

pkg/protocol/engine/tipselection/tipselection.go

@@ -12,8 +12,8 @@ type TipSelection interface {
 	// SelectTips selects the tips that should be used as references for a new block.
 	SelectTips(count int) (references model.ParentReferences)
 
-	// SetLivenessThreshold sets the liveness threshold used for tip selection (it can only increase monotonically).
-	SetLivenessThreshold(threshold time.Time)
+	// SetAcceptanceTime updates the acceptance time of the TipSelection.
+	SetAcceptanceTime(acceptanceTime time.Time) (previousTime time.Time)
 
 	// Interface embeds the required methods of the module.Interface.
 	module.Interface

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

@@ -1,35 +1,54 @@
 package tipselectionv1
 
 import (
+	"math"
+	"time"
+
 	"github.com/iotaledger/hive.go/runtime/module"
 	"github.com/iotaledger/hive.go/runtime/options"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/blocks"
+	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipmanager"
 	"github.com/iotaledger/iota-core/pkg/protocol/engine/tipselection"
 )
 
 // NewProvider creates a new TipSelection provider, that can be used to inject the component into an engine.
 func NewProvider(opts ...options.Option[TipSelection]) module.Provider[*engine.Engine, tipselection.TipSelection] {
 	return module.Provide(func(e *engine.Engine) tipselection.TipSelection {
-		t := New(e, e.TipManager, e.Ledger.ConflictDAG(), e.Ledger.MemPool(), e.EvictionState.LatestRootBlocks, opts...)
+		t := New(opts...)
 
 		e.HookConstructed(func() {
-			e.Ledger.HookInitialized(func() {
+			// wait for submodules to be constructed (so all of their properties are available)
+			module.OnAllConstructed(func() {
+				t.Construct(e.TipManager, e.Ledger.ConflictDAG(), e.Ledger.MemPool().TransactionMetadata, e.EvictionState.LatestRootBlocks, DynamicLivenessThreshold(e.SybilProtection.SeatManager().OnlineCommittee().Size))
+
 				e.Events.AcceptedBlockProcessed.Hook(func(block *blocks.Block) {
-					t.SetLivenessThreshold(block.IssuingTime().Add(-e.CurrentAPI().LivenessThresholdDuration()))
+					t.SetAcceptanceTime(block.IssuingTime())
 				})
-
-				t.conflictDAG = e.Ledger.ConflictDAG()
-				t.memPool = e.Ledger.MemPool()
-
-				t.TriggerInitialized()
-			})
-
-			e.TipManager.OnBlockAdded(t.classifyTip)
+			}, e.TipManager, e.Ledger, e.SybilProtection)
 		})
 
-		e.HookStopped(t.TriggerStopped)
+		e.HookShutdown(t.Shutdown)
 
 		return t
 	})
 }
+
+// DynamicLivenessThreshold returns a function that calculates the liveness threshold for a tip.
+func DynamicLivenessThreshold(committeeSizeProvider func() int) func(tip tipmanager.TipMetadata) time.Duration {
+	return func(tip tipmanager.TipMetadata) time.Duration {
+		// We want to scale the liveness threshold based on the number of witnesses:
+		//  0 witnesses: approval modifier is 0 -> LivenessThresholdLowerBound
+		//  <=1/3: scale linearly
+		//  >1/3: approval modifier is 1 -> LivenessThresholdUpperBound
+		var (
+			params                      = tip.Block().ModelBlock().ProtocolBlock().API.ProtocolParameters()
+			livenessThresholdLowerBound = params.LivenessThresholdLowerBound()
+			livenessWindow              = float64(params.LivenessThresholdUpperBound() - livenessThresholdLowerBound)
+			expectedWitnessCount        = math.Ceil(float64(committeeSizeProvider()) / 3.0)
+			approvalModifier            = math.Min(float64(tip.Block().WitnessCount())/expectedWitnessCount, 1.0)
+		)
+
+		return livenessThresholdLowerBound + time.Duration(approvalModifier*livenessWindow)
+	}
+}