Remove useless interface comments + minor cleanup (ava-labs#1196)

Author: StephenButtolph

api/keystore/keystore.go

@@ -90,7 +90,6 @@ type user struct {
 	Data          []kvPair `serialize:"true"`
 }
 
-// keystore implements keystore management logic
 type keystore struct {
 	lock sync.Mutex
 	log  logging.Logger

app/plugin/plugin.go

@@ -14,41 +14,36 @@ import (
 	"github.com/ava-labs/avalanchego/app"
 )
 
-const (
-	Name = "nodeProcess"
-)
+const Name = "nodeProcess"
 
-var Handshake = plugin.HandshakeConfig{
-	ProtocolVersion:  2,
-	MagicCookieKey:   "NODE_PROCESS_PLUGIN",
-	MagicCookieValue: "dynamic",
-}
+var (
+	Handshake = plugin.HandshakeConfig{
+		ProtocolVersion:  2,
+		MagicCookieKey:   "NODE_PROCESS_PLUGIN",
+		MagicCookieValue: "dynamic",
+	}
 
-// PluginMap is the map of plugins we can dispense.
-var PluginMap = map[string]plugin.Plugin{
-	Name: &AppPlugin{},
-}
+	// PluginMap is the map of plugins we can dispense.
+	PluginMap = map[string]plugin.Plugin{
+		Name: &appPlugin{},
+	}
 
-// AppPlugin is can be served/consumed with the hashicorp plugin library.
-// Plugin implements plugin.GRPCPlugin
-type AppPlugin struct {
+	_ plugin.Plugin     = &appPlugin{}
+	_ plugin.GRPCPlugin = &appPlugin{}
+)
+
+type appPlugin struct {
 	plugin.NetRPCUnsupportedPlugin
 	app app.App
 }
 
-func New(app app.App) *AppPlugin {
-	return &AppPlugin{
-		app: app,
-	}
-}
-
 // GRPCServer registers a new GRPC server.
-func (p *AppPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error {
+func (p *appPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error {
 	pluginproto.RegisterNodeServer(s, NewServer(p.app))
 	return nil
 }
 
 // GRPCClient returns a new GRPC client
-func (p *AppPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
+func (p *appPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error) {
 	return NewClient(pluginproto.NewNodeClient(c)), nil
 }

app/runner/runner.go

@@ -25,10 +25,8 @@ func Run(config Config, nodeConfig node.Config) {
 	if config.PluginMode {                // Serve as a plugin
 		plugin.Serve(&plugin.ServeConfig{
 			HandshakeConfig: appplugin.Handshake,
-			Plugins: map[string]plugin.Plugin{
-				appplugin.Name: appplugin.New(nodeApp),
-			},
-			GRPCServer: plugin.DefaultGRPCServer, // A non-nil value here enables gRPC serving for this plugin
+			Plugins:         appplugin.PluginMap,
+			GRPCServer:      plugin.DefaultGRPCServer, // A non-nil value here enables gRPC serving for this plugin
 			Logger: hclog.New(&hclog.LoggerOptions{
 				Level: hclog.Error,
 			}),

cache/lru_cache.go

@@ -8,9 +8,7 @@ import (
 	"sync"
 )
 
-const (
-	minCacheSize = 32
-)
+const minCacheSize = 32
 
 var _ Cacher = &LRU{}
 
@@ -29,31 +27,27 @@ type LRU struct {
 	Size      int
 }
 
-// Put implements the cache interface
 func (c *LRU) Put(key, value interface{}) {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
 	c.put(key, value)
 }
 
-// Get implements the cache interface
 func (c *LRU) Get(key interface{}) (interface{}, bool) {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
 	return c.get(key)
 }
 
-// Evict implements the cache interface
 func (c *LRU) Evict(key interface{}) {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
 	c.evict(key)
 }
 
-// Flush implements the cache interface
 func (c *LRU) Flush() {
 	c.lock.Lock()
 	defer c.lock.Unlock()

cache/unique_cache.go

@@ -18,15 +18,13 @@ type EvictableLRU struct {
 	Size      int
 }
 
-// Deduplicate implements the Deduplicator interface
 func (c *EvictableLRU) Deduplicate(value Evictable) Evictable {
 	c.lock.Lock()
 	defer c.lock.Unlock()
 
 	return c.deduplicate(value)
 }
 
-// Flush implements the Deduplicator interface
 func (c *EvictableLRU) Flush() {
 	c.lock.Lock()
 	defer c.lock.Unlock()

codec/test_codec.go

@@ -42,11 +42,15 @@ var Tests = []func(c GeneralCodec, t testing.TB){
 // The below structs and interfaces exist
 // for the sake of testing
 
+var (
+	_ Foo = &MyInnerStruct{}
+	_ Foo = &MyInnerStruct2{}
+)
+
 type Foo interface {
 	Foo() int
 }
 
-// *MyInnerStruct implements Foo
 type MyInnerStruct struct {
 	Str string `serialize:"true"`
 }
@@ -55,7 +59,6 @@ func (m *MyInnerStruct) Foo() int {
 	return 1
 }
 
-// *MyInnerStruct2 implements Foo
 type MyInnerStruct2 struct {
 	Bool bool `serialize:"true"`
 }

database/encdb/db.go

@@ -52,7 +52,6 @@ func New(password []byte, db database.Database) (*Database, error) {
 	}, manager.RegisterCodec(codecVersion, c)
 }
 
-// Has implements the Database interface
 func (db *Database) Has(key []byte) (bool, error) {
 	db.lock.RLock()
 	defer db.lock.RUnlock()
@@ -63,7 +62,6 @@ func (db *Database) Has(key []byte) (bool, error) {
 	return db.db.Has(key)
 }
 
-// Get implements the Database interface
 func (db *Database) Get(key []byte) ([]byte, error) {
 	db.lock.RLock()
 	defer db.lock.RUnlock()
@@ -78,7 +76,6 @@ func (db *Database) Get(key []byte) ([]byte, error) {
 	return db.decrypt(encVal)
 }
 
-// Put implements the Database interface
 func (db *Database) Put(key, value []byte) error {
 	db.lock.Lock()
 	defer db.lock.Unlock()
@@ -94,7 +91,6 @@ func (db *Database) Put(key, value []byte) error {
 	return db.db.Put(key, encValue)
 }
 
-// Delete implements the Database interface
 func (db *Database) Delete(key []byte) error {
 	db.lock.Lock()
 	defer db.lock.Unlock()
@@ -105,30 +101,25 @@ func (db *Database) Delete(key []byte) error {
 	return db.db.Delete(key)
 }
 
-// NewBatch implements the Database interface
 func (db *Database) NewBatch() database.Batch {
 	return &batch{
 		Batch: db.db.NewBatch(),
 		db:    db,
 	}
 }
 
-// NewIterator implements the Database interface
 func (db *Database) NewIterator() database.Iterator {
 	return db.NewIteratorWithStartAndPrefix(nil, nil)
 }
 
-// NewIteratorWithStart implements the Database interface
 func (db *Database) NewIteratorWithStart(start []byte) database.Iterator {
 	return db.NewIteratorWithStartAndPrefix(start, nil)
 }
 
-// NewIteratorWithPrefix implements the Database interface
 func (db *Database) NewIteratorWithPrefix(prefix []byte) database.Iterator {
 	return db.NewIteratorWithStartAndPrefix(nil, prefix)
 }
 
-// NewIteratorWithStartAndPrefix implements the Database interface
 func (db *Database) NewIteratorWithStartAndPrefix(start, prefix []byte) database.Iterator {
 	db.lock.RLock()
 	defer db.lock.RUnlock()
@@ -142,7 +133,6 @@ func (db *Database) NewIteratorWithStartAndPrefix(start, prefix []byte) database
 	}
 }
 
-// Stat implements the Database interface
 func (db *Database) Stat(stat string) (string, error) {
 	db.lock.RLock()
 	defer db.lock.RUnlock()
@@ -153,7 +143,6 @@ func (db *Database) Stat(stat string) (string, error) {
 	return db.db.Stat(stat)
 }
 
-// Compact implements the Database interface
 func (db *Database) Compact(start, limit []byte) error {
 	db.lock.Lock()
 	defer db.lock.Unlock()
@@ -164,7 +153,6 @@ func (db *Database) Compact(start, limit []byte) error {
 	return db.db.Compact(start, limit)
 }
 
-// Close implements the Database interface
 func (db *Database) Close() error {
 	db.lock.Lock()
 	defer db.lock.Unlock()

database/leveldb/db.go

@@ -264,7 +264,6 @@ func (db *Database) Compact(start []byte, limit []byte) error {
 	return updateError(db.DB.CompactRange(util.Range{Start: start, Limit: limit}))
 }
 
-// Close implements the Database interface
 func (db *Database) Close() error {
 	db.closed.SetValue(true)
 	return updateError(db.DB.Close())
@@ -365,18 +364,15 @@ func (it *iter) Next() bool {
 	return hasNext
 }
 
-// Error implements the Iterator interface
 func (it *iter) Error() error {
 	if it.err != nil {
 		return it.err
 	}
 	return updateError(it.Iterator.Error())
 }
 
-// Key implements the Iterator interface
 func (it *iter) Key() []byte { return it.key }
 
-// Value implements the Iterator interface
 func (it *iter) Value() []byte { return it.val }
 
 func updateError(err error) error {

database/linkeddb/linkeddb.go

@@ -363,7 +363,6 @@ type iterator struct {
 	err                    error
 }
 
-// Next implements the Iterator interface
 func (it *iterator) Next() bool {
 	// If the iterator has been exhausted, there is no next value.
 	if it.exhausted {