Merge pull request #403 from iotaledger/chore/linter

Expands GolangCI linters

.github/workflows/golangci-lint.yml

@@ -0,0 +1,21 @@
+name: GolangCIlint
+
+on:
+  pull_request:
+
+jobs:
+  golangci-lint:
+    name: GolangCI-Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v3
+
+      - name: golangci-lint
+        uses: reviewdog/action-golangci-lint@v2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          golangci_lint_flags: "--timeout=10m"
+          reporter: github-pr-check
+          filter_mode: nofilter
+          fail_on_error: true

.golangci.yml

@@ -0,0 +1,46 @@
+run:
+  tests: true
+  skip-dirs:
+    - bech32
+    - tpkg
+
+linters-settings:
+  gofmt:
+    simplify: true
+  goimports:
+    local-prefixes: github.com/iotaledger
+  golint:
+    min-confidence: 0.9
+  gocyclo:
+    min-complexity: 15
+  govet:
+    check-shadowing: false
+  misspell:
+    locale: US
+  staticcheck:
+    checks: ["all"]
+  stylecheck:
+    initialisms: ["ACL", "API", "ASCII", "CPU", "CSS", "DNS", "EOF", "GUID", "HTML", "HTTP", "HTTPS", "ID", "IP", "JSON", "QPS", "RAM", "RPC", "SLA", "SMTP", "SQL", "SSH", "TCP", "TLS", "TTL", "UDP", "UI", "GID", "UID", "UUID", "URI", "URL", "UTF8", "VM", "XML", "XMPP", "XSRF", "XSS", "SIP", "RTP", "AMQP", "DB", "TS"]
+
+linters:
+  enable:
+    - durationcheck
+    - errcheck
+    - errname
+    - goconst
+    - godot
+    - gofmt
+    - goimports
+    - gosec
+    - govet
+    - ifshort
+    - importas
+    - misspell
+    - nilnil
+    - prealloc
+    - predeclared
+    - promlinter
+    - staticcheck
+    - unconvert
+    - unparam
+#    - gomnd

address.go

@@ -25,6 +25,7 @@ func (addrType AddressType) String() string {
 	if int(addrType) >= len(addressNames) {
 		return fmt.Sprintf("unknown address type: %d", addrType)
 	}
+
 	return addressNames[addrType]
 }
 

address_alias.go

@@ -4,8 +4,9 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/iotaledger/hive.go/serializer/v2"
 	"golang.org/x/crypto/blake2b"
+
+	"github.com/iotaledger/hive.go/serializer/v2"
 )
 
 const (
@@ -15,10 +16,6 @@ const (
 	AliasAddressSerializedBytesSize = serializer.SmallTypeDenotationByteSize + AliasAddressBytesLength
 )
 
-var (
-	emptyAliasAddress = [AliasAddressBytesLength]byte{}
-)
-
 // ParseAliasAddressFromHexString parses the given hex string into an AliasAddress.
 func ParseAliasAddressFromHexString(hexAddr string) (*AliasAddress, error) {
 	addrBytes, err := DecodeHex(hexAddr)

address_ed25519.go

@@ -5,8 +5,9 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/iotaledger/hive.go/serializer/v2"
 	"golang.org/x/crypto/blake2b"
+
+	"github.com/iotaledger/hive.go/serializer/v2"
 )
 
 const (

address_nft.go

@@ -4,8 +4,9 @@ import (
 	"encoding/json"
 	"fmt"
 
-	"github.com/iotaledger/hive.go/serializer/v2"
 	"golang.org/x/crypto/blake2b"
+
+	"github.com/iotaledger/hive.go/serializer/v2"
 )
 
 const (
@@ -15,10 +16,6 @@ const (
 	NFTAddressSerializedBytesSize = serializer.SmallTypeDenotationByteSize + NFTAddressBytesLength
 )
 
-var (
-	emptyNFTAddress = [NFTAddressBytesLength]byte{}
-)
-
 // ParseNFTAddressFromHexString parses the given hex string into an NFTAddress.
 func ParseNFTAddressFromHexString(hexAddr string) (*NFTAddress, error) {
 	addrBytes, err := DecodeHex(hexAddr)

address_test.go

@@ -3,9 +3,10 @@ package iotago_test
 import (
 	"testing"
 
-	"github.com/iotaledger/iota.go/v3"
-	"github.com/iotaledger/iota.go/v3/tpkg"
 	"github.com/stretchr/testify/assert"
+
+	iotago "github.com/iotaledger/iota.go/v3"
+	"github.com/iotaledger/iota.go/v3/tpkg"
 )
 
 func TestAddressDeSerialize(t *testing.T) {

bech32/internal/base32/base32.go

@@ -1,6 +1,7 @@
 // Package base32 implements the conversion for bytes (base256) to base32.
 package base32
 
+//lint:gomnd
 import (
 	"errors"
 	"fmt"

benches_test.go

@@ -5,7 +5,7 @@ import (
 	"testing"
 
 	"github.com/iotaledger/hive.go/serializer/v2"
-	"github.com/iotaledger/iota.go/v3"
+	iotago "github.com/iotaledger/iota.go/v3"
 	iotagoEd25519 "github.com/iotaledger/iota.go/v3/ed25519"
 	"github.com/iotaledger/iota.go/v3/tpkg"
 )
@@ -24,7 +24,7 @@ func BenchmarkDeserializeWithValidationOneIOTxPayload(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		target.Deserialize(data, serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
+		_, _ = target.Deserialize(data, serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
 	}
 }
 
@@ -80,7 +80,7 @@ func BenchmarkDeserializeWithValidationLargeTxPayload(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		target.Deserialize(data, serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
+		_, _ = target.Deserialize(data, serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
 	}
 }
 
@@ -98,23 +98,23 @@ func BenchmarkDeserializeWithoutValidationOneIOTxPayload(b *testing.B) {
 
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		target.Deserialize(data, serializer.DeSeriModeNoValidation, tpkg.TestProtoParas)
+		_, _ = target.Deserialize(data, serializer.DeSeriModeNoValidation, tpkg.TestProtoParas)
 	}
 }
 
 func BenchmarkSerializeWithValidationOneIOTxPayload(b *testing.B) {
 	txPayload := tpkg.OneInputOutputTransaction()
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		txPayload.Serialize(serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
+		_, _ = txPayload.Serialize(serializer.DeSeriModePerformValidation, tpkg.TestProtoParas)
 	}
 }
 
 func BenchmarkSerializeWithoutValidationOneIOTxPayload(b *testing.B) {
 	sigTxPayload := tpkg.OneInputOutputTransaction()
 	b.ResetTimer()
 	for i := 0; i < b.N; i++ {
-		sigTxPayload.Serialize(serializer.DeSeriModeNoValidation, tpkg.TestProtoParas)
+		_, _ = sigTxPayload.Serialize(serializer.DeSeriModeNoValidation, tpkg.TestProtoParas)
 	}
 }
 

block.go

@@ -29,7 +29,7 @@ var (
 	// ErrBlockExceedsMaxSize gets returned when a serialized block exceeds BlockBinSerializedMaxSize.
 	ErrBlockExceedsMaxSize = errors.New("block exceeds max size")
 
-	// is an empty block ID
+	// is an empty block ID.
 	emptyBlockID = BlockID{}
 
 	blockPayloadGuard = serializer.SerializableGuard{

builder/block_builder.go

@@ -3,8 +3,9 @@ package builder
 import (
 	"context"
 	"fmt"
+
 	"github.com/iotaledger/hive.go/serializer/v2"
-	"github.com/iotaledger/iota.go/v3"
+	iotago "github.com/iotaledger/iota.go/v3"
 	"github.com/iotaledger/iota.go/v3/nodeclient"
 	"github.com/iotaledger/iota.go/v3/pow"
 )
@@ -84,7 +85,7 @@ func (mb *BlockBuilder) Parents(parents iotago.BlockIDs) *BlockBuilder {
 }
 
 // ProofOfWork does the proof-of-work needed in order to satisfy the given target score.
-// It can be cancelled by cancelling the given context.
+// It can be canceled by canceling the given context.
 // This function should normally appear as the last step before Build.
 func (mb *BlockBuilder) ProofOfWork(ctx context.Context, protoParas *iotago.ProtocolParameters, targetScore float64, numWorkers ...int) *BlockBuilder {
 	if mb.err != nil {

builder/block_builder_test.go

@@ -2,12 +2,14 @@ package builder_test
 
 import (
 	"context"
-	"github.com/stretchr/testify/require"
 	"math/rand"
+
 	"os"
 	"testing"
 	"time"
 
+	"github.com/stretchr/testify/require"
+
 	iotago "github.com/iotaledger/iota.go/v3"
 	"github.com/iotaledger/iota.go/v3/builder"
 	"github.com/iotaledger/iota.go/v3/tpkg"

chain.go

@@ -81,7 +81,7 @@ type StateTransitionValidationFunc func(current ChainConstrainedOutput, next Cha
 // This function is a no-op if the chain output does not contain an IssuerFeature.
 func IsIssuerOnOutputUnlocked(output ChainConstrainedOutput, unlockedIdents UnlockedIdentities) error {
 	immFeats := output.ImmutableFeatureSet()
-	if immFeats == nil || len(immFeats) == 0 {
+	if len(immFeats) == 0 {
 		return nil
 	}
 

ed25519/ed25519_test.go

@@ -1,3 +1,5 @@
+//#nosec G404
+
 package ed25519_test
 
 import (

ed25519/zip215_test.go

@@ -4,8 +4,9 @@ import (
 	"encoding/hex"
 	"testing"
 
-	iotagoEd25519 "github.com/iotaledger/iota.go/v3/ed25519"
 	"github.com/stretchr/testify/assert"
+
+	iotagoEd25519 "github.com/iotaledger/iota.go/v3/ed25519"
 )
 
 var message = []byte("Zcash")

input_test.go

@@ -3,8 +3,9 @@ package iotago_test
 import (
 	"testing"
 
-	"github.com/iotaledger/iota.go/v3"
 	"github.com/stretchr/testify/require"
+
+	iotago "github.com/iotaledger/iota.go/v3"
 )
 
 func TestInputsSyntacticalUnique(t *testing.T) {

input_treasury_test.go

@@ -5,7 +5,7 @@ import (
 
 	"github.com/iotaledger/iota.go/v3/tpkg"
 
-	"github.com/iotaledger/iota.go/v3"
+	iotago "github.com/iotaledger/iota.go/v3"
 )
 
 func TestTreasuryInput_Deserialize(t *testing.T) {

input_utxo.go

@@ -15,7 +15,7 @@ const (
 	// RefUTXOIndexMax is the maximum index of a referenced UTXO.
 	RefUTXOIndexMax = MaxOutputsCount - 1
 
-	// UTXOInputSize is the size of a UTXO input: input type + tx id + index
+	// UTXOInputSize is the size of a UTXO input: input type + tx id + index.
 	UTXOInputSize = serializer.SmallTypeDenotationByteSize + TransactionIDLength + serializer.UInt16ByteSize
 )
 

input_utxo_test.go

@@ -5,8 +5,9 @@ import (
 
 	"github.com/iotaledger/iota.go/v3/tpkg"
 
-	"github.com/iotaledger/iota.go/v3"
 	"github.com/stretchr/testify/require"
+
+	iotago "github.com/iotaledger/iota.go/v3"
 )
 
 func TestUTXOInput_DeSerialize(t *testing.T) {

merklehasher/merkle_hasher.go

@@ -4,10 +4,10 @@ import (
 	"crypto"
 	"math/bits"
 
-	"github.com/iotaledger/iota.go/v3"
+	iotago "github.com/iotaledger/iota.go/v3"
 )
 
-// Domain separation prefixes
+// Domain separation prefixes.
 const (
 	LeafHashPrefix = 0
 	NodeHashPrefix = 1

merklehasher/merkle_hasher_test.go

@@ -8,10 +8,10 @@ import (
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/iotaledger/iota.go/v3"
+	iotago "github.com/iotaledger/iota.go/v3"
 	"github.com/iotaledger/iota.go/v3/merklehasher"
 
-	// import implementation
+	// import implementation.
 	_ "golang.org/x/crypto/blake2b"
 )