Skip to content

Commit 99ca45c

Browse files
GrapeBaBaGrapeBaBa
committed
fix some minor warn
Signed-off-by: Chen Kai <[email protected]>
1 parent ae9da89 commit 99ca45c

15 files changed

+305
-688
lines changed

‎beacon/beacon_network.go

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const (
2727
HistoricalSummaries storage.ContentType = 0x14
2828
)
2929

30-
type BeaconNetwork struct {
30+
type Network struct {
3131
portalProtocol *portalwire.PortalProtocol
3232
spec *common.Spec
3333
log log.Logger
@@ -36,10 +36,10 @@ type BeaconNetwork struct {
3636
lightClient *ConsensusLightClient
3737
}
3838

39-
func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *BeaconNetwork {
39+
func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *Network {
4040
ctx, cancel := context.WithCancel(context.Background())
4141

42-
return &BeaconNetwork{
42+
return &Network{
4343
portalProtocol: portalProtocol,
4444
spec: configs.Mainnet,
4545
closeCtx: ctx,
@@ -48,7 +48,7 @@ func NewBeaconNetwork(portalProtocol *portalwire.PortalProtocol) *BeaconNetwork
4848
}
4949
}
5050

51-
func (bn *BeaconNetwork) Start() error {
51+
func (bn *Network) Start() error {
5252
err := bn.portalProtocol.Start()
5353
if err != nil {
5454
return err
@@ -58,12 +58,12 @@ func (bn *BeaconNetwork) Start() error {
5858
return nil
5959
}
6060

61-
func (bn *BeaconNetwork) Stop() {
61+
func (bn *Network) Stop() {
6262
bn.closeFunc()
6363
bn.portalProtocol.Stop()
6464
}
6565

66-
func (bn *BeaconNetwork) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj, error) {
66+
func (bn *Network) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj, error) {
6767
lightClientUpdateKey := &LightClientUpdateKey{
6868
StartPeriod: firstPeriod,
6969
Count: count,
@@ -86,7 +86,7 @@ func (bn *BeaconNetwork) GetUpdates(firstPeriod, count uint64) ([]common.SpecObj
8686
return res, nil
8787
}
8888

89-
func (bn *BeaconNetwork) GetCheckpointData(checkpointHash tree.Root) (common.SpecObj, error) {
89+
func (bn *Network) GetCheckpointData(checkpointHash tree.Root) (common.SpecObj, error) {
9090
bootstrapKey := &LightClientBootstrapKey{
9191
BlockHash: checkpointHash[:],
9292
}
@@ -104,7 +104,7 @@ func (bn *BeaconNetwork) GetCheckpointData(checkpointHash tree.Root) (common.Spe
104104
return forkedLightClientBootstrap.Bootstrap, nil
105105
}
106106

107-
func (bn *BeaconNetwork) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj, error) {
107+
func (bn *Network) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj, error) {
108108
finalityUpdateKey := &LightClientFinalityUpdateKey{
109109
FinalizedSlot: finalizedSlot,
110110
}
@@ -122,7 +122,7 @@ func (bn *BeaconNetwork) GetFinalityUpdate(finalizedSlot uint64) (common.SpecObj
122122
return forkedLightClientFinalityUpdate.LightClientFinalityUpdate, nil
123123
}
124124

125-
func (bn *BeaconNetwork) GetOptimisticUpdate(optimisticSlot uint64) (common.SpecObj, error) {
125+
func (bn *Network) GetOptimisticUpdate(optimisticSlot uint64) (common.SpecObj, error) {
126126
optimisticUpdateKey := &LightClientOptimisticUpdateKey{
127127
OptimisticSlot: optimisticSlot,
128128
}
@@ -141,7 +141,7 @@ func (bn *BeaconNetwork) GetOptimisticUpdate(optimisticSlot uint64) (common.Spec
141141
return forkedLightClientOptimisticUpdate.LightClientOptimisticUpdate, nil
142142
}
143143

144-
func (bn *BeaconNetwork) getContent(contentType storage.ContentType, beaconContentKey ssz.Marshaler) ([]byte, error) {
144+
func (bn *Network) getContent(contentType storage.ContentType, beaconContentKey ssz.Marshaler) ([]byte, error) {
145145
contentKeyBytes, err := beaconContentKey.MarshalSSZ()
146146
if err != nil {
147147
return nil, err
@@ -168,7 +168,7 @@ func (bn *BeaconNetwork) getContent(contentType storage.ContentType, beaconConte
168168
return content, nil
169169
}
170170

171-
func (bn *BeaconNetwork) validateContent(contentKey []byte, content []byte) error {
171+
func (bn *Network) validateContent(contentKey []byte, content []byte) error {
172172
switch storage.ContentType(contentKey[0]) {
173173
case LightClientUpdate:
174174
var lightClientUpdateRange LightClientUpdateRange = make([]ForkedLightClientUpdate, 0)
@@ -271,7 +271,7 @@ func (bn *BeaconNetwork) validateContent(contentKey []byte, content []byte) erro
271271
}
272272
}
273273

274-
func (bn *BeaconNetwork) validateContents(contentKeys [][]byte, contents [][]byte) error {
274+
func (bn *Network) validateContents(contentKeys [][]byte, contents [][]byte) error {
275275
for i, content := range contents {
276276
contentKey := contentKeys[i]
277277
err := bn.validateContent(contentKey, content)
@@ -289,7 +289,7 @@ func (bn *BeaconNetwork) validateContents(contentKeys [][]byte, contents [][]byt
289289
return nil
290290
}
291291

292-
func (bn *BeaconNetwork) processContentLoop(ctx context.Context) {
292+
func (bn *Network) processContentLoop(ctx context.Context) {
293293
contentChan := bn.portalProtocol.GetContent()
294294
for {
295295
select {
@@ -319,7 +319,7 @@ func (bn *BeaconNetwork) processContentLoop(ctx context.Context) {
319319
}
320320
}
321321

322-
func (bn *BeaconNetwork) generalSummariesValidation(contentKey, content []byte) (*ForkedHistoricalSummariesWithProof, error) {
322+
func (bn *Network) generalSummariesValidation(contentKey, content []byte) (*ForkedHistoricalSummariesWithProof, error) {
323323
key := &HistoricalSummariesWithProofKey{}
324324
err := key.Deserialize(codec.NewDecodingReader(bytes.NewReader(contentKey[1:]), uint64(len(contentKey[1:]))))
325325
if err != nil {
@@ -336,7 +336,7 @@ func (bn *BeaconNetwork) generalSummariesValidation(contentKey, content []byte)
336336
return forkedHistoricalSummariesWithProof, nil
337337
}
338338

339-
func (bn *BeaconNetwork) stateSummariesValidation(f ForkedHistoricalSummariesWithProof, latestFinalizedRoot common.Root) bool {
339+
func (bn *Network) stateSummariesValidation(f ForkedHistoricalSummariesWithProof, latestFinalizedRoot common.Root) bool {
340340
proof := f.HistoricalSummariesWithProof.Proof
341341
summariesRoot := f.HistoricalSummariesWithProof.HistoricalSummaries.HashTreeRoot(bn.spec, tree.GetHashFn())
342342

‎beacon/portal_api.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ func (p *PortalLightApi) ChainID() uint64 {
3030
return 1
3131
}
3232

33-
// GetCheckpointData implements ConsensusAPI.
33+
// GetBootstrap implements ConsensusAPI.
3434
func (p *PortalLightApi) GetBootstrap(blockRoot tree.Root) (common.SpecObj, error) {
3535
bootstrapKey := &LightClientBootstrapKey{
3636
BlockHash: blockRoot[:],
@@ -54,7 +54,7 @@ func (p *PortalLightApi) GetBootstrap(blockRoot tree.Root) (common.SpecObj, erro
5454
return forkedLightClientBootstrap.Bootstrap, nil
5555
}
5656

57-
// GetFinalityData implements ConsensusAPI.
57+
// GetFinalityUpdate implements ConsensusAPI.
5858
func (p *PortalLightApi) GetFinalityUpdate() (common.SpecObj, error) {
5959
// Get the finality update for the most recent finalized epoch. We use 0 as the finalized
6060
// 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) {
8181
return finalityUpdate.LightClientFinalityUpdate, nil
8282
}
8383

84-
// GetOptimisticData implements ConsensusAPI.
84+
// GetOptimisticUpdate implements ConsensusAPI.
8585
func (p *PortalLightApi) GetOptimisticUpdate() (common.SpecObj, error) {
8686
currentSlot := p.spec.TimeToSlot(common.Timestamp(time.Now().Unix()), common.Timestamp(GenesisTime))
8787
optimisticUpdateKey := &LightClientOptimisticUpdateKey{

‎beacon/storage.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,6 @@ func (bs *Storage) getContentValue(contentId []byte) ([]byte, error) {
144144
}
145145

146146
func (bs *Storage) getLcUpdateValueByRange(start, end uint64) ([]byte, error) {
147-
// LightClientUpdateRange := make([]ForkedLightClientUpdate, 0)
148147
var lightClientUpdateRange LightClientUpdateRange
149148
rows, err := bs.db.QueryContext(context.Background(), LCUpdateLookupQueryByRange, start, end)
150149
if err != nil {

‎beacon/storage_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import (
1313
"github.com/ethereum/go-ethereum/p2p/enode"
1414
"github.com/holiman/uint256"
1515
_ "github.com/mattn/go-sqlite3"
16-
storage2 "github.com/optimism-java/shisui2/storage"
16+
"github.com/optimism-java/shisui2/storage"
1717
"github.com/protolambda/zrnt/eth2/configs"
1818
"github.com/stretchr/testify/require"
1919
)
@@ -42,7 +42,7 @@ func TestGetAndPut(t *testing.T) {
4242

4343
contentId := defaultContentIdFunc(key)
4444
_, err = beaconStorage.Get(key, contentId)
45-
require.Equal(t, storage2.ErrContentNotFound, err)
45+
require.Equal(t, storage.ErrContentNotFound, err)
4646

4747
err = beaconStorage.Put(key, contentId, value)
4848
require.NoError(t, err)
@@ -53,7 +53,7 @@ func TestGetAndPut(t *testing.T) {
5353
}
5454
}
5555

56-
func genStorage(testDir string) (storage2.ContentStorage, error) {
56+
func genStorage(testDir string) (storage.ContentStorage, error) {
5757
err := os.MkdirAll(testDir, 0755)
5858
if err != nil {
5959
return nil, err
@@ -62,7 +62,7 @@ func genStorage(testDir string) (storage2.ContentStorage, error) {
6262
if err != nil {
6363
return nil, err
6464
}
65-
config := &storage2.PortalStorageConfig{
65+
config := &storage.PortalStorageConfig{
6666
StorageCapacityMB: 1000,
6767
DB: db,
6868
NodeId: enode.ID(zeroNodeId),

‎beacon/test_utils.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import (
2121
"github.com/protolambda/ztyp/tree"
2222
)
2323

24-
func SetupBeaconNetwork(addr string, bootNodes []*enode.Node) (*BeaconNetwork, error) {
24+
func SetupBeaconNetwork(addr string, bootNodes []*enode.Node) (*Network, error) {
2525
conf := portalwire2.DefaultPortalProtocolConfig()
2626
if addr != "" {
2727
conf.ListenAddr = addr

‎cmd/shisui/main.go

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ type Config struct {
6565
type Client struct {
6666
DiscV5API *portalwire.DiscV5API
6767
HistoryNetwork *history.Network
68-
BeaconNetwork *beacon.BeaconNetwork
69-
StateNetwork *state.StateNetwork
68+
BeaconNetwork *beacon.Network
69+
StateNetwork *state.Network
7070
Server *http.Server
7171
}
7272

@@ -113,7 +113,10 @@ func init() {
113113

114114
func main() {
115115
if err := app.Run(os.Args); err != nil {
116-
fmt.Fprintln(os.Stderr, err)
116+
_, err = fmt.Fprintln(os.Stderr, err)
117+
if err != nil {
118+
log.Error("Failed to write error to stderr", "err", err)
119+
}
117120
os.Exit(1)
118121
}
119122
}
@@ -216,7 +219,10 @@ func (cli *Client) closePortalRpcServer() {
216219
log.Info("Closing UDPv5 protocol...")
217220
cli.DiscV5API.DiscV5.Close()
218221
log.Info("Closing servers...")
219-
cli.Server.Close()
222+
err := cli.Server.Close()
223+
if err != nil {
224+
log.Error("Failed to close server", "err", err)
225+
}
220226
os.Exit(1)
221227
}
222228

@@ -252,7 +258,7 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
252258
client.HistoryNetwork = historyNetwork
253259
}
254260

255-
var beaconNetwork *beacon.BeaconNetwork
261+
var beaconNetwork *beacon.Network
256262
if slices.Contains(config.Networks, portalwire.Beacon.Name()) {
257263
beaconNetwork, err = initBeacon(config, server, conn, localNode, discV5, utp)
258264
if err != nil {
@@ -261,7 +267,7 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
261267
client.BeaconNetwork = beaconNetwork
262268
}
263269

264-
var stateNetwork *state.StateNetwork
270+
var stateNetwork *state.Network
265271
if slices.Contains(config.Networks, portalwire.State.Name()) {
266272
stateNetwork, err = initState(config, server, conn, localNode, discV5, utp)
267273
if err != nil {
@@ -270,12 +276,12 @@ func startPortalRpcServer(config Config, conn discover.UDPConn, addr string, cli
270276
client.StateNetwork = stateNetwork
271277
}
272278

273-
ethapi := &ethapi.API{
279+
ethApi := &ethapi.API{
274280
History: historyNetwork,
275281
// static configuration of ChainId, currently only mainnet implemented
276282
ChainID: core.DefaultGenesisBlock().Config.ChainID,
277283
}
278-
err = server.RegisterName("eth", ethapi)
284+
err = server.RegisterName("eth", ethApi)
279285
if err != nil {
280286
return err
281287
}
@@ -307,9 +313,9 @@ func initDiscV5(config Config, conn discover.UDPConn) (*discover.UDPv5, *enode.L
307313

308314
localNode.Set(portalwire.Tag)
309315
listenerAddr := conn.LocalAddr().(*net.UDPAddr)
310-
nat := config.Protocol.NAT
311-
if nat != nil && !listenerAddr.IP.IsLoopback() {
312-
doPortMapping(nat, localNode, listenerAddr)
316+
natConf := config.Protocol.NAT
317+
if natConf != nil && !listenerAddr.IP.IsLoopback() {
318+
doPortMapping(natConf, localNode, listenerAddr)
313319
}
314320

315321
discV5, err := discover.ListenV5(conn, localNode, discCfg)
@@ -415,7 +421,7 @@ func initHistory(config Config, server *rpc.Server, conn discover.UDPConn, local
415421
return historyNetwork, historyNetwork.Start()
416422
}
417423

418-
func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*beacon.BeaconNetwork, error) {
424+
func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*beacon.Network, error) {
419425
dbPath := path.Join(config.DataDir, "beacon")
420426
err := os.MkdirAll(dbPath, 0755)
421427
if err != nil {
@@ -464,7 +470,7 @@ func initBeacon(config Config, server *rpc.Server, conn discover.UDPConn, localN
464470
return beaconNetwork, beaconNetwork.Start()
465471
}
466472

467-
func initState(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*state.StateNetwork, error) {
473+
func initState(config Config, server *rpc.Server, conn discover.UDPConn, localNode *enode.LocalNode, discV5 *discover.UDPv5, utp *portalwire.PortalUtp) (*state.Network, error) {
468474
networkName := portalwire.State.Name()
469475
db, err := history.NewDB(config.DataDir, networkName)
470476
if err != nil {
@@ -575,7 +581,12 @@ func setPrivateKey(ctx *cli.Context, config *Config) error {
575581
if err != nil {
576582
log.Error("Failed to create file:", "err", err)
577583
}
578-
defer file.Close()
584+
defer func(file *os.File) {
585+
err := file.Close()
586+
if err != nil {
587+
log.Error("Failed to close file:", "err", err)
588+
}
589+
}(file)
579590
}
580591
log.Info("Creating new private key")
581592
privateKey, err = crypto.GenerateKey()
@@ -601,7 +612,12 @@ func writePrivateKey(privateKey *ecdsa.PrivateKey, config *Config, fileName stri
601612
if err != nil {
602613
return err
603614
}
604-
defer file.Close()
615+
defer func(file *os.File) {
616+
err = file.Close()
617+
if err != nil {
618+
log.Error("Failed to close file", "err", err)
619+
}
620+
}(file)
605621

606622
_, err = file.WriteString(keyEnc)
607623
if err != nil {

‎cmd/shisui/main_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ func newLocalNodeForTesting() (*enode.LocalNode, *enode.DB) {
1717
}
1818

1919
func TestDoPortMapping(t *testing.T) {
20-
nat := nat.ExtIP{33, 44, 55, 66}
20+
extIP := nat.ExtIP{33, 44, 55, 66}
2121
localNode, _ := newLocalNodeForTesting()
2222
listenerAddr := &net.UDPAddr{IP: net.IP{127, 0, 0, 1}, Port: 1234}
2323

24-
doPortMapping(nat, localNode, listenerAddr)
24+
doPortMapping(extIP, localNode, listenerAddr)
2525

2626
assert.Equal(t, localNode.Seq(), uint64(1))
2727
assert.Equal(t, localNode.Node().IP(), net.IP{33, 44, 55, 66})

0 commit comments

Comments
 (0)