Tidy repo

sig-0 · Aug 1, 2024 · ff31d34 · ff31d34
1 parent e422d22
commit ff31d34
Show file tree

Hide file tree

Showing 24 changed files with 86 additions and 89 deletions.
diff --git a/.golangci.yaml → .github/golangci.yaml b/.golangci.yaml → .github/golangci.yaml
@@ -22,8 +22,8 @@ issues:
     - path: (.+)_test.go
       linters:
         - nilnil
-        - unused
-        - errcheck
+        - gosec
+        - lll
 
 linters:
   fast: false
@@ -41,7 +41,6 @@ linters:
     - 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

diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -9,7 +9,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.19.x
+          go-version: 1.22.x
 
       - name: Checkout code
         uses: actions/checkout@v3

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -9,7 +9,7 @@ jobs:
       - name: Install Go
         uses: actions/setup-go@v3
         with:
-          go-version: 1.19.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.19.x
+          go-version: 1.22.x
 
       - name: Checkout code
         uses: actions/checkout@v3

diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 .PHONY: lint
 lint:
-	golangci-lint run --config .golangci.yaml
+	golangci-lint run --config .github/golangci.yaml
 
 .PHONY: gofumpt
 gofumpt:

diff --git a/NOTICE.md b/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

diff --git a/README.md b/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

diff --git a/core/backend.go b/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

diff --git a/core/consensus_test.go b/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"
 )
 
@@ -189,12 +189,12 @@ func TestConsensus_ValidFlow(t *testing.T) {
 		}
 
 		// Make sure the prepare message is built correctly
-		backend.buildPrepareMessageFn = func(proposal []byte, view *proto.View) *proto.Message {
+		backend.buildPrepareMessageFn = func(_ []byte, view *proto.View) *proto.Message {
 			return buildBasicPrepareMessage(proposalHash, nodes[nodeIndex], view)
 		}
 
 		// Make sure the commit message is built correctly
-		backend.buildCommitMessageFn = func(proposal []byte, view *proto.View) *proto.Message {
+		backend.buildCommitMessageFn = func(_ []byte, view *proto.View) *proto.Message {
 			return buildBasicCommitMessage(proposalHash, committedSeal, nodes[nodeIndex], view)
 		}
 
@@ -221,7 +221,7 @@ func TestConsensus_ValidFlow(t *testing.T) {
 
 				// Set the proposal creation method for node 0, since
 				// they are the proposer
-				backend.buildProposalFn = func(u uint64) []byte {
+				backend.buildProposalFn = func(_ uint64) []byte {
 					return proposal
 				}
 			},
@@ -363,12 +363,12 @@ func TestConsensus_InvalidBlock(t *testing.T) {
 		}
 
 		// Make sure the prepare message is built correctly
-		backend.buildPrepareMessageFn = func(proposal []byte, view *proto.View) *proto.Message {
+		backend.buildPrepareMessageFn = func(_ []byte, view *proto.View) *proto.Message {
 			return buildBasicPrepareMessage(proposalHashes[view.Round], nodes[nodeIndex], view)
 		}
 
 		// Make sure the commit message is built correctly
-		backend.buildCommitMessageFn = func(proposal []byte, view *proto.View) *proto.Message {
+		backend.buildCommitMessageFn = func(_ []byte, view *proto.View) *proto.Message {
 			return buildBasicCommitMessage(proposalHashes[view.Round], committedSeal, nodes[nodeIndex], view)
 		}
 

diff --git a/core/ibft.go b/core/ibft.go
@@ -8,8 +8,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 {

diff --git a/core/ibft_test.go b/core/ibft_test.go
@@ -8,8 +8,9 @@ import (
 	"testing"
 	"time"
 
-	"github.com/madz-lab/go-ibft/messages"
-	"github.com/madz-lab/go-ibft/messages/proto"
+	"github.com/rs/xid"
+	"github.com/sig-0/go-ibft/messages"
+	"github.com/sig-0/go-ibft/messages/proto"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -260,7 +261,7 @@ func TestRunNewRound_Proposer(t *testing.T) {
 						cancelFn()
 
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: make(chan uint64),
 						}
 					},
@@ -356,16 +357,16 @@ func TestRunNewRound_Proposer(t *testing.T) {
 				messages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
 					unsubscribeFn: func(_ messages.SubscriptionID) {
 						cancelFn()
 					},
 					getValidMessagesFn: func(
-						view *proto.View,
-						messageType proto.MessageType,
+						_ *proto.View,
+						_ proto.MessageType,
 						isValid func(message *proto.Message) bool,
 					) []*proto.Message {
 						return filterMessages(
@@ -513,16 +514,16 @@ func TestRunNewRound_Proposer(t *testing.T) {
 				messages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
 					unsubscribeFn: func(_ messages.SubscriptionID) {
 						cancelFn()
 					},
 					getValidMessagesFn: func(
-						view *proto.View,
-						messageType proto.MessageType,
+						_ *proto.View,
+						_ proto.MessageType,
 						isValid func(message *proto.Message) bool,
 					) []*proto.Message {
 						return filterMessages(
@@ -591,7 +592,7 @@ func TestRunNewRound_Validator_Zero(t *testing.T) {
 			quorumFn: func(_ uint64) uint64 {
 				return 1
 			},
-			buildPrepareMessageFn: func(proposal []byte, view *proto.View) *proto.Message {
+			buildPrepareMessageFn: func(_ []byte, view *proto.View) *proto.Message {
 				return &proto.Message{
 					View: view,
 					Type: proto.MessageType_PREPARE,
@@ -612,7 +613,7 @@ func TestRunNewRound_Validator_Zero(t *testing.T) {
 		messages = mockMessages{
 			subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 				return &messages.Subscription{
-					ID:    messages.SubscriptionID(1),
+					ID:    messages.SubscriptionID(xid.New()),
 					SubCh: notifyCh,
 				}
 			},
@@ -759,7 +760,7 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
 					quorumFn: func(_ uint64) uint64 {
 						return 1
 					},
-					buildPrepareMessageFn: func(proposal []byte, view *proto.View) *proto.Message {
+					buildPrepareMessageFn: func(_ []byte, view *proto.View) *proto.Message {
 						return &proto.Message{
 							View: view,
 							Type: proto.MessageType_PREPARE,
@@ -780,15 +781,15 @@ func TestRunNewRound_Validator_NonZero(t *testing.T) {
 				messages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
 					unsubscribeFn: func(_ messages.SubscriptionID) {
 						cancelFn()
 					},
 					getValidMessagesFn: func(
-						view *proto.View,
+						_ *proto.View,
 						_ proto.MessageType,
 						isValid func(message *proto.Message) bool,
 					) []*proto.Message {
@@ -875,7 +876,7 @@ func TestRunPrepare(t *testing.T) {
 				messages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
@@ -982,7 +983,7 @@ func TestRunCommit(t *testing.T) {
 				messages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
@@ -1138,11 +1139,12 @@ func TestIBFT_IsAcceptableMessage(t *testing.T) {
 				log       = mockLogger{}
 				transport = mockTransport{}
 				backend   = mockBackend{
-					isValidSenderFn: func(message *proto.Message) bool {
+					isValidSenderFn: func(_ *proto.Message) bool {
 						return !testCase.invalidSender
 					},
 				}
 			)
+
 			i := NewIBFT(log, backend, transport)
 			i.state.view = testCase.currentView
 
@@ -1177,6 +1179,7 @@ func TestIBFT_StartRoundTimer(t *testing.T) {
 
 		wg.Add(1)
 		i.wg.Add(1)
+
 		go func() {
 			i.startRoundTimer(ctx, 0)
 
@@ -1206,6 +1209,7 @@ func TestIBFT_StartRoundTimer(t *testing.T) {
 		ctx, cancelFn := context.WithCancel(context.Background())
 
 		wg.Add(1)
+
 		go func() {
 			defer func() {
 				wg.Done()
@@ -1362,12 +1366,12 @@ func TestIBFT_FutureProposal(t *testing.T) {
 				mMessages = mockMessages{
 					subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 						return &messages.Subscription{
-							ID:    messages.SubscriptionID(1),
+							ID:    messages.SubscriptionID(xid.New()),
 							SubCh: notifyCh,
 						}
 					},
 					getValidMessagesFn: func(
-						view *proto.View,
+						_ *proto.View,
 						_ proto.MessageType,
 						isValid func(message *proto.Message) bool,
 					) []*proto.Message {
@@ -1385,6 +1389,7 @@ func TestIBFT_FutureProposal(t *testing.T) {
 			i.messages = mMessages
 
 			wg.Add(1)
+
 			go func() {
 				defer func() {
 					cancelFn()
@@ -1797,7 +1802,7 @@ func TestIBFT_ValidPC(t *testing.T) {
 				isProposerFn: func(proposer []byte, _ uint64, _ uint64) bool {
 					return bytes.Equal(proposer, sender)
 				},
-				isValidSenderFn: func(message *proto.Message) bool {
+				isValidSenderFn: func(_ *proto.Message) bool {
 					return true
 				},
 			}
@@ -2114,13 +2119,13 @@ func TestIBFT_WatchForFutureRCC(t *testing.T) {
 		messages = mockMessages{
 			subscribeFn: func(_ messages.SubscriptionDetails) *messages.Subscription {
 				return &messages.Subscription{
-					ID:    messages.SubscriptionID(1),
+					ID:    messages.SubscriptionID(xid.New()),
 					SubCh: notifyCh,
 				}
 			},
 			getValidMessagesFn: func(
-				view *proto.View,
-				messageType proto.MessageType,
+				_ *proto.View,
+				_ proto.MessageType,
 				isValid func(message *proto.Message) bool,
 			) []*proto.Message {
 				return filterMessages(

diff --git a/core/mock_test.go b/core/mock_test.go
@@ -7,8 +7,8 @@ import (
 	"sync/atomic"
 	"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"
 )
 
 // Define delegation methods