review

Author: alarso16

vms/saevm/network/network.go

@@ -1,6 +1,7 @@
 // Copyright (C) 2019, Ava Labs, Inc. All rights reserved.
 // See the file LICENSE for licensing terms.
 
+// Package network provides the P2P network for the SAE VM.
 package network
 
 import (
@@ -19,6 +20,8 @@ var (
 	_ common.AppHandler    = (*Network)(nil)
 )
 
+// Network contains the [p2p.Network] and all coupled state for use by the SAE
+// VM. It should only be constructed with [New].
 type Network struct {
 	*p2p.Network
 	ValidatorPeers *p2p.Validators

vms/saevm/sae/always.go

@@ -79,10 +79,7 @@ func (vm *SinceGenesis[_]) Initialize(
 		return fmt.Errorf("network.New(...): %v", err)
 	}
 	vm.VM, err = NewVM(ctx, vm.hooks, vm.config, snowCtx, config, db, vm.Network)
-	if err != nil {
-		return err
-	}
-	return nil
+	return err
 }
 
 // Shutdown gracefully closes the VM.

vms/saevm/sae/rpc.go

@@ -10,9 +10,11 @@ import (
 	"github.com/ava-labs/libevm/ethdb"
 	"github.com/ava-labs/libevm/event"
 
+	"github.com/ava-labs/avalanchego/network/p2p"
 	"github.com/ava-labs/avalanchego/utils/logging"
 	"github.com/ava-labs/avalanchego/vms/saevm/blocks"
 	"github.com/ava-labs/avalanchego/vms/saevm/hook"
+	"github.com/ava-labs/avalanchego/vms/saevm/network"
 	"github.com/ava-labs/avalanchego/vms/saevm/saexec"
 	"github.com/ava-labs/avalanchego/vms/saevm/txgossip"
 
@@ -27,19 +29,21 @@ func (vm *VM) GethRPCBackends() saerpc.GethBackends {
 }
 
 func (vm *VM) chain() saerpc.Chain {
-	return chain{vm, vm.exec}
+	return chain{vm, vm.exec, vm.network}
 }
 
 type chain struct {
 	*VM
 	*saexec.Executor
+	network *network.Network
 }
 
 func (c chain) Logger() logging.Logger         { return c.VM.snowCtx.Log }
 func (c chain) Hooks() hook.Points             { return c.hooks }
 func (c chain) DB() ethdb.Database             { return c.db }
 func (c chain) XDB() saetypes.ExecutionResults { return c.xdb }
 func (c chain) Mempool() *txgossip.Set         { return c.mempool }
+func (c chain) Peers() *p2p.Peers              { return c.network.Peers }
 func (c chain) LastAccepted() *blocks.Block    { return c.last.accepted.Load() }
 func (c chain) LastSettled() *blocks.Block     { return c.last.settled.Load() }
 

vms/saevm/sae/rpc/rpc.go

@@ -42,8 +42,9 @@ type Chain interface {
 	ChainConfig() *params.ChainConfig
 
 	// Consensus and block-building
-	blocks.Chain
+	Peers() *p2p.Peers
 	Mempool() *txgossip.Set
+	blocks.Chain
 	ChainContext() core.ChainContext
 
 	// Execution results and replay
@@ -97,10 +98,11 @@ type Provider struct {
 }
 
 // New constructs a new [Provider].
-func New(chain Chain, peers *p2p.Peers, config Config) (*Provider, error) {
+func New(chain Chain, config Config) (*Provider, error) {
 	if err := config.Verify(); err != nil {
 		return nil, err
 	}
+
 	price, err := gasprice.NewEstimator(&estimatorBackend{chain}, chain.Logger(), gasprice.DefaultConfig())
 	if err != nil {
 		return nil, fmt.Errorf("gasprice.NewEstimator(...): %v", err)
@@ -135,7 +137,7 @@ func New(chain Chain, peers *p2p.Peers, config Config) (*Provider, error) {
 		filters.NewFilterSystem(back, filters.Config{}),
 		false, /*isLightClient*/
 	)
-	srv, err := back.server(peers, filter)
+	srv, err := back.server(filter)
 	if err != nil {
 		filters.CloseAPI(filter)
 		return nil, errors.Join(err, back.close())

vms/saevm/sae/rpc/server.go

@@ -11,8 +11,6 @@ import (
 	"github.com/ava-labs/libevm/libevm/debug"
 	"github.com/ava-labs/libevm/libevm/ethapi"
 	"github.com/ava-labs/libevm/rpc"
-
-	"github.com/ava-labs/avalanchego/network/p2p"
 )
 
 // Taken as the default from geth / libevm's `node.DefaultConfig`.
@@ -24,7 +22,7 @@ func (p *Provider) Server() *rpc.Server {
 	return p.server
 }
 
-func (b *backend) server(peers *p2p.Peers, filter *filters.FilterAPI) (*rpc.Server, error) {
+func (b *backend) server(filter *filters.FilterAPI) (*rpc.Server, error) {
 	type api struct {
 		namespace string
 		api       any
@@ -41,7 +39,7 @@ func (b *backend) server(peers *p2p.Peers, filter *filters.FilterAPI) (*rpc.Serv
 		// - net_listening
 		// - net_peerCount
 		// - net_version
-		{"net", newNetAPI(peers, b.ChainConfig().ChainID.Uint64())},
+		{"net", newNetAPI(b.Peers(), b.ChainConfig().ChainID.Uint64())},
 		// geth-specific APIs:
 		// - txpool_content
 		// - txpool_contentFrom

vms/saevm/sae/vm.go

@@ -48,6 +48,7 @@ import (
 // canonical on disk with its post-execution state committed before [NewVM] is
 // called.
 type VM struct {
+	network *network.Network
 	hooks   hook.Points
 	config  Config
 	snowCtx *snow.Context
@@ -271,7 +272,7 @@ func NewVM[T hook.Transaction](
 	}
 
 	{ // ==========  RPC Provider  ==========
-		r, err := rpc.New(chain{vm, vm.exec}, network.Peers, cfg.RPCConfig)
+		r, err := rpc.New(vm.chain(), cfg.RPCConfig)
 		if err != nil {
 			return nil, err
 		}