add network id option to Start()

Author: felipemadero

client/client.go

@@ -455,7 +455,7 @@ type Op struct {
 	subnetConfigs       map[string]string
 	reassignPortsIfUsed bool
 	dynamicPorts        bool
-	networkID           *uint32
+	networkID           uint32
 }
 
 type OpOption func(*Op)
@@ -474,7 +474,7 @@ func WithGlobalNodeConfig(nodeConfig string) OpOption {
 
 func WithNetworkID(networkId uint32) OpOption {
 	return func(op *Op) {
-		op.networkID = &networkId
+		op.networkID = networkId
 	}
 }
 

local/network.go

@@ -444,20 +444,19 @@ func (ln *localNetwork) loadConfig(ctx context.Context, networkConfig network.Co
 
 	ln.genesis = []byte(networkConfig.Genesis)
 
-	if networkConfig.NetworkID != nil {
-		ln.networkID = *networkConfig.NetworkID
-		genesis, err := utils.SetGenesisNetworkID(ln.genesis, ln.networkID)
-		if err != nil {
-			return fmt.Errorf("couldn't set network ID to genesis: %w", err)
-		}
-		ln.genesis = genesis
-	} else {
-		var err error
-		ln.networkID, err = utils.NetworkIDFromGenesis(ln.genesis)
-		if err != nil {
-			return fmt.Errorf("couldn't get network ID from genesis: %w", err)
+	// Set network ID
+	ln.networkID = constants.DefaultNetworkID
+	if networkConfig.NetworkID != 0 {
+		if networkConfig.NetworkID < 11 {
+			return fmt.Errorf("network IDs < 11 are reserved ones")
 		}
+		ln.networkID = networkConfig.NetworkID
+	}
+	genesis, err := utils.SetGenesisNetworkID(ln.genesis, ln.networkID)
+	if err != nil {
+		return fmt.Errorf("couldn't set network ID to genesis: %w", err)
 	}
+	ln.genesis = genesis
 
 	// save node defaults
 	ln.flags = networkConfig.Flags

network/config.go

@@ -50,8 +50,9 @@ type AddrAndBalance struct {
 // Config that defines a network when it is created.
 type Config struct {
 	// Must not be empty
-	Genesis   string  `json:"genesis"`
-	NetworkID *uint32 `json:"networkID"`
+	Genesis string `json:"genesis"`
+	// If 0, will use default network ID
+	NetworkID uint32 `json:"networkID"`
 	// May have length 0
 	// (i.e. network may have no nodes on creation.)
 	NodeConfigs []node.Config `json:"nodeConfigs"`

rpcpb/rpc.pb.go

@@ -351,7 +351,8 @@ message StartRequest {
   // the contents provided here.
   map<string, string> subnet_configs = 13;
 
-  optional uint32 network_id = 14;
+  // Network id to assign to the network, instead of default one
+  uint32 network_id = 14;
 }
 
 message RPCVersionRequest {}

rpcpb/rpc.proto

@@ -110,7 +110,7 @@ type localNetworkOptions struct {
 
 	dynamicPorts bool
 
-	networkID *uint32
+	networkID uint32
 }
 
 func newLocalNetwork(opts localNetworkOptions) (*localNetwork, error) {
@@ -163,9 +163,7 @@ func (lc *localNetwork) createConfig() error {
 		cfg.Flags[config.PluginDirKey] = lc.pluginDir
 	}
 
-	if lc.options.networkID != nil {
-		cfg.NetworkID = lc.options.networkID
-	}
+	cfg.NetworkID = lc.options.networkID
 
 	for i := range cfg.NodeConfigs {
 		// NOTE: Naming convention for node names is currently `node` + number, i.e. `node1,node2,node3,...node101`

rpcpb/rpc_grpc.pb.go

@@ -11,9 +11,10 @@ const (
 	RootDirPrefix          = "network-runner-root-data"
 	DefaultExecPathEnvVar  = "AVALANCHEGO_EXEC_PATH"
 	DefaultPluginDirEnvVar = "AVALANCHEGO_PLUGIN_PATH"
+	LocalGenesisFile       = "genesis.json"
+	DefaultNetworkID       = uint32(1337)
 )
 
 var (
-	LocalConfigDir   = filepath.Join("local", "default")
-	LocalGenesisFile = "genesis.json"
+	LocalConfigDir = filepath.Join("local", "default")
 )

server/network.go

@@ -20,6 +20,12 @@ const (
 	dirTimestampFormat  = "20060102_150405"
 )
 
+var (
+	ErrEmptyExecPath   = errors.New("avalanche exec is not defined")
+	ErrNotExists       = errors.New("avalanche exec not exists")
+	ErrNotExistsPlugin = errors.New("plugin exec not exists")
+)
+
 func ToNodeID(stakingKey, stakingCert []byte) (ids.NodeID, error) {
 	tlsCert, err := staking.LoadTLSCertFromBytes(stakingKey, stakingCert)
 	if err != nil {
@@ -61,12 +67,6 @@ func SetGenesisNetworkID(genesis []byte, networkID uint32) ([]byte, error) {
 	return genesis, nil
 }
 
-var (
-	ErrEmptyExecPath   = errors.New("avalanche exec is not defined")
-	ErrNotExists       = errors.New("avalanche exec not exists")
-	ErrNotExistsPlugin = errors.New("plugin exec not exists")
-)
-
 func CheckExecPath(exec string) error {
 	if exec == "" {
 		return ErrEmptyExecPath