Merge pull request #258 from attestantio/update_linter

Enable linting of exported method comments

.golangci.yml

@@ -14,6 +14,14 @@ issues:
   exclude-files:
     - ".*_ssz\\.go$"
 
+  include:
+    - 'EXC0002'
+    - 'EXC0005'
+    - 'EXC0009'
+    - 'EXC0011'
+    - 'EXC0012'
+    - 'EXC0014'
+
 # Options for analysis running.
 run:
   # The default concurrency value is the number of available CPU.

mock/builderbidprovider.go

@@ -22,6 +22,7 @@ import (
 	"github.com/attestantio/vouch/services/blockrelay"
 )
 
+// BuilderBidProvider obtains a builder bid.
 type BuilderBidProvider struct{}
 
 // BuilderBid returns a builder bid.

mock/builderclient.go

@@ -21,6 +21,7 @@ import (
 	"github.com/attestantio/go-eth2-client/spec/phase0"
 )
 
+// BuilderClient is a mock.
 type BuilderClient struct {
 	MockPubkey *phase0.BLSPubKey
 }
@@ -40,7 +41,7 @@ func (m *BuilderClient) Pubkey() *phase0.BLSPubKey {
 	return m.MockPubkey
 }
 
-// BuilderBidProvider obtains a builder bid.
+// BuilderBid obtains a builder bid.
 func (*BuilderClient) BuilderBid(_ context.Context,
 	_ *builderapi.BuilderBidOpts,
 ) (

services/accountmanager/mock/service.go

@@ -22,6 +22,7 @@ import (
 	e2wtypes "github.com/wealdtech/go-eth2-wallet-types/v2"
 )
 
+// ValidatingAccountsProvider is a mock.
 type ValidatingAccountsProvider struct {
 	validatingAccounts map[phase0.ValidatorIndex]e2wtypes.Account
 }

services/accountmanager/utils/metrics.go

@@ -23,6 +23,7 @@ import (
 
 var accountManagerAccounts *prometheus.GaugeVec
 
+// RegisterMetrics registers metrics if appropriate for the monitor type.
 func RegisterMetrics(ctx context.Context, monitor metrics.Service) error {
 	if monitor == nil {
 		// No monitor.

services/beaconblockproposer/standard/propose.go

@@ -44,6 +44,7 @@ import (
 	"golang.org/x/sync/semaphore"
 )
 
+// BlindedProposerWithExpectedPayload is the interface for handling blinded proposed beacon blocks.
 type BlindedProposerWithExpectedPayload interface {
 	// BlindedProposalWithExpectedPayload fetches a blinded proposed beacon block for signing.
 	BlindedProposalWithExpectedPayload(context.Context,

services/blockrelay/standard/validatorregistrations.go

@@ -23,6 +23,7 @@ import (
 	"go.opentelemetry.io/otel"
 )
 
+// ValidatorRegistrations handles validator registrations.
 func (s *Service) ValidatorRegistrations(ctx context.Context,
 	registrations []*types.SignedValidatorRegistration,
 ) (

services/blockrelay/v2/proposerrelayconfig.go

@@ -27,6 +27,7 @@ import (
 	"github.com/shopspring/decimal"
 )
 
+// ProposerRelayConfig handles config information for the proposer relay.
 type ProposerRelayConfig struct {
 	Disabled     bool
 	PublicKey    *phase0.BLSPubKey

services/synccommitteemessenger/service.go

@@ -140,6 +140,7 @@ type Service interface {
 	RemoveHistoricDataUsedForSlotVerification(currentSlot phase0.Slot)
 }
 
+// SlotData contains sync committee data for a specific slot.
 type SlotData struct {
 	Root                      phase0.Root
 	ValidatorToCommitteeIndex map[phase0.ValidatorIndex][]phase0.CommitteeIndex

services/synccommitteemessenger/standard/service.go

@@ -304,6 +304,7 @@ func (s *Service) contributions(ctx context.Context,
 	return sigs, err
 }
 
+// AggregatorSignatureData contains validator signature data for a subcommittee.
 type AggregatorSignatureData struct {
 	ValidatorIndex phase0.ValidatorIndex
 	Subcommittee   uint64

util/commit.go

@@ -15,7 +15,7 @@ package util
 
 import "runtime/debug"
 
-// CommitHah returns the commit hash of the build, if available.
+// CommitHash returns the commit hash of the build, if available.
 func CommitHash() string {
 	if info, ok := debug.ReadBuildInfo(); ok {
 		for _, setting := range info.Settings {