Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove .Status() from .IsPreferred() #3111

Merged
merged 2 commits into from
Jun 13, 2024
Merged

Remove .Status() from .IsPreferred() #3111

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
523e78f
Remove .Status() from .IsPreferred()
StephenButtolph Jun 12, 2024
69a4ec9
nit
StephenButtolph Jun 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions snow/consensus/snowman/consensus.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ type Consensus interface {
// Processing returns true if the block ID is currently processing.
Processing(ids.ID) bool

// IsPreferred returns true if the block is currently on the preferred
// chain.
IsPreferred(Block) bool
// IsPreferred returns true if the block ID is preferred. Only the last
// accepted block and processing blocks are considered preferred.
IsPreferred(ids.ID) bool

// Returns the ID and height of the last accepted decision.
LastAccepted() (ids.ID, uint64)
Expand Down
34 changes: 17 additions & 17 deletions snow/consensus/snowman/consensus_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ func AddToTailTest(t *testing.T, factory Factory) {
// Adding to the previous preference will update the preference
require.NoError(sm.Add(block))
require.Equal(block.ID(), sm.Preference())
require.True(sm.IsPreferred(block))
require.True(sm.IsPreferred(block.ID()))

pref, ok := sm.PreferenceAtHeight(block.Height())
require.True(ok)
Expand Down Expand Up @@ -292,7 +292,7 @@ func StatusOrProcessingPreviouslyAcceptedTest(t *testing.T, factory Factory) {
require.Equal(choices.Accepted, snowmantest.Genesis.Status())
require.False(sm.Processing(snowmantest.Genesis.ID()))
require.True(sm.Decided(snowmantest.Genesis))
require.True(sm.IsPreferred(snowmantest.Genesis))
require.True(sm.IsPreferred(snowmantest.Genesis.ID()))

pref, ok := sm.PreferenceAtHeight(snowmantest.Genesis.Height())
require.True(ok)
Expand Down Expand Up @@ -330,7 +330,7 @@ func StatusOrProcessingPreviouslyRejectedTest(t *testing.T, factory Factory) {
require.Equal(choices.Rejected, block.Status())
require.False(sm.Processing(block.ID()))
require.True(sm.Decided(block))
require.False(sm.IsPreferred(block))
require.False(sm.IsPreferred(block.ID()))

_, ok := sm.PreferenceAtHeight(block.Height())
require.False(ok)
Expand Down Expand Up @@ -366,7 +366,7 @@ func StatusOrProcessingUnissuedTest(t *testing.T, factory Factory) {
require.Equal(choices.Processing, block.Status())
require.False(sm.Processing(block.ID()))
require.False(sm.Decided(block))
require.False(sm.IsPreferred(block))
require.False(sm.IsPreferred(block.ID()))

_, ok := sm.PreferenceAtHeight(block.Height())
require.False(ok)
Expand Down Expand Up @@ -403,7 +403,7 @@ func StatusOrProcessingIssuedTest(t *testing.T, factory Factory) {
require.Equal(choices.Processing, block.Status())
require.True(sm.Processing(block.ID()))
require.False(sm.Decided(block))
require.True(sm.IsPreferred(block))
require.True(sm.IsPreferred(block.ID()))

pref, ok := sm.PreferenceAtHeight(block.Height())
require.True(ok)
Expand Down Expand Up @@ -968,10 +968,10 @@ func RecordPollChangePreferredChainTest(t *testing.T, factory Factory) {

require.Equal(a2Block.ID(), sm.Preference())

require.True(sm.IsPreferred(a1Block))
require.True(sm.IsPreferred(a2Block))
require.False(sm.IsPreferred(b1Block))
require.False(sm.IsPreferred(b2Block))
require.True(sm.IsPreferred(a1Block.ID()))
require.True(sm.IsPreferred(a2Block.ID()))
require.False(sm.IsPreferred(b1Block.ID()))
require.False(sm.IsPreferred(b2Block.ID()))

pref, ok := sm.PreferenceAtHeight(a1Block.Height())
require.True(ok)
Expand All @@ -985,10 +985,10 @@ func RecordPollChangePreferredChainTest(t *testing.T, factory Factory) {
require.NoError(sm.RecordPoll(context.Background(), b2Votes))

require.Equal(b2Block.ID(), sm.Preference())
require.False(sm.IsPreferred(a1Block))
require.False(sm.IsPreferred(a2Block))
require.True(sm.IsPreferred(b1Block))
require.True(sm.IsPreferred(b2Block))
require.False(sm.IsPreferred(a1Block.ID()))
require.False(sm.IsPreferred(a2Block.ID()))
require.True(sm.IsPreferred(b1Block.ID()))
require.True(sm.IsPreferred(b2Block.ID()))

pref, ok = sm.PreferenceAtHeight(b1Block.Height())
require.True(ok)
Expand All @@ -1003,10 +1003,10 @@ func RecordPollChangePreferredChainTest(t *testing.T, factory Factory) {
require.NoError(sm.RecordPoll(context.Background(), a1Votes))

require.Equal(a2Block.ID(), sm.Preference())
require.True(sm.IsPreferred(a1Block))
require.True(sm.IsPreferred(a2Block))
require.False(sm.IsPreferred(b1Block))
require.False(sm.IsPreferred(b2Block))
require.True(sm.IsPreferred(a1Block.ID()))
require.True(sm.IsPreferred(a2Block.ID()))
require.False(sm.IsPreferred(b1Block.ID()))
require.False(sm.IsPreferred(b2Block.ID()))

pref, ok = sm.PreferenceAtHeight(a1Block.Height())
require.True(ok)
Expand Down
8 changes: 2 additions & 6 deletions snow/consensus/snowman/topological.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,12 +204,8 @@ func (ts *Topological) Processing(blkID ids.ID) bool {
return ok
}

func (ts *Topological) IsPreferred(blk Block) bool {
// If the block is accepted, then it must be transitively preferred.
if blk.Status() == choices.Accepted {
return true
}
return ts.preferredIDs.Contains(blk.ID())
func (ts *Topological) IsPreferred(blkID ids.ID) bool {
return blkID == ts.lastAcceptedID || ts.preferredIDs.Contains(blkID)
}

func (ts *Topological) LastAccepted() (ids.ID, uint64) {
Expand Down
4 changes: 2 additions & 2 deletions snow/engine/snowman/transitive.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1018,14 +1018,14 @@ func (t *Transitive) deliver(

// If the block is now preferred, query the network for its preferences
// with this new block.
if t.Consensus.IsPreferred(blk) {
if t.Consensus.IsPreferred(blkID) {
t.sendQuery(ctx, blkID, blk.Bytes(), push)
}

t.blocked.Fulfill(ctx, blkID)
for _, blk := range added {
blkID := blk.ID()
if t.Consensus.IsPreferred(blk) {
if t.Consensus.IsPreferred(blkID) {
t.sendQuery(ctx, blkID, blk.Bytes(), push)
}

Expand Down
Loading