Merge pull request #122 from nspcc-dev/upgrade-go

Upgrade go

.github/workflows/go.yml

@@ -30,16 +30,12 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        go: [ '1.20', '1.21', '1.22']
+        go: [ '1.21', '1.22']
         os: [ubuntu-latest, windows-2022, macos-14]
         exclude:
           # Only latest Go version for Windows and MacOS.
-          - os: windows-2022
-            go: '1.20'
           - os: windows-2022
             go: '1.21'
-          - os: macos-14
-            go: '1.20'
           - os: macos-14
             go: '1.21'
           # Exclude latest Go version for Ubuntu as Coverage uses it.

CHANGELOG.md

@@ -9,6 +9,7 @@ New features:
 Behaviour changes:
 
 Improvements:
+ * minimum required Go version is 1.21 (#122)
 
 Bugs fixed:
 

config.go

@@ -31,7 +31,8 @@ type Config[H Hash] struct {
 	// NewBlockFromContext should allocate, fill from Context and return new block.Block.
 	NewBlockFromContext func(ctx *Context[H]) Block[H]
 	// RequestTx is a callback which is called when transaction contained
-	// in current block can't be found in memory pool.
+	// in current block can't be found in memory pool. The slice received by
+	// this callback MUST NOT be changed.
 	RequestTx func(h ...H)
 	// StopTxFlow is a callback which is called when the process no longer needs
 	// any transactions.

context.go

@@ -228,11 +228,9 @@ func (c *Context[H]) reset(view byte, ts uint64) {
 		c.Validators = c.Config.GetValidators()
 
 		n := len(c.Validators)
-		c.LastChangeViewPayloads = make([]ConsensusPayload[H], n)
+		c.LastChangeViewPayloads = emptyReusableSlice(c.LastChangeViewPayloads, n)
 
-		if c.LastSeenMessage == nil {
-			c.LastSeenMessage = make([]*HeightView, n)
-		}
+		c.LastSeenMessage = emptyReusableSlice(c.LastSeenMessage, n)
 		c.blockProcessed = false
 		c.preBlockProcessed = false
 	} else {
@@ -252,16 +250,22 @@ func (c *Context[H]) reset(view byte, ts uint64) {
 	c.header = nil
 
 	n := len(c.Validators)
-	c.ChangeViewPayloads = make([]ConsensusPayload[H], n)
+	c.ChangeViewPayloads = emptyReusableSlice(c.ChangeViewPayloads, n)
 	if view == 0 {
-		c.PreCommitPayloads = make([]ConsensusPayload[H], n)
-		c.CommitPayloads = make([]ConsensusPayload[H], n)
+		c.PreCommitPayloads = emptyReusableSlice(c.PreCommitPayloads, n)
+		c.CommitPayloads = emptyReusableSlice(c.CommitPayloads, n)
 	}
-	c.PreparationPayloads = make([]ConsensusPayload[H], n)
+	c.PreparationPayloads = emptyReusableSlice(c.PreparationPayloads, n)
 
-	c.Transactions = make(map[H]Transaction[H])
+	if c.Transactions == nil { // Init.
+		c.Transactions = make(map[H]Transaction[H])
+	} else { // Regular use.
+		clear(c.Transactions)
+	}
 	c.TransactionHashes = nil
-	c.MissingTransactions = nil
+	if c.MissingTransactions != nil {
+		c.MissingTransactions = c.MissingTransactions[:0]
+	}
 	c.PrimaryIndex = c.GetPrimaryIndex(view)
 	c.ViewNumber = view
 
@@ -270,6 +274,14 @@ func (c *Context[H]) reset(view byte, ts uint64) {
 	}
 }
 
+func emptyReusableSlice[E any](s []E, n int) []E {
+	if len(s) == n {
+		clear(s)
+		return s
+	}
+	return make([]E, n)
+}
+
 // Fill initializes consensus when node is a speaker.
 func (c *Context[H]) Fill() {
 	b := make([]byte, 8)

dbft.go

@@ -2,6 +2,7 @@ package dbft
 
 import (
 	"fmt"
+	"slices"
 	"sync"
 	"time"
 
@@ -150,9 +151,7 @@ func (d *DBFT[H]) initializeConsensus(view byte, ts uint64) {
 		var ts = d.Timer.Now()
 		var diff = ts.Sub(d.lastBlockTime)
 		timeout -= diff
-		if timeout < 0 {
-			timeout = 0
-		}
+		timeout = max(0, timeout)
 	}
 	d.changeTimer(timeout)
 }
@@ -171,22 +170,17 @@ func (d *DBFT[H]) OnTransaction(tx Transaction[H]) {
 		return
 	}
 
-	for i := range d.MissingTransactions {
-		if tx.Hash() == d.MissingTransactions[i] {
-			d.addTransaction(tx)
-			// `addTransaction` checks for responses and commits. If this was the last transaction
-			// Context could be initialized on a new height, clearing this field.
-			if len(d.MissingTransactions) == 0 {
-				return
-			}
-			theLastOne := len(d.MissingTransactions) - 1
-			if i < theLastOne {
-				d.MissingTransactions[i] = d.MissingTransactions[theLastOne]
-			}
-			d.MissingTransactions = d.MissingTransactions[:theLastOne]
-			return
-		}
+	i := slices.Index(d.MissingTransactions, tx.Hash())
+	if i < 0 {
+		return
+	}
+	d.addTransaction(tx)
+	// `addTransaction` checks for responses and commits. If this was the last transaction
+	// Context could be initialized on a new height, clearing this field.
+	if len(d.MissingTransactions) == 0 {
+		return
 	}
+	d.MissingTransactions = slices.Delete(d.MissingTransactions, i, i+1)
 }
 
 // OnTimeout advances state machine as if timeout was fired.
@@ -340,24 +334,21 @@ func (d *DBFT[H]) onPrepareRequest(msg ConsensusPayload[H]) {
 }
 
 func (d *DBFT[H]) processMissingTx() {
-	missing := make([]H, 0, len(d.TransactionHashes)/2)
-
 	for _, h := range d.TransactionHashes {
 		if _, ok := d.Transactions[h]; ok {
 			continue
 		}
 		if tx := d.GetTx(h); tx == nil {
-			missing = append(missing, h)
+			d.MissingTransactions = append(d.MissingTransactions, h)
 		} else {
 			d.Transactions[h] = tx
 		}
 	}
 
-	if len(missing) != 0 {
-		d.MissingTransactions = missing
+	if len(d.MissingTransactions) != 0 {
 		d.Logger.Info("missing tx",
-			zap.Int("count", len(missing)))
-		d.RequestTx(missing...)
+			zap.Int("count", len(d.MissingTransactions)))
+		d.RequestTx(d.MissingTransactions...)
 	}
 }
 

go.mod

@@ -1,6 +1,6 @@
 module github.com/nspcc-dev/dbft
 
-go 1.20
+go 1.21
 
 require (
 	github.com/stretchr/testify v1.9.0

go.sum

@@ -7,6 +7,7 @@ github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8
 github.com/twmb/murmur3 v1.1.8 h1:8Yt9taO/WN3l08xErzjeschgZU2QSrwm1kclYq+0aRg=
 github.com/twmb/murmur3 v1.1.8/go.mod h1:Qq/R7NUyOfr65zD+6Q5IHKsJLwP7exErjN6lyyq3OSQ=
 go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto=
+go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE=
 go.uber.org/multierr v1.10.0 h1:S0h4aNzvfcFsC3dRF1jLoaov7oRaKqRGC/pUEJ2yvPQ=
 go.uber.org/multierr v1.10.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN80Y=
 go.uber.org/zap v1.27.0 h1:aJMhYGrd5QSmlpLMr2MftRKl7t8J8PTZPA732ud/XR8=

internal/simulation/main.go

@@ -9,7 +9,7 @@ import (
 	"net/http/pprof"
 	"os"
 	"os/signal"
-	"sort"
+	"slices"
 	"sync"
 	"syscall"
 	"time"
@@ -152,10 +152,10 @@ func updatePublicKeys(nodes []*simNode, n int) {
 }
 
 func sortValidators(pubs []dbft.PublicKey) {
-	sort.Slice(pubs, func(i, j int) bool {
-		p1, _ := pubs[i].(*crypto.ECDSAPub).MarshalBinary()
-		p2, _ := pubs[j].(*crypto.ECDSAPub).MarshalBinary()
-		return murmur3.Sum64(p1) < murmur3.Sum64(p2)
+	slices.SortFunc(pubs, func(a, b dbft.PublicKey) int {
+		p1, _ := a.(*crypto.ECDSAPub).MarshalBinary()
+		p2, _ := b.(*crypto.ECDSAPub).MarshalBinary()
+		return int(murmur3.Sum64(p2)) - int(murmur3.Sum64(p1))
 	})
 }