Merge branch 'main' into fix/audit

.golangci.yaml → .github/golangci.yaml

@@ -22,8 +22,8 @@ issues:
     - path: (.+)_test.go
       linters:
         - nilnil
-        - unused
-        - errcheck
+        - gosec
+        - lll
 
 linters:
   fast: false
@@ -34,14 +34,13 @@ linters:
     - bidichk # Checks for dangerous unicode character sequences
     - durationcheck # Check for two durations multiplied together
     - errcheck # Forces to not skip error check
-    - exportloopref # Checks for pointers to enclosing loop variables
+    - copyloopvar # Checks for pointers to enclosing loop variables
     - gocritic # Bundles different linting checks
     - godot # Checks for periods at the end of comments
     - gomoddirectives # Allow or ban replace directives in go.mod
     - gosimple # Code simplification
     - govet # Official Go tool
     - ineffassign # Detects when assignments to existing variables are not used
-    - interfacer # Top-level interface suggestions
     - nakedret # Finds naked/bare returns and requires change them
     - nilerr # Requires explicit returns
     - nilnil # Requires explicit returns
@@ -78,7 +77,6 @@ linters:
     - gofumpt # Stricter gofmt
     - goimports # Unused imports
     - goconst # Repeated strings that could be replaced by a constant
-    - forcetypeassert # Finds forced type assertions
     - dogsled # Checks assignments with too many blank identifiers (e.g. x, , , _, := f())
     - dupl # Code clone detection
     - errname # Checks that sentinel errors are prefixed with the Err and error types are suffixed with the Error
@@ -100,7 +98,7 @@ linters-settings:
       - importShadow
       - unnamedResult
   errcheck:
-    check-type-assertions: true
+    check-type-assertions: false
     check-blank: true
     exclude-functions:
       - io/ioutil.ReadFile

.github/workflows/lint.yaml

@@ -9,7 +9,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.21.x
+          go-version: 1.22.x
 
       - name: Checkout code
         uses: actions/checkout@v3

.github/workflows/test.yaml

@@ -9,7 +9,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.21.x
+          go-version: 1.22.x
 
       - name: Checkout code
         uses: actions/checkout@v3
@@ -23,7 +23,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.21.x
+          go-version: 1.22.x
 
       - name: Checkout code
         uses: actions/checkout@v3

Makefile

@@ -1,6 +1,6 @@
 .PHONY: lint
 lint:
-	golangci-lint run --config .golangci.yaml
+	golangci-lint run --config .github/golangci.yaml
 
 .PHONY: gofumpt
 gofumpt:

NOTICE.md

@@ -5,7 +5,7 @@ https://github.com/0xPolygon/go-ibft
 
 The original and sole authors of this source code ([@zivkovicmilos](https://github.com/zivkovicmilos)
 and [@dbrajovic](https://github.com/dbrajovic)) have decided to
-continue maintaining this project under the [madz-lab](https://github.com/madz-lab) organization and have continued
+continue maintaining this project under the [sig-0](https://github.com/sig-0) organization and have continued
 licensing this work under the Apache 2 license.
 
 The work contained in this repository is a continuation of work from commit

README.md

@@ -16,7 +16,7 @@ transaction execution or block building mechanics. That responsibility is left t
 
 To get up and running with the `go-ibft` package, you can pull it into your project using:
 
-`go get github.com/madz-lab/go-ibft`
+`go get github.com/sig-0/go-ibft`
 
 Currently, the minimum required go version is `go 1.19`.
 
@@ -25,7 +25,7 @@ Currently, the minimum required go version is `go 1.19`.
 ```go
 package main
 
-import "github.com/madz-lab/go-ibft"
+import "github.com/sig-0/go-ibft"
 
 // IBFTBackend is the structure that implements all required
 // go-ibft Backend interfaces

core/backend.go

@@ -1,8 +1,8 @@
 package core
 
 import (
-	"github.com/madz-lab/go-ibft/messages"
-	"github.com/madz-lab/go-ibft/messages/proto"
+	"github.com/sig-0/go-ibft/messages"
+	"github.com/sig-0/go-ibft/messages/proto"
 )
 
 // MessageConstructor defines a message constructor interface

core/consensus_test.go

@@ -7,8 +7,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/madz-lab/go-ibft/messages"
-	"github.com/madz-lab/go-ibft/messages/proto"
+	"github.com/sig-0/go-ibft/messages"
+	"github.com/sig-0/go-ibft/messages/proto"
 	"github.com/stretchr/testify/assert"
 )
 

core/ibft.go

@@ -9,8 +9,8 @@ import (
 	"sync"
 	"time"
 
-	"github.com/madz-lab/go-ibft/messages"
-	"github.com/madz-lab/go-ibft/messages/proto"
+	"github.com/sig-0/go-ibft/messages"
+	"github.com/sig-0/go-ibft/messages/proto"
 )
 
 type Logger interface {
@@ -409,7 +409,7 @@ func (i *IBFT) waitForRCC(
 			messages.SubscriptionDetails{
 				MessageType:    proto.MessageType_ROUND_CHANGE,
 				View:           view,
-				MinNumMessages: int(quorum),
+				MinNumMessages: int(quorum), //nolint:gosec // Quorum cannot exceed int limits
 			},
 		)
 	)
@@ -461,7 +461,7 @@ func (i *IBFT) handleRoundChangeMessage(view *proto.View, quorum uint64) *proto.
 		isValidFn,
 	)
 
-	if len(msgs) < int(quorum) {
+	if len(msgs) < int(quorum) { //nolint:gosec // Quorum cannot exceed int limits
 		return nil
 	}
 
@@ -696,10 +696,11 @@ func (i *IBFT) validateRoundChangeCertificate(
 	}
 
 	// Make sure there are Quorum RCC
+	//nolint:gosec // Quorum cannot exceed int limits
 	if len(certificate.RoundChangeMessages) < int(i.backend.Quorum(view.Height)) {
 		return fmt.Errorf("no quorum round change messages in certificate: expected=%d actual=%d",
 			len(certificate.RoundChangeMessages),
-			int(i.backend.Quorum(view.Height)),
+			int(i.backend.Quorum(view.Height)), //nolint:gosec // Quorum cannot exceed int limits
 		)
 	}
 
@@ -796,7 +797,7 @@ func (i *IBFT) runPrepare(ctx context.Context) error {
 			messages.SubscriptionDetails{
 				MessageType:    proto.MessageType_PREPARE,
 				View:           view,
-				MinNumMessages: int(quorum) - 1,
+				MinNumMessages: int(quorum) - 1, //nolint:gosec // Quorum cannot exceed int limits
 			},
 		)
 	)
@@ -838,7 +839,7 @@ func (i *IBFT) handlePrepare(view *proto.View, quorum uint64) bool {
 		isValidPrepare,
 	)
 
-	if len(prepareMessages) < int(quorum)-1 {
+	if len(prepareMessages) < int(quorum)-1 { //nolint:gosec // Quorum cannot exceed int limits
 		//	quorum not reached, keep polling
 		return false
 	}
@@ -876,7 +877,7 @@ func (i *IBFT) runCommit(ctx context.Context) error {
 			messages.SubscriptionDetails{
 				MessageType:    proto.MessageType_COMMIT,
 				View:           view,
-				MinNumMessages: int(quorum),
+				MinNumMessages: int(quorum), //nolint:gosec // Quorum cannot exceed int limits
 			},
 		)
 	)
@@ -919,7 +920,7 @@ func (i *IBFT) handleCommit(view *proto.View, quorum uint64) bool {
 	}
 
 	commitMessages := i.messages.GetValidMessages(view, proto.MessageType_COMMIT, isValidCommit)
-	if len(commitMessages) < int(quorum) {
+	if len(commitMessages) < int(quorum) { //nolint:gosec // Quorum cannot exceed int limits
 		//	quorum not reached, keep polling
 		return false
 	}
@@ -1118,7 +1119,7 @@ func (i *IBFT) validPC(
 	)
 
 	// Make sure there are at least Quorum (PP + P) messages
-	if len(allMessages) < int(i.backend.Quorum(i.state.getHeight())) {
+	if len(allMessages) < int(i.backend.Quorum(i.state.getHeight())) { //nolint:gosec // Quorum cannot exceed int limits
 		return false
 	}