Address some lint warnings

api/api.go

@@ -6,12 +6,14 @@ import (
 	"github.com/libp2p/go-libp2p-core/peer"
 )
 
+// Version provides various build-time information
 type Version struct {
 	Version string
 
 	// TODO: git commit / os / genesis cid?
 }
 
+// API is a low-level interface to the Filecoin network
 type API interface {
 	// chain
 
@@ -71,6 +73,9 @@ type API interface {
 
 	// // ID (on cli - print with other info)
 
+	// ID returns peerID of libp2p node backing this API
 	ID(context.Context) (peer.ID, error)
+
+	// Version provides information about API provider
 	Version(context.Context) (Version, error)
 }

api/struct.go

@@ -6,6 +6,7 @@ import (
 	"github.com/libp2p/go-libp2p-core/peer"
 )
 
+// Struct implements API passing calls to user-provided function values.
 type Struct struct {
 	Internal struct {
 		ID      func(context.Context) (peer.ID, error)
@@ -13,10 +14,12 @@ type Struct struct {
 	}
 }
 
+// ID implements API.ID
 func (c *Struct) ID(ctx context.Context) (peer.ID, error) {
 	return c.Internal.ID(ctx)
 }
 
+// Version implements API.Version
 func (c *Struct) Version(ctx context.Context) (Version, error) {
 	return c.Internal.Version(ctx)
 }

api/test/test.go

@@ -8,11 +8,14 @@ import (
 	"github.com/filecoin-project/go-lotus/build"
 )
 
+// APIBuilder is a function which is invoked in test suite to provide
+// test nodes and networks
 type APIBuilder func() api.API
 type testSuite struct {
 	makeNode APIBuilder
 }
 
+// TestApis is the entry point to API test suite
 func TestApis(t *testing.T, b APIBuilder) {
 	ts := testSuite{
 		makeNode: b,

cli/cmd.go

@@ -4,6 +4,7 @@ import (
 	"gopkg.in/urfave/cli.v2"
 )
 
+// Commands is the root group of CLI commands
 var Commands = []*cli.Command{
 	versionCmd,
 }

daemon/cmd.go

@@ -8,6 +8,7 @@ import (
 	"github.com/filecoin-project/go-lotus/node"
 )
 
+// Cmd is the `go-lotus daemon` command
 var Cmd = &cli.Command{
 	Name:  "daemon",
 	Usage: "Start a lotus daemon process",

node/builder.go

@@ -23,8 +23,9 @@ var defaultListenAddrs = []string{ // TODO: better defaults?
 	"/ip6/::/tcp/4001",
 }
 
+// New builds and starts new Filecoin node
 func New(ctx context.Context) (api.API, error) {
-	var resApi api.Struct
+	var resAPI api.Struct
 
 	online := true
 
@@ -66,15 +67,15 @@ func New(ctx context.Context) (api.API, error) {
 			),
 		),
 
-		fx.Invoke(versionApi(&resApi.Internal.Version)),
+		fx.Invoke(versionAPI(&resAPI.Internal.Version)),
-		fx.Invoke(idApi(&resApi.Internal.ID)),
+		fx.Invoke(idAPI(&resAPI.Internal.ID)),
 	)
 
 	if err := app.Start(ctx); err != nil {
 		return nil, err
 	}
 
-	return &resApi, nil
+	return &resAPI, nil
 }
 
 // In-memory / testing
@@ -112,7 +113,7 @@ func ifOpt(cond bool, options ...fx.Option) fx.Option {
 // API IMPL
 
 // TODO: figure out a better way, this isn't usable in long term
-func idApi(set *func(ctx context.Context) (peer.ID, error)) func(id peer.ID) {
+func idAPI(set *func(ctx context.Context) (peer.ID, error)) func(id peer.ID) {
 	return func(id peer.ID) {
 		*set = func(ctx context.Context) (peer.ID, error) {
 			return id, nil
@@ -120,7 +121,7 @@ func idApi(set *func(ctx context.Context) (peer.ID, error)) func(id peer.ID) {
 	}
 }
 
-func versionApi(set *func(context.Context) (api.Version, error)) func() {
+func versionAPI(set *func(context.Context) (api.Version, error)) func() {
 	return func() {
 		*set = func(context.Context) (api.Version, error) {
 			return api.Version{

node/modules/testing.go

@@ -9,6 +9,7 @@ import (
 	mh "github.com/multiformats/go-multihash"
 )
 
+// RandomPeerID generates random peer id
 func RandomPeerID() (peer.ID, error) {
 	b, err := ioutil.ReadAll(io.LimitReader(rand.Reader, 32))
 	if err != nil {