Merge pull request #673 from ava-labs/add-subnet-validator-new

Add subnet validators

Author: felipemadero

client/client.go

@@ -37,6 +37,7 @@ type Client interface {
 	AddPermissionlessValidator(ctx context.Context, validatorSpec []*rpcpb.PermissionlessStakerSpec) (*rpcpb.AddPermissionlessValidatorResponse, error)
 	AddPermissionlessDelegator(ctx context.Context, validatorSpec []*rpcpb.PermissionlessStakerSpec) (*rpcpb.AddPermissionlessDelegatorResponse, error)
 	RemoveSubnetValidator(ctx context.Context, validatorSpec []*rpcpb.RemoveSubnetValidatorSpec) (*rpcpb.RemoveSubnetValidatorResponse, error)
+	AddSubnetValidators(ctx context.Context, validatorSpec []*rpcpb.SubnetValidatorsSpec) (*rpcpb.AddSubnetValidatorsResponse, error)
 	Health(ctx context.Context) (*rpcpb.HealthResponse, error)
 	WaitForHealthy(ctx context.Context) (*rpcpb.WaitForHealthyResponse, error)
 	URIs(ctx context.Context) ([]string, error)
@@ -203,6 +204,15 @@ func (c *client) RemoveSubnetValidator(ctx context.Context, validatorSpec []*rpc
 	return c.controlc.RemoveSubnetValidator(ctx, req)
 }
 
+func (c *client) AddSubnetValidators(ctx context.Context, validatorSpec []*rpcpb.SubnetValidatorsSpec) (*rpcpb.AddSubnetValidatorsResponse, error) {
+	req := &rpcpb.AddSubnetValidatorsRequest{
+		ValidatorsSpec: validatorSpec,
+	}
+
+	c.log.Info("add subnet validators")
+	return c.controlc.AddSubnetValidators(ctx, req)
+}
+
 func (c *client) Health(ctx context.Context) (*rpcpb.HealthResponse, error) {
 	c.log.Info("health")
 	return c.controlc.Health(ctx, &rpcpb.HealthRequest{})

cmd/control/control.go

@@ -63,6 +63,7 @@ func NewCommand() *cobra.Command {
 		newTransformElasticSubnetsCommand(),
 		newAddPermissionlessValidatorCommand(),
 		newAddPermissionlessDelegatorCommand(),
+		newAddSubnetValidatorsCommand(),
 		newRemoveSubnetValidatorCommand(),
 		newHealthCommand(),
 		newWaitForHealthyCommand(),
@@ -444,6 +445,16 @@ func newAddPermissionlessValidatorCommand() *cobra.Command {
 	return cmd
 }
 
+func newAddSubnetValidatorsCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "add-subnet-validators validatorsSpec [options]",
+		Short: "Adds subnet validators",
+		RunE:  addSubnetValidatorsFunc,
+		Args:  cobra.ExactArgs(1),
+	}
+	return cmd
+}
+
 func newRemoveSubnetValidatorCommand() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "remove-subnet-validator removeValidatorSpec [options]",
@@ -538,6 +549,34 @@ func addPermissionlessValidatorFunc(_ *cobra.Command, args []string) error {
 	return nil
 }
 
+func addSubnetValidatorsFunc(_ *cobra.Command, args []string) error {
+	cli, err := newClient()
+	if err != nil {
+		return err
+	}
+	defer cli.Close()
+
+	validatorSpecsStr := args[0]
+
+	validatorSpecs := []*rpcpb.SubnetValidatorsSpec{}
+	if err := json.Unmarshal([]byte(validatorSpecsStr), &validatorSpecs); err != nil {
+		return err
+	}
+
+	ctx := getAsyncContext()
+
+	info, err := cli.AddSubnetValidators(
+		ctx,
+		validatorSpecs,
+	)
+	if err != nil {
+		return err
+	}
+
+	ux.Print(log, logging.Green.Wrap("add-subnet-validators response: %+v"), info)
+	return nil
+}
+
 func removeSubnetValidatorFunc(_ *cobra.Command, args []string) error {
 	cli, err := newClient()
 	if err != nil {

docs/examples.md

@@ -185,6 +185,25 @@ curl -X POST -k http://localhost:8081/v1/control/listsubnets
 avalanche-network-runner control list-subnets
 ```
 
+To add a node as a validator to a Subnet:
+
+```sh
+curl -X POST -k http://localhost:8081/v1/control/addsubnetvalidators  -d '[{"subnetId": "'$SUBNET_ID'", "nodeNames":["node1"]}]'
+
+# or
+avalanche-network-runner control add-subnet-validators '[{"subnet_id": "'$SUBNET_ID'", "node_names":["node1"]}]'
+```
+
+To remove a node as a validator from a Subnet:
+
+```sh
+curl -X POST -k http://localhost:8081/v1/control/removesubnetvalidator  -d '[{"subnetId": "'$SUBNET_ID'", "nodeNames":["node1"]}]'
+
+# or
+avalanche-network-runner control remove-subnet-validator '[{"subnet_id": "'$SUBNET_ID'", "node_names":["node1"]}]'
+```
+
+
 ## Operating with blockchains
 
 **Note**: To create a blockchain, the vm binary for it should be present under the plugin dir, with a filename equal to the vm id. The plugin dir

docs/reference.md

@@ -172,6 +172,32 @@ curl --location 'http://localhost:8081/v1/control/addpermissionlessvalidator' \
 ]}'
 ```
 
+## `add-subnet-validators`
+
+Adds subnet validators
+
+### Usage
+
+```sh
+avalanche-network-runner control add-subnet-validators validatorsSpec [options] [flags]
+```
+
+### Example
+
+cli
+
+```sh
+avalanche-network-runner control add-subnet-validators '[{"subnet_id": "p433wpuXyJiDhyazPYyZMJeaoPSW76CBZ2x7wrVPLgvokotXz", "node_names":["node1"]}]'
+```
+
+curl
+
+```sh
+curl --location 'http://localhost:8081/v1/control/addsubnetvalidators' \
+--header 'Content-Type: application/json' \
+--data '[{"subnetId": "p433wpuXyJiDhyazPYyZMJeaoPSW76CBZ2x7wrVPLgvokotXz", "nodeNames":["node1"]}]'
+
+
 ## `attach-peer`
 
 Attaches a peer to the node.

local/blockchain.go

@@ -154,14 +154,24 @@ func (ln *localNetwork) RegisterBlockchainAliases(
 	return nil
 }
 
+func (ln *localNetwork) AddSubnetValidators(
+	ctx context.Context,
+	subnetSpecs []network.SubnetValidatorsSpec,
+) error {
+	ln.lock.Lock()
+	defer ln.lock.Unlock()
+
+	return ln.addSubnetValidators(ctx, subnetSpecs)
+}
+
 func (ln *localNetwork) RemoveSubnetValidators(
 	ctx context.Context,
-	removeSubnetSpecs []network.RemoveSubnetValidatorSpec,
+	subnetSpecs []network.SubnetValidatorsSpec,
 ) error {
 	ln.lock.Lock()
 	defer ln.lock.Unlock()
 
-	return ln.removeSubnetValidators(ctx, removeSubnetSpecs)
+	return ln.removeSubnetValidators(ctx, subnetSpecs)
 }
 
 func (ln *localNetwork) AddPermissionlessValidators(
@@ -342,7 +352,7 @@ func (ln *localNetwork) installCustomChains(
 		return nil, err
 	}
 
-	if err = ln.addSubnetValidators(ctx, platformCli, w, subnetIDs, subnetSpecs); err != nil {
+	if err = ln.issueSubnetValidatorTxs(ctx, platformCli, w, subnetIDs, subnetSpecs); err != nil {
 		return nil, err
 	}
 
@@ -409,6 +419,88 @@ func (ln *localNetwork) installCustomChains(
 	return chainInfos, nil
 }
 
+func (ln *localNetwork) addSubnetValidators(
+	ctx context.Context,
+	subnetValidatorsSpecs []network.SubnetValidatorsSpec,
+) error {
+	ln.log.Info(logging.Blue.Wrap(logging.Bold.Wrap("add subnet validators")))
+
+	clientURI, err := ln.getClientURI()
+	if err != nil {
+		return err
+	}
+	platformCli := platformvm.NewClient(clientURI)
+
+	// wallet needs txs for all previously created subnets
+	subnetIDs := make([]ids.ID, len(subnetValidatorsSpecs))
+	for i, spec := range subnetValidatorsSpecs {
+		subnetID, err := ids.FromString(spec.SubnetID)
+		if err != nil {
+			return err
+		}
+		subnetIDs[i] = subnetID
+	}
+	w, err := newWallet(ctx, clientURI, subnetIDs)
+	if err != nil {
+		return err
+	}
+
+	for _, spec := range subnetValidatorsSpecs {
+		if len(spec.NodeNames) == 0 {
+			return fmt.Errorf("no validators provided for subnet %s", spec.SubnetID)
+		}
+	}
+
+	// create new nodes
+	for _, spec := range subnetValidatorsSpecs {
+		for _, nodeName := range spec.NodeNames {
+			_, ok := ln.nodes[nodeName]
+			if !ok {
+				ln.log.Info(logging.Green.Wrap(fmt.Sprintf("adding new participant %s", nodeName)))
+				if _, err := ln.addNode(node.Config{
+					Name:           nodeName,
+					RedirectStdout: ln.redirectStdout,
+					RedirectStderr: ln.redirectStderr,
+				}); err != nil {
+					return err
+				}
+			}
+		}
+	}
+	if err := ln.healthy(ctx); err != nil {
+		return err
+	}
+
+	// just ensure all nodes are primary validators (so can be subnet validators)
+	if err := ln.addPrimaryValidators(ctx, platformCli, w); err != nil {
+		return err
+	}
+
+	// wait for nodes to be primary validators before trying to add them as subnet ones
+	if err = ln.waitPrimaryValidators(ctx, platformCli); err != nil {
+		return err
+	}
+
+	subnetSpecs := []network.SubnetSpec{}
+	for _, spec := range subnetValidatorsSpecs {
+		subnetSpecs = append(subnetSpecs, network.SubnetSpec{Participants: spec.NodeNames})
+	}
+
+	if err = ln.issueSubnetValidatorTxs(ctx, platformCli, w, subnetIDs, subnetSpecs); err != nil {
+		return err
+	}
+
+	if err := ln.restartNodes(ctx, subnetIDs, subnetSpecs, nil, nil, nil); err != nil {
+		return err
+	}
+
+	if err = ln.waitSubnetValidators(ctx, platformCli, subnetIDs, subnetSpecs); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (ln *localNetwork) installSubnets(
 	ctx context.Context,
 	subnetSpecs []network.SubnetSpec,
@@ -479,7 +571,7 @@ func (ln *localNetwork) installSubnets(
 		return nil, err
 	}
 
-	if err = ln.addSubnetValidators(ctx, platformCli, w, subnetIDs, subnetSpecs); err != nil {
+	if err = ln.issueSubnetValidatorTxs(ctx, platformCli, w, subnetIDs, subnetSpecs); err != nil {
 		return nil, err
 	}
 
@@ -586,7 +678,7 @@ func (ln *localNetwork) restartNodes(
 	subnetIDs []ids.ID,
 	subnetSpecs []network.SubnetSpec,
 	validatorSpecs []network.PermissionlessStakerSpec,
-	removeValidatorSpecs []network.RemoveSubnetValidatorSpec,
+	removeValidatorSpecs []network.SubnetValidatorsSpec,
 	nodesToRestartForBlockchainConfigUpdate set.Set[string],
 ) (err error) {
 	if (subnetSpecs != nil && validatorSpecs != nil) || (subnetSpecs != nil && removeValidatorSpecs != nil) ||
@@ -879,7 +971,7 @@ func importPChainFromXChain(ctx context.Context, w *wallet, owner *secp256k1fx.O
 
 func (ln *localNetwork) removeSubnetValidators(
 	ctx context.Context,
-	removeSubnetSpecs []network.RemoveSubnetValidatorSpec,
+	removeSubnetSpecs []network.SubnetValidatorsSpec,
 ) error {
 	ln.log.Info("removing subnet validator tx")
 	removeSubnetSpecIDs := make([]ids.ID, len(removeSubnetSpecs))
@@ -1314,7 +1406,7 @@ func createSubnets(
 // add the nodes in subnet participant as validators of the given subnets, in case they are not
 // the validation starts as soon as possible and its duration is as long as possible, that is,
 // it ends at the time the primary network validation ends for the node
-func (ln *localNetwork) addSubnetValidators(
+func (ln *localNetwork) issueSubnetValidatorTxs(
 	ctx context.Context,
 	platformCli platformvm.Client,
 	w *wallet,

network/network.go

@@ -47,7 +47,7 @@ type SubnetSpec struct {
 	SubnetConfig []byte
 }
 
-type RemoveSubnetValidatorSpec struct {
+type SubnetValidatorsSpec struct {
 	NodeNames []string
 	SubnetID  string
 }
@@ -120,7 +120,9 @@ type Network interface {
 	// Add a validator into an elastic subnet
 	AddPermissionlessValidators(context.Context, []PermissionlessStakerSpec) error
 	// Remove a validator from a subnet
-	RemoveSubnetValidators(context.Context, []RemoveSubnetValidatorSpec) error
+	RemoveSubnetValidators(context.Context, []SubnetValidatorsSpec) error
+	// Add a validator toa subnet
+	AddSubnetValidators(context.Context, []SubnetValidatorsSpec) error
 	// Get the elastic subnet tx id for the given subnet id
 	GetElasticSubnetID(context.Context, ids.ID) (ids.ID, error)
 }