fix some minor warn

Signed-off-by: Chen Kai <[email protected]>
optimism-java · Nov 27, 2024 · 99ca45c · 99ca45c
1 parent ae9da89
commit 99ca45c
Show file tree

Hide file tree

Showing 15 changed files with 305 additions and 688 deletions.
diff --git a/beacon/beacon_network.go b/beacon/beacon_network.go
@@ -27,7 +27,7 @@ const (
 	HistoricalSummaries         storage.ContentType = 0x14
 )
 
-type BeaconNetwork struct {
+type Network struct {
 	portalProtocol *portalwire.PortalProtocol
 	spec           *common.Spec
 	log            log.Logger
@@ -36,10 +36,10 @@ type BeaconNetwork struct {
 	lightClient    *ConsensusLightClient
 }
 
-func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *BeaconNetwork {
+func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *Network {
 	ctx, cancel := context.WithCancel(context.Background())
 
-	return &BeaconNetwork{
+	return &Network{
 		portalProtocol: portalProtocol,
 		spec:           configs.Mainnet,
 		closeCtx:       ctx,
@@ -48,7 +48,7 @@ func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *BeaconNetwork
 	}
 }
 
-func (bn *BeaconNetwork) Start() error {
+func (bn *Network) Start() error {
 	err := bn.portalProtocol.Start()
 	if err != nil {
 		return err
@@ -58,12 +58,12 @@ func (bn *BeaconNetwork) Start() error {
 	return nil
 }
 
-func (bn *BeaconNetwork) Stop() {
+func (bn *Network) Stop() {
 	bn.closeFunc()
 	bn.portalProtocol.Stop()
 }
 
-func (bn *BeaconNetwork) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj, error) {
+func (bn *Network) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj, error) {
 	lightClientUpdateKey := &LightClientUpdateKey{
 		StartPeriod: firstPeriod,
 		Count:       count,
@@ -86,7 +86,7 @@ func (bn *BeaconNetwork) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj
 	return res, nil
 }
 
-func (bn *BeaconNetwork) GetCheckpointData(checkpointHash tree.Root) (common.SpecObj, error) {
+func (bn *Network) GetCheckpointData(checkpointHash tree.Root) (common.SpecObj, error) {
 	bootstrapKey := &LightClientBootstrapKey{
 		BlockHash: checkpointHash[:],
 	}
@@ -104,7 +104,7 @@ func (bn *BeaconNetwork) GetCheckpointData(checkpointHash tree.Root) (common.Spe
 	return forkedLightClientBootstrap.Bootstrap, nil
 }
 
-func (bn *BeaconNetwork) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj, error) {
+func (bn *Network) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj, error) {
 	finalityUpdateKey := &LightClientFinalityUpdateKey{
 		FinalizedSlot: finalizedSlot,
 	}
@@ -122,7 +122,7 @@ func (bn *BeaconNetwork) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj
 	return forkedLightClientFinalityUpdate.LightClientFinalityUpdate, nil
 }
 
-func (bn *BeaconNetwork) GetOptimisticUpdate(optimisticSlot uint64) (common.SpecObj, error) {
+func (bn *Network) GetOptimisticUpdate(optimisticSlot uint64) (common.SpecObj, error) {
 	optimisticUpdateKey := &LightClientOptimisticUpdateKey{
 		OptimisticSlot: optimisticSlot,
 	}
@@ -141,7 +141,7 @@ func (bn *BeaconNetwork) GetOptimisticUpdate(optimisticSlot uint64) (common.Spec
 	return forkedLightClientOptimisticUpdate.LightClientOptimisticUpdate, nil
 }
 
-func (bn *BeaconNetwork) getContent(contentType storage.ContentType, beaconContentKey ssz.Marshaler) ([]byte, error) {
+func (bn *Network) getContent(contentType storage.ContentType, beaconContentKey ssz.Marshaler) ([]byte, error) {
 	contentKeyBytes, err := beaconContentKey.MarshalSSZ()
 	if err != nil {
 		return nil, err
@@ -168,7 +168,7 @@ func (bn *BeaconNetwork) getContent(contentType storage.ContentType, beaconConte
 	return content, nil
 }
 
-func (bn *BeaconNetwork) validateContent(contentKey []byte, content []byte) error {
+func (bn *Network) validateContent(contentKey []byte, content []byte) error {
 	switch storage.ContentType(contentKey[0]) {
 	case LightClientUpdate:
 		var lightClientUpdateRange LightClientUpdateRange = make([]ForkedLightClientUpdate, 0)
@@ -271,7 +271,7 @@ func (bn *BeaconNetwork) validateContent(contentKey []byte, content []byte) erro
 	}
 }
 
-func (bn *BeaconNetwork) validateContents(contentKeys [][]byte, contents [][]byte) error {
+func (bn *Network) validateContents(contentKeys [][]byte, contents [][]byte) error {
 	for i, content := range contents {
 		contentKey := contentKeys[i]
 		err := bn.validateContent(contentKey, content)
@@ -289,7 +289,7 @@ func (bn *BeaconNetwork) validateContents(contentKeys [][]byte, contents [][]byt
 	return nil
 }
 
-func (bn *BeaconNetwork) processContentLoop(ctx context.Context) {
+func (bn *Network) processContentLoop(ctx context.Context) {
 	contentChan := bn.portalProtocol.GetContent()
 	for {
 		select {
@@ -319,7 +319,7 @@ func (bn *BeaconNetwork) processContentLoop(ctx context.Context) {
 	}
 }
 
-func (bn *BeaconNetwork) generalSummariesValidation(contentKey, content []byte) (*ForkedHistoricalSummariesWithProof, error) {
+func (bn *Network) generalSummariesValidation(contentKey, content []byte) (*ForkedHistoricalSummariesWithProof, error) {
 	key := &HistoricalSummariesWithProofKey{}
 	err := key.Deserialize(codec.NewDecodingReader(bytes.NewReader(contentKey[1:]), uint64(len(contentKey[1:]))))
 	if err != nil {
@@ -336,7 +336,7 @@ func (bn *BeaconNetwork) generalSummariesValidation(contentKey, content []byte)
 	return forkedHistoricalSummariesWithProof, nil
 }
 
-func (bn *BeaconNetwork) stateSummariesValidation(f ForkedHistoricalSummariesWithProof, latestFinalizedRoot common.Root) bool {
+func (bn *Network) stateSummariesValidation(f ForkedHistoricalSummariesWithProof, latestFinalizedRoot common.Root) bool {
 	proof := f.HistoricalSummariesWithProof.Proof
 	summariesRoot := f.HistoricalSummariesWithProof.HistoricalSummaries.HashTreeRoot(bn.spec, tree.GetHashFn())
 

diff --git a/beacon/portal_api.go b/beacon/portal_api.go
@@ -30,7 +30,7 @@ func (p *PortalLightApi) ChainID() uint64 {
 	return 1
 }
 
-// GetCheckpointData implements ConsensusAPI.
+// GetBootstrap implements ConsensusAPI.
 func (p *PortalLightApi) GetBootstrap(blockRoot tree.Root) (common.SpecObj, error) {
 	bootstrapKey := &LightClientBootstrapKey{
 		BlockHash: blockRoot[:],
@@ -54,7 +54,7 @@ func (p *PortalLightApi) GetBootstrap(blockRoot tree.Root) (common.SpecObj, erro
 	return forkedLightClientBootstrap.Bootstrap, nil
 }
 
-// GetFinalityData implements ConsensusAPI.
+// GetFinalityUpdate implements ConsensusAPI.
 func (p *PortalLightApi) GetFinalityUpdate() (common.SpecObj, error) {
 	// Get the finality update for the most recent finalized epoch. We use 0 as the finalized
 	// slot because the finalized slot is not known at this point and the protocol is
@@ -81,7 +81,7 @@ func (p *PortalLightApi) GetFinalityUpdate() (common.SpecObj, error) {
 	return finalityUpdate.LightClientFinalityUpdate, nil
 }
 
-// GetOptimisticData implements ConsensusAPI.
+// GetOptimisticUpdate implements ConsensusAPI.
 func (p *PortalLightApi) GetOptimisticUpdate() (common.SpecObj, error) {
 	currentSlot := p.spec.TimeToSlot(common.Timestamp(time.Now().Unix()), common.Timestamp(GenesisTime))
 	optimisticUpdateKey := &LightClientOptimisticUpdateKey{

diff --git a/beacon/storage.go b/beacon/storage.go
@@ -144,7 +144,6 @@ func (bs *Storage) getContentValue(contentId []byte) ([]byte, error) {
 }
 
 func (bs *Storage) getLcUpdateValueByRange(start, end uint64) ([]byte, error) {
-	// LightClientUpdateRange := make([]ForkedLightClientUpdate, 0)
 	var lightClientUpdateRange LightClientUpdateRange
 	rows, err := bs.db.QueryContext(context.Background(), LCUpdateLookupQueryByRange, start, end)
 	if err != nil {

diff --git a/beacon/storage_test.go b/beacon/storage_test.go
@@ -13,7 +13,7 @@ import (
 	"github.com/ethereum/go-ethereum/p2p/enode"
 	"github.com/holiman/uint256"
 	_ "github.com/mattn/go-sqlite3"
-	storage2 "github.com/optimism-java/shisui2/storage"
+	"github.com/optimism-java/shisui2/storage"
 	"github.com/protolambda/zrnt/eth2/configs"
 	"github.com/stretchr/testify/require"
 )
@@ -42,7 +42,7 @@ func TestGetAndPut(t *testing.T) {
 
 		contentId := defaultContentIdFunc(key)
 		_, err = beaconStorage.Get(key, contentId)
-		require.Equal(t, storage2.ErrContentNotFound, err)
+		require.Equal(t, storage.ErrContentNotFound, err)
 
 		err = beaconStorage.Put(key, contentId, value)
 		require.NoError(t, err)
@@ -53,7 +53,7 @@ func TestGetAndPut(t *testing.T) {
 	}
 }
 
-func genStorage(testDir string) (storage2.ContentStorage, error) {
+func genStorage(testDir string) (storage.ContentStorage, error) {
 	err := os.MkdirAll(testDir, 0755)
 	if err != nil {
 		return nil, err
@@ -62,7 +62,7 @@ func genStorage(testDir string) (storage2.ContentStorage, error) {
 	if err != nil {
 		return nil, err
 	}
-	config := &storage2.PortalStorageConfig{
+	config := &storage.PortalStorageConfig{
 		StorageCapacityMB: 1000,
 		DB:                db,
 		NodeId:            enode.ID(zeroNodeId),

diff --git a/beacon/test_utils.go b/beacon/test_utils.go
@@ -21,7 +21,7 @@ import (
 	"github.com/protolambda/ztyp/tree"
 )
 
-func SetupBeaconNetwork(addr string, bootNodes []*enode.Node) (*BeaconNetwork, error) {
+func SetupBeaconNetwork(addr string, bootNodes []*enode.Node) (*Network, error) {
 	conf := portalwire2.DefaultPortalProtocolConfig()
 	if addr != "" {
 		conf.ListenAddr = addr

diff --git a/cmd/shisui/main.go b/cmd/shisui/main.go
@@ -65,8 +65,8 @@ type Config struct {
 type Client struct {
 	DiscV5API      *portalwire.DiscV5API
 	HistoryNetwork *history.Network
-	BeaconNetwork  *beacon.BeaconNetwork
-	StateNetwork   *state.StateNetwork
+	BeaconNetwork  *beacon.Network
+	StateNetwork   *state.Network
 	Server         *http.Server
 }
 
@@ -113,7 +113,10 @@ func init() {
 
 func main() {
 	if err := app.Run(os.Args); err != nil {
-		fmt.Fprintln(os.Stderr, err)
+		_, err = fmt.Fprintln(os.Stderr, err)
+		if err != nil {
+			log.Error("Failed to write error to stderr", "err", err)
+		}
 		os.Exit(1)
 	}
 }
@@ -216,7 +219,10 @@ func (cli *Client) closePortalRpcServer() {
 	log.Info("Closing UDPv5 protocol...")
 	cli.DiscV5API.DiscV5.Close()
 	log.Info("Closing servers...")
-	cli.Server.Close()
+	err := cli.Server.Close()
+	if err != nil {
+		log.Error("Failed to close server", "err", err)
+	}
 	os.Exit(1)
 }
 
@@ -252,7 +258,7 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
 		client.HistoryNetwork = historyNetwork
 	}
 
-	var beaconNetwork *beacon.BeaconNetwork
+	var beaconNetwork *beacon.Network
 	if slices.Contains(config.Networks, portalwire.Beacon.Name()) {
 		beaconNetwork, err = initBeacon(config, server, conn, localNode, discV5, utp)
 		if err != nil {
@@ -261,7 +267,7 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
 		client.BeaconNetwork = beaconNetwork
 	}
 
-	var stateNetwork *state.StateNetwork
+	var stateNetwork *state.Network
 	if slices.Contains(config.Networks, portalwire.State.Name()) {
 		stateNetwork, err = initState(config, server, conn, localNode, discV5, utp)
 		if err != nil {
@@ -270,12 +276,12 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
 		client.StateNetwork = stateNetwork
 	}
 
-	ethapi := &ethapi.API{
+	ethApi := &ethapi.API{
 		History: historyNetwork,
 		// static configuration of ChainId, currently only mainnet implemented
 		ChainID: core.DefaultGenesisBlock().Config.ChainID,
 	}
-	err = server.RegisterName("eth", ethapi)
+	err = server.RegisterName("eth", ethApi)
 	if err != nil {
 		return err
 	}
@@ -307,9 +313,9 @@ func initDiscV5(config Config, conn discover.UDPConn) (*discover.UDPv5, *enode.L
 
 	localNode.Set(portalwire.Tag)
 	listenerAddr := conn.LocalAddr().(*net.UDPAddr)
-	nat := config.Protocol.NAT
-	if nat != nil && !listenerAddr.IP.IsLoopback() {
-		doPortMapping(nat, localNode, listenerAddr)
+	natConf := config.Protocol.NAT
+	if natConf != nil && !listenerAddr.IP.IsLoopback() {
+		doPortMapping(natConf, localNode, listenerAddr)
 	}
 
 	discV5, err := discover.ListenV5(conn, localNode, discCfg)
@@ -415,7 +421,7 @@ func initHistory(config Config, server *rpc.Server, conn discover.UDPConn, local
 	return historyNetwork, historyNetwork.Start()
 }
 
-func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*beacon.BeaconNetwork, error) {
+func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*beacon.Network, error) {
 	dbPath := path.Join(config.DataDir, "beacon")
 	err := os.MkdirAll(dbPath, 0755)
 	if err != nil {
@@ -464,7 +470,7 @@ func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localN
 	return beaconNetwork, beaconNetwork.Start()
 }
 
-func initState(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*state.StateNetwork, error) {
+func initState(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*state.Network, error) {
 	networkName := portalwire.State.Name()
 	db, err := history.NewDB(config.DataDir, networkName)
 	if err != nil {
@@ -575,7 +581,12 @@ func setPrivateKey(ctx *cli.Context, config *Config) error {
 				if err != nil {
 					log.Error("Failed to create file:", "err", err)
 				}
-				defer file.Close()
+				defer func(file *os.File) {
+					err := file.Close()
+					if err != nil {
+						log.Error("Failed to close file:", "err", err)
+					}
+				}(file)
 			}
 			log.Info("Creating new private key")
 			privateKey, err = crypto.GenerateKey()
@@ -601,7 +612,12 @@ func writePrivateKey(privateKey *ecdsa.PrivateKey, config *Config, fileName stri
 	if err != nil {
 		return err
 	}
-	defer file.Close()
+	defer func(file *os.File) {
+		err = file.Close()
+		if err != nil {
+			log.Error("Failed to close file", "err", err)
+		}
+	}(file)
 
 	_, err = file.WriteString(keyEnc)
 	if err != nil {

diff --git a/cmd/shisui/main_test.go b/cmd/shisui/main_test.go
@@ -17,11 +17,11 @@ func newLocalNodeForTesting() (*enode.LocalNode, *enode.DB) {
 }
 
 func TestDoPortMapping(t *testing.T) {
-	nat := nat.ExtIP{33, 44, 55, 66}
+	extIP := nat.ExtIP{33, 44, 55, 66}
 	localNode, _ := newLocalNodeForTesting()
 	listenerAddr := &net.UDPAddr{IP: net.IP{127, 0, 0, 1}, Port: 1234}
 
-	doPortMapping(nat, localNode, listenerAddr)
+	doPortMapping(extIP, localNode, listenerAddr)
 
 	assert.Equal(t, localNode.Seq(), uint64(1))
 	assert.Equal(t, localNode.Node().IP(), net.IP{33, 44, 55, 66})