Merge pull request #608 from iotaledger/fix/linters

Fix/linters

Author: lmoe

packages/chain/cmt_log/cmt_log.go

@@ -30,7 +30,7 @@ import (
 	"github.com/iotaledger/wasp/packages/isc"
 	"github.com/iotaledger/wasp/packages/metrics"
 	"github.com/iotaledger/wasp/packages/tcrypto"
-	"github.com/iotaledger/wasp/packages/util/byz_quorum"
+	"github.com/iotaledger/wasp/packages/util/byzquorum"
 )
 
 // Public interface for this algorithm.
@@ -117,7 +117,7 @@ func New(
 	// Construct the object.
 	n := len(nodeIDs)
 	f := dkShare.DSS().MaxFaulty()
-	if f > byz_quorum.MaxF(n) {
+	if f > byzquorum.MaxF(n) {
 		log.LogPanicf("invalid f=%v for n=%v", f, n)
 	}
 	//

packages/dkg/node.go

@@ -22,7 +22,7 @@ import (
 	"github.com/iotaledger/wasp/packages/registry"
 	"github.com/iotaledger/wasp/packages/tcrypto"
 	"github.com/iotaledger/wasp/packages/util"
-	"github.com/iotaledger/wasp/packages/util/byz_quorum"
+	"github.com/iotaledger/wasp/packages/util/byzquorum"
 )
 
 type NodeProvider func() *Node
@@ -120,7 +120,7 @@ func (n *Node) GenerateDistributedKey(
 		return nil, invalidParams(fmt.Errorf("wrong DKG parameters: N = %d, T = %d", peerCount, threshold))
 	}
 
-	if threshold < uint16(byz_quorum.MinQuorum(int(peerCount))) {
+	if threshold < uint16(byzquorum.MinQuorum(int(peerCount))) {
 		return nil, invalidParams(fmt.Errorf("wrong DKG parameters: for N = %d value T must be at least %d", peerCount, peerCount/2+1))
 	}
 	//

packages/gpa/rbc/bracha/bracha.go

@@ -1,7 +1,7 @@
 // Copyright 2020 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-// package bracha implements Bracha's Reliable Broadcast.
+// Package bracha implements Bracha's Reliable Broadcast.
 // The original version of this RBC can be found here (see "FIG. 1. The broadcast primitive"):
 //
 //	Gabriel Bracha. 1987. Asynchronous byzantine agreement protocols. Inf. Comput.
@@ -70,7 +70,7 @@ type rbc struct {
 
 var _ gpa.GPA = &rbc{}
 
-// Create new instance of the RBC.
+// New creates new instance of the RBC.
 func New(peers []gpa.NodeID, f int, me, broadcaster gpa.NodeID, maxMsgSize int, predicate func([]byte) bool, log gpa.Logger) gpa.GPA {
 	r := &rbc{
 		n:           len(peers),

packages/gpa/test_context.go

@@ -11,7 +11,7 @@ import (
 	"github.com/samber/lo"
 )
 
-// Imitates a cluster of nodes and the medium performing the message exchange.
+// TestContext imitates a cluster of nodes and the medium performing the message exchange.
 // Inputs are processes in-order for each node individually.
 type TestContext struct {
 	nodes           map[NodeID]GPA                     // Nodes to test.
@@ -54,7 +54,7 @@ func (tc *TestContext) MsgCounts() (int, int) {
 	return tc.msgsSent, tc.msgsRecv
 }
 
-// Will add new inputs to the existing set.
+// AddInputs adds new inputs to the existing set.
 // The inputs will be overridden, if exist for the same nodes.
 func (tc *TestContext) AddInputs(inputs map[NodeID]Input) {
 	for nid := range inputs {
@@ -234,7 +234,7 @@ func (tc *TestContext) RunAll() {
 	tc.RunUntil(tc.OutOfMessagesPredicate())
 }
 
-// Returns a number of non-nil outputs.
+// NumberOfOutputs returns a number of non-nil outputs.
 func (tc *TestContext) NumberOfOutputs() int {
 	outNum := 0
 	for _, node := range tc.nodes {
@@ -245,14 +245,14 @@ func (tc *TestContext) NumberOfOutputs() int {
 	return outNum
 }
 
-// Will run until there will be at least outNum of non-nil outputs generated.
+// NumberOfOutputsPredicate runs until there will be at least outNum of non-nil outputs generated.
 func (tc *TestContext) NumberOfOutputsPredicate(outNum int) func() bool {
 	return func() bool {
 		return tc.NumberOfOutputs() >= outNum
 	}
 }
 
-// Will run until all the messages will be processed.
+// OutOfMessagesPredicate runs until all the messages will be processed.
 func (tc *TestContext) OutOfMessagesPredicate() func() bool {
 	return func() bool { return false }
 }

packages/gpa/test_message.go

@@ -5,7 +5,7 @@ package gpa
 
 const msgTypeTest MessageType = 0xff
 
-// Just a message for test cases.
+// TestMessage is just a message for test cases.
 type TestMessage struct {
 	recipient NodeID
 	sender    NodeID

packages/hashing/hash.go

@@ -1,3 +1,4 @@
+// Package hashing provides hashing utilities for the IOTA Smart Contract platform.
 package hashing
 
 import (

packages/isc/assert/assert.go

@@ -1,3 +1,4 @@
+// Package assert provides assertion utilities for the IOTA Smart Contract platform.
 package assert
 
 import (

packages/isc/assets.go

@@ -223,14 +223,14 @@ func (o ObjectSet) Sorted() []IotaObject {
 }
 
 // Iterate returns a deterministic iterator
-func (c ObjectSet) Iterate() iter.Seq[IotaObject] {
+func (o ObjectSet) Iterate() iter.Seq[IotaObject] {
 	return func(yield func(IotaObject) bool) {
-		for _, k := range slices.SortedFunc(maps.Keys(c.items), func(a, b iotago.ObjectID) int {
+		for _, k := range slices.SortedFunc(maps.Keys(o.items), func(a, b iotago.ObjectID) int {
 			return bytes.Compare(a[:], b[:])
 		}) {
 			if !yield(IotaObject{
 				ID:   k,
-				Type: c.items[k],
+				Type: o.items[k],
 			}) {
 				return
 			}
@@ -464,8 +464,8 @@ func (a *Assets) AsAssetsBagWithBalances(b *iscmove.AssetsBag) *iscmove.AssetsBa
 	}
 }
 
-// JsonTokenScheme is for now a 1:1 copy of the Stardusts version
-type JsonTokenScheme struct {
+// JSONTokenScheme is for now a 1:1 copy of the Stardusts version
+type JSONTokenScheme struct {
 	Type          int    `json:"type"`
 	MintedSupply  string `json:"mintedTokens"`
 	MeltedTokens  string `json:"meltedTokens"`

packages/isc/doc.go

@@ -1,5 +1,5 @@
 // Copyright 2020 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-// Package 'isc' defines fundamental types that are used in Wasp.
+// Package isc defines fundamental types that are used in Wasp.
 package isc

packages/isc/isctest/random.go

@@ -1,3 +1,5 @@
+// Package isctest provides testing utilities and helpers for the ISC (IOTA Smart Contracts) package.
+// It includes functionality for creating test fixtures and simulating various ISC conditions.
 package isctest
 
 import (
@@ -62,7 +64,7 @@ func RandomStateAnchor(opts ...RandomAnchorOption) isc.StateAnchor {
 	return isc.NewStateAnchor(&anchorRefWithObject, *iotatest.RandomAddress())
 }
 
-// simualte how StateAnchor is updated (state transition)
+// UpdateStateAnchor simulates how StateAnchor is updated (state transition)
 // assume the AssetsBag keep unchanged
 func UpdateStateAnchor(anchor *isc.StateAnchor, stateMetadata ...[]byte) *isc.StateAnchor {
 	// a := anchor.Clone()

packages/isc/sandbox_interface.go

@@ -390,7 +390,7 @@ type StateAnchor struct {
 	iscPackage iotago.Address
 }
 
-// Every time changing the L1 state of the Anchor object, the nodes should create
+// NewStateAnchor creates a new state anchor. Every time changing the L1 state of the Anchor object, the nodes should create it.
 // a latest StateAnchor, and remember to update the latest ObjectRef of GasCoin
 // "changing the L1 state of the Anchor object" includes the following 'txbuilder' operations
 // * BuildTransactionEssence (update the anchor commitment)

packages/isc/vmerror.go

@@ -86,7 +86,7 @@ func (e *VMErrorTemplate) Create(params ...VMErrorParam) *VMError {
 	}
 }
 
-// VMErrorTemplate implements error just in case someone panics with
+// Error implements the error interface. VMErrorTemplate implements error just in case someone panics with it.
 // VMErrorTemplate by mistake, so that we don't crash the VM because of that.
 func (e *VMErrorTemplate) Error() string {
 	// calling Sprintf so that it marks missing parameters as errors
@@ -129,7 +129,7 @@ func (e *UnresolvedVMError) Error() string {
 	return fmt.Sprintf("UnresolvedVMError(code: %s)", e.ErrorCode)
 }
 
-// produce the params as humanly readably json, and the uints as strings
+// ToJSONStruct produces the params as humanly readable json, and the uints as strings
 func (e *UnresolvedVMError) ToJSONStruct() *UnresolvedVMErrorJSON {
 	if e == nil {
 		return &UnresolvedVMErrorJSON{

packages/kv/buffered/buffered.go

@@ -1,3 +1,6 @@
+// Package buffered provides buffered implementations of the key-value store
+// interfaces. It allows for batch operations and in-memory caching of key-value
+// operations before committing them to the underlying storage.
 package buffered
 
 import (
@@ -57,7 +60,7 @@ func (b *BufferedKVStore) DangerouslyDumpToDict() dict.Dict {
 	return ret
 }
 
-// iterates over all key-value pairs in KVStore
+// DangerouslyDumpToString iterates over all key-value pairs in KVStore
 func (b *BufferedKVStore) DangerouslyDumpToString() string {
 	ret := "         BufferedKVStore:\n"
 	for k, v := range b.DangerouslyDumpToDict() {

packages/kv/codec/dict.go

@@ -1,3 +1,6 @@
+// Package codec provides encoding and decoding functionality for the kv package.
+// It handles serialization and deserialization of various data types to and from
+// the key-value store format.
 package codec
 
 import (

packages/kv/collections/array.go

@@ -116,7 +116,7 @@ func (a *Array) PruneAt(index uint32) {
 	a.kvw.Del(a.getArrayElemKey(index))
 }
 
-// adds to the end of the list
+// Push adds to the end of the list
 func (a *Array) Push(value []byte) {
 	index := a.addToSize(1)
 	key := a.getArrayElemKey(index)

packages/kv/collections/map.go

@@ -1,3 +1,6 @@
+// Package collections provides high-level data structures built on top of
+// the kv package. It implements common collection types such as maps, arrays,
+// and other data structures with a key-value store backend.
 package collections
 
 import (

packages/kv/dict/dict.go

@@ -1,3 +1,6 @@
+// Package dict provides a dictionary implementation for key-value storage.
+// It implements the kv.KVStore interface with an in-memory map as the backend,
+// allowing for efficient key-value operations and serialization.
 package dict
 
 import (

packages/kv/kvstream.go

@@ -1,3 +1,6 @@
+// Package kv provides key-value storage interfaces and implementations
+// for IOTA Smart Contracts. It defines the core functionality for storing,
+// retrieving, and streaming key-value pairs.
 package kv
 
 import (

packages/kv/subrealm/subrealm.go

@@ -1,3 +1,6 @@
+// Package subrealm provides functionality for working with isolated subsets
+// of the key-value store. It enables creation of distinct realms within a
+// single KV store, allowing for better organization and isolation of data.
 package subrealm
 
 import (

packages/metrics/peering.go

@@ -1,3 +1,4 @@
+// Package metrics provides functionality for collecting and exposing metrics about the system.
 package metrics
 
 import (

packages/nodeconn/nodeconn.go

@@ -1,7 +1,7 @@
 // Copyright 2020 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
-// nodeconn package provides an interface to the L1 node (Hornet).
+// Package nodeconn provides an interface to the L1 node (Hornet).
 package nodeconn
 
 import (

packages/onchangemap/onchangemap.go

@@ -1,3 +1,4 @@
+// Package onchangemap provides a map implementation that triggers callbacks when items are added, modified, or deleted.
 package onchangemap
 
 import (

packages/origin/origin.go

@@ -1,3 +1,4 @@
+// Package origin provides functionality for chain origination and initialization.
 package origin
 
 import (

packages/parameters/l1parameters.go

@@ -1,3 +1,4 @@
+// Package parameters provides configuration parameters for L1 and other components of the system.
 package parameters
 
 import (

packages/parameters/parameterstest/parameterstest.go

@@ -1,3 +1,4 @@
+// Package parameterstest provides testing utilities for the parameters package.
 package parameterstest
 
 import (

packages/peering/config.go

@@ -10,7 +10,7 @@ import (
 	"strconv"
 )
 
-// Check, if peeringURL is of proper format.
+// CheckPeeringURL verifies if peeringURL is of proper format.
 func CheckPeeringURL(url string) error {
 	sHost, sPort, err := net.SplitHostPort(url)
 	if err != nil {

packages/peering/domain/domain.go

@@ -1,6 +1,7 @@
 // Copyright 2020 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
 
+// Package domain provides domain-specific functionality for peer-to-peer communication.
 package domain
 
 import (

packages/peering/peer_message.go

@@ -19,7 +19,7 @@ import (
 	"github.com/iotaledger/wasp/packages/util/rwutil"
 )
 
-// PeerMessage is an envelope for all the messages exchanged via the peering module.
+// PeerMessageData is an envelope for all the messages exchanged via the peering module.
 type PeerMessageData struct {
 	PeeringID   PeeringID
 	MsgReceiver byte

packages/peering/peering.go

@@ -68,7 +68,7 @@ type TrustedNetworkManager interface {
 	TrustedPeersListener(callback func([]*TrustedPeer)) context.CancelFunc
 }
 
-// Basic checks, to be used in all the implementations.
+// ValidateTrustedPeerParams performs basic checks on trusted peer parameters, to be used in all the implementations.
 func ValidateTrustedPeerParams(name string, pubKey *cryptolib.PublicKey, peeringURL string) error {
 	if name != pubKey.String() && strings.HasPrefix(name, "0x") {
 		return fmt.Errorf("name cannot start with '0x' unless it is equal to pubKey")
@@ -79,7 +79,7 @@ func ValidateTrustedPeerParams(name string, pubKey *cryptolib.PublicKey, peering
 	return nil
 }
 
-// Resolves pubKeysOrNames to TrustedPeers. Fails if any of the names/keys cannot be resolved.
+// QueryByPubKeyOrName resolves pubKeysOrNames to TrustedPeers. Fails if any of the names/keys cannot be resolved.
 func QueryByPubKeyOrName(trustedPeers []*TrustedPeer, pubKeysOrNames []string) ([]*TrustedPeer, error) {
 	result := make([]*TrustedPeer, len(pubKeysOrNames))
 	for i, pubKeyOrName := range pubKeysOrNames {

packages/publisher/events.go

@@ -29,7 +29,7 @@ type ISCEvent[T any] struct {
 	Payload   T             `json:"payload"`
 }
 
-// kind is not printed right now, because it is added when calling p.publish
+// String returns a string representation of the event. Note that kind is not printed right now, because it is added when calling p.publish.
 func (e *ISCEvent[T]) String() string {
 	issuerStr := "vm"
 	if e.Issuer != nil {

packages/publisher/publisher.go

@@ -1,3 +1,4 @@
+// Package publisher provides functionality for publishing chain events to subscribers.
 package publisher
 
 import (
@@ -56,25 +57,25 @@ func New(log log.Logger) *Publisher {
 	return p
 }
 
-// Implements the chain.ChainListener interface.
+// BlockApplied implements the chain.ChainListener interface.
 // NOTE: Do not block the caller!
 func (p *Publisher) BlockApplied(chainID isc.ChainID, block state.Block, latestState kv.KVStoreReader) {
 	p.blockAppliedPipe.In() <- &blockApplied{chainID: chainID, block: block, latestState: latestState}
 }
 
-// Implements the chain.ChainListener interface.
+// AccessNodesUpdated implements the chain.ChainListener interface.
 // NOTE: Do not block the caller!
 func (p *Publisher) AccessNodesUpdated(chainID isc.ChainID, accessNodes []*cryptolib.PublicKey) {
 	// We don't need this event.
 }
 
-// Implements the chain.ChainListener interface.
+// ServerNodesUpdated implements the chain.ChainListener interface.
 // NOTE: Do not block the caller!
 func (p *Publisher) ServerNodesUpdated(chainID isc.ChainID, serverNodes []*cryptolib.PublicKey) {
 	// We don't need this event.
 }
 
-// This is called by the component to run this.
+// Run is called by the component to run this.
 func (p *Publisher) Run(ctx context.Context) {
 	blockAppliedPipeOutCh := p.blockAppliedPipe.Out()
 	for {

packages/registry/chain_registry.go

@@ -1,5 +1,8 @@
 // Copyright 2020 IOTA Stiftung
 // SPDX-License-Identifier: Apache-2.0
+
+// Package registry provides functionality for managing chain records, consensus state,
+// and distributed key shares in the system.
 package registry
 
 import (