Merge pull request #665 from ava-labs/set-network-id

Set network id on Start() call

Author: felipemadero

client/client.go

@@ -117,6 +117,7 @@ func (c *client) Start(ctx context.Context, execPath string, opts ...OpOption) (
 	ret.applyOpts(opts)
 
 	req := &rpcpb.StartRequest{
+		NetworkId:      ret.networkID,
 		ExecPath:       execPath,
 		NumNodes:       &ret.numNodes,
 		ChainConfigs:   ret.chainConfigs,
@@ -454,6 +455,7 @@ type Op struct {
 	subnetConfigs       map[string]string
 	reassignPortsIfUsed bool
 	dynamicPorts        bool
+	networkID           uint32
 }
 
 type OpOption func(*Op)
@@ -470,6 +472,12 @@ func WithGlobalNodeConfig(nodeConfig string) OpOption {
 	}
 }
 
+func WithNetworkID(networkID uint32) OpOption {
+	return func(op *Op) {
+		op.networkID = networkID
+	}
+}
+
 func WithNumNodes(numNodes uint32) OpOption {
 	return func(op *Op) {
 		op.numNodes = numNodes

cmd/control/control.go

@@ -104,6 +104,7 @@ var (
 	subnetConfigs       string
 	reassignPortsIfUsed bool
 	dynamicPorts        bool
+	networkID           uint32
 )
 
 func setLogs() error {
@@ -176,6 +177,12 @@ func newStartCommand() *cobra.Command {
 		"",
 		"avalanchego binary path",
 	)
+	cmd.PersistentFlags().Uint32Var(
+		&networkID,
+		"network-id",
+		0,
+		"network id to assign to the network",
+	)
 	cmd.PersistentFlags().Uint32Var(
 		&numNodes,
 		"number-of-nodes",
@@ -265,6 +272,7 @@ func startFunc(*cobra.Command, []string) error {
 		client.WithRootDataDir(rootDataDir),
 		client.WithReassignPortsIfUsed(reassignPortsIfUsed),
 		client.WithDynamicPorts(dynamicPorts),
+		client.WithNetworkID(networkID),
 	}
 
 	if globalNodeConfig != "" {

local/network.go

@@ -28,6 +28,7 @@ import (
 	"github.com/ava-labs/avalanchego/network/peer"
 	"github.com/ava-labs/avalanchego/staking"
 	"github.com/ava-labs/avalanchego/utils/beacon"
+	avagoconstants "github.com/ava-labs/avalanchego/utils/constants"
 	"github.com/ava-labs/avalanchego/utils/crypto/bls"
 	"github.com/ava-labs/avalanchego/utils/ips"
 	"github.com/ava-labs/avalanchego/utils/logging"
@@ -444,11 +445,24 @@ func (ln *localNetwork) loadConfig(ctx context.Context, networkConfig network.Co
 
 	ln.genesis = []byte(networkConfig.Genesis)
 
+	// Set network ID
 	var err error
-	ln.networkID, err = utils.NetworkIDFromGenesis([]byte(networkConfig.Genesis))
+	ln.networkID, err = utils.NetworkIDFromGenesis(ln.genesis)
 	if err != nil {
-		return fmt.Errorf("couldn't get network ID from genesis: %w", err)
+		return err
+	}
+	if networkConfig.NetworkID != 0 {
+		ln.networkID = networkConfig.NetworkID
+	}
+	switch ln.networkID {
+	case avagoconstants.TestnetID, avagoconstants.MainnetID:
+		return errors.New("network ID can't be mainnet or testnet")
+	}
+	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

@@ -51,6 +51,8 @@ type AddrAndBalance struct {
 type Config struct {
 	// Must not be empty
 	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"`
@@ -87,6 +89,9 @@ func (c *Config) Validate() error {
 	if err != nil {
 		return fmt.Errorf("couldn't get network ID from genesis: %w", err)
 	}
+	if c.NetworkID != 0 {
+		networkID = c.NetworkID
+	}
 
 	var someNodeIsBeacon bool
 	for i, nodeConfig := range c.NodeConfigs {

rpcpb/rpc.pb.go

@@ -350,6 +350,9 @@ message StartRequest {
   // If specified, will create a file "subnetid.json" under subnets config dir with
   // the contents provided here.
   map<string, string> subnet_configs = 13;
+
+  // Network id to assign to the network, instead of default one
+  uint32 network_id = 14;
 }
 
 message RPCVersionRequest {}

rpcpb/rpc.proto

@@ -109,6 +109,8 @@ type localNetworkOptions struct {
 	reassignPortsIfUsed bool
 
 	dynamicPorts bool
+
+	networkID uint32
 }
 
 func newLocalNetwork(opts localNetworkOptions) (*localNetwork, error) {
@@ -161,6 +163,8 @@ func (lc *localNetwork) createConfig() error {
 		cfg.Flags[config.PluginDirKey] = lc.pluginDir
 	}
 
+	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`
 		nodeName := fmt.Sprintf("node%d", i+1)

rpcpb/rpc_grpc.pb.go

@@ -328,6 +328,7 @@ func (s *server) Start(_ context.Context, req *rpcpb.StartRequest) (*rpcpb.Start
 	}
 
 	s.network, err = newLocalNetwork(localNetworkOptions{
+		networkID:           req.NetworkId,
 		execPath:            execPath,
 		rootDataDir:         rootDataDir,
 		numNodes:            numNodes,

server/network.go

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

server/server.go

@@ -20,6 +20,13 @@ 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")
+	ErrorNoNetworkIDKey = fmt.Errorf("couldn't find key %q in genesis", genesisNetworkIDKey)
+)
+
 func ToNodeID(stakingKey, stakingCert []byte) (ids.NodeID, error) {
 	tlsCert, err := staking.LoadTLSCertFromBytes(stakingKey, stakingCert)
 	if err != nil {
@@ -47,11 +54,19 @@ func NetworkIDFromGenesis(genesis []byte) (uint32, error) {
 	return uint32(networkID), 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 SetGenesisNetworkID(genesis []byte, networkID uint32) ([]byte, error) {
+	genesisMap := map[string]interface{}{}
+	if err := json.Unmarshal(genesis, &genesisMap); err != nil {
+		return nil, fmt.Errorf("couldn't unmarshal genesis: %w", err)
+	}
+	genesisMap[genesisNetworkIDKey] = networkID
+	var err error
+	genesis, err = json.Marshal(genesisMap)
+	if err != nil {
+		return nil, fmt.Errorf("couldn't marshal genesis: %w", err)
+	}
+	return genesis, nil
+}
 
 func CheckExecPath(exec string) error {
 	if exec == "" {