feat: scaffold consumer chain

changelog.md

@@ -8,6 +8,7 @@
 - [#3770](https://github.com/ignite/cli/pull/3770) Add `scaffold configs` and `scaffold params` commands
 - [#3985](https://github.com/ignite/cli/pull/3985) Make some `cmd` pkg functions public
 - [#3967](https://github.com/ignite/cli/issues/3967) Add HD wallet parameters `address index` and `account number` to the chain account config
+- [#3660](https://github.com/ignite/cli/pull/3660) Add ability to scaffold ICS consumer chain
 - [#4004](https://github.com/ignite/cli/pull/4004) Remove all import placeholders using the `xast` pkg
 
 ### Changes

docs/docs/08-references/02-config.md

@@ -12,6 +12,26 @@ to describe the development environment for your blockchain.
 Only a default set of parameters is provided. If more nuanced configuration is
 required, you can add these parameters to the `config.yml` file.
 
+## Validation
+
+Ignite uses the `validation` field to determine the kind of validation
+of your blockchain. There are currently two supported kinds of validation:
+
+- `sovereign` which is the standard kind of validation where your blockchain
+  has its own validator set. This is the default value when this field is not
+  in the config file.
+- `consumer` indicates your blockchain is a consumer chain, in the sense of
+  Replicated Security. That means it doesn't have a validator set, but
+  inherits the one of a provider chain.
+
+While the `sovereign` chain is the default validation when you run the `ignite scaffold
+chain`, to scaffold a consumer chain, you have to run `ignite scaffold chain
+--consumer`.
+
+This field is, at this time of writing, only used by Ignite at the genesis
+generation step, because the genesis of a sovereign chain and a consumer chain
+are different.
+
 ## Accounts
 
 A list of user accounts created during genesis of the blockchain.

ignite/cmd/scaffold_chain.go

@@ -14,6 +14,7 @@
 	flagMinimal         = "minimal"
 	flagNoDefaultModule = "no-module"
 	flagSkipGit         = "skip-git"
+	flagIsConsumer      = "consumer"
 
 	tplScaffoldChainSuccess = `
 ⭐️ Successfully created a new blockchain '%[1]v'.
@@ -84,6 +85,9 @@
 	c.Flags().StringSlice(flagModuleConfigs, []string{}, "add module configs")
 	c.Flags().Bool(flagSkipGit, false, "skip Git repository initialization")
 	c.Flags().Bool(flagMinimal, false, "create a minimal blockchain (with the minimum required Cosmos SDK modules)")
+	c.Flags().Bool(flagIsConsumer, false, "scafffold an ICS consumer chain")
+	// Cannot have both minimal and consumer flag
+	c.MarkFlagsMutuallyExclusive(flagIsConsumer, flagMinimal)
 
 	return c
 }
@@ -99,6 +103,7 @@
 		noDefaultModule, _ = cmd.Flags().GetBool(flagNoDefaultModule)
 		skipGit, _         = cmd.Flags().GetBool(flagSkipGit)
 		minimal, _         = cmd.Flags().GetBool(flagMinimal)
+		isConsumer, _      = cmd.Flags().GetBool(flagIsConsumer)
 		params, _          = cmd.Flags().GetStringSlice(flagParams)
 		moduleConfigs, _   = cmd.Flags().GetStringSlice(flagModuleConfigs)
 	)
@@ -116,7 +121,7 @@
 		return err
 	}
 
-	appdir, err := scaffolder.Init(
+	appDir, err := scaffolder.Init(
 		cmd.Context(),
 		cacheStorage,
 		placeholder.New(),
@@ -126,14 +131,15 @@
 		noDefaultModule,
 		skipGit,
 		minimal,
+		isConsumer,
 		params,
 		moduleConfigs,
 	)
 	if err != nil {
 		return err
 	}
 
-	path, err := xfilepath.RelativePath(appdir)
+	path, err := xfilepath.RelativePath(appDir)
 	if err != nil {
 		return err
 	}

ignite/config/chain/base/config.go

@@ -153,15 +153,29 @@
 	API     string `yaml:"api"`
 }
 
+// Validation describes the kind of validation the chain has.
+type Validation string
+
+const (
+	// ValidationSovereign is when the chain has his own validator set.
+	// Note that an empty string is also considered as a sovereign validation,
+	// because this is the default value.
+	ValidationSovereign = "sovereign"
+	// ValidationConsumer is when the chain is validated by a provider chain.
+	// Such chain is called a consumer chain.
+	ValidationConsumer = "consumer"
+)
+
 // Config defines a struct with the fields that are common to all config versions.
 type Config struct {
-	Version  version.Version `yaml:"version"`
-	Build    Build           `yaml:"build,omitempty"`
-	Accounts []Account       `yaml:"accounts"`
-	Faucet   Faucet          `yaml:"faucet,omitempty"`
-	Client   Client          `yaml:"client,omitempty"`
-	Genesis  xyaml.Map       `yaml:"genesis,omitempty"`
-	Minimal  bool            `yaml:"minimal,omitempty"`
+	Validation Validation      `yaml:"validation,omitempty"`
+	Version    version.Version `yaml:"version"`
+	Build      Build           `yaml:"build,omitempty"`
+	Accounts   []Account       `yaml:"accounts"`
+	Faucet     Faucet          `yaml:"faucet,omitempty"`
+	Client     Client          `yaml:"client,omitempty"`
+	Genesis    xyaml.Map       `yaml:"genesis,omitempty"`
+	Minimal    bool            `yaml:"minimal,omitempty"`
 }
 
 // GetVersion returns the config version.
@@ -174,6 +188,14 @@
 	return c.Minimal
 }
 
+func (c Config) IsSovereignChain() bool {
+	return c.Validation == "" || c.Validation == ValidationSovereign
+}
+
+func (c Config) IsConsumerChain() bool {
+	return c.Validation == ValidationConsumer
+}
+
 // SetDefaults assigns default values to empty config fields.
 func (c *Config) SetDefaults() error {
 	return mergo.Merge(c, DefaultConfig())

ignite/internal/plugin/consumer.go

@@ -0,0 +1,39 @@
+package plugininternal
+
+import (
+	"context"
+	"strconv"
+
+	"github.com/ignite/cli/v28/ignite/pkg/errors"
+	"github.com/ignite/cli/v28/ignite/services/plugin"
+)
+
+// TODO use released version of app-consumer.
+const consumerPlugin = "github.com/ignite/apps/consumer"
+
+// ConsumerWriteGenesis writes validators in the consumer module genesis.
+// NOTE(tb): Using a plugin for this task avoids having the interchain-security
+// dependency in Ignite.
+func ConsumerWriteGenesis(ctx context.Context, c plugin.Chainer) error {
+	_, err := Execute(ctx, consumerPlugin, []string{"writeGenesis"}, plugin.WithChain(c))
+	if err != nil {
+		return errors.Errorf("execute consumer plugin 'writeGenesis': %w", err)
+	}
+	return nil
+}
+
+// ConsumerIsInitialized returns true if the consumer chain's genesis c has
+// a consumer module entry with an initial validator set.
+// NOTE(tb): Using a plugin for this task avoids having the interchain-security
+// dependency in Ignite.
+func ConsumerIsInitialized(ctx context.Context, c plugin.Chainer) (bool, error) {
+	out, err := Execute(ctx, consumerPlugin, []string{"isInitialized"}, plugin.WithChain(c))
+	if err != nil {
+		return false, errors.Errorf("execute consumer plugin 'isInitialized': %w", err)
+	}
+	b, err := strconv.ParseBool(out)
+	if err != nil {
+		return false, errors.Errorf("invalid consumer plugin 'isInitialized' output, got '%s': %w", out, err)
+	}
+	return b, nil
+}

ignite/internal/plugin/consumer_test.go

@@ -0,0 +1,134 @@
+package plugininternal
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/ignite/cli/v28/ignite/services/plugin"
+	"github.com/ignite/cli/v28/ignite/services/plugin/mocks"
+)
+
+func TestConsumerPlugin(t *testing.T) {
+	tests := []struct {
+		name           string
+		args           []string
+		setup          func(*testing.T, string)
+		expectedOutput string
+		expectedError  string
+	}{
+		{
+			name:          "fail: missing arg",
+			expectedError: "missing argument",
+		},
+		{
+			name:          "fail: invalid arg",
+			args:          []string{"xxx"},
+			expectedError: "invalid argument \"xxx\"",
+		},
+		{
+			name:          "fail: writeGenesis w/o priv_validator_key.json",
+			args:          []string{"writeGenesis"},
+			expectedError: "open .*/config/priv_validator_key.json: no such file or directory",
+		},
+		{
+			name: "fail: writeFenesis w/o genesis.json",
+			args: []string{"writeGenesis"},
+			setup: func(t *testing.T, path string) {
+				// Add priv_validator_key.json to path
+				bz, err := os.ReadFile("testdata/consumer/config/priv_validator_key.json")
+				require.NoError(t, err)
+				err = os.WriteFile(filepath.Join(path, "config", "priv_validator_key.json"), bz, 0o777)
+				require.NoError(t, err)
+			},
+			expectedError: ".*/config/genesis.json does not exist, run `init` first",
+		},
+
+		{
+			name: "ok: writeGenesis",
+			args: []string{"writeGenesis"},
+			setup: func(t *testing.T, path string) {
+				// Add priv_validator_key.json to path
+				bz, err := os.ReadFile("testdata/consumer/config/priv_validator_key.json")
+				require.NoError(t, err)
+				err = os.WriteFile(filepath.Join(path, "config", "priv_validator_key.json"), bz, 0o777)
+				require.NoError(t, err)
+
+				// Add genesis.json to path
+				bz, err = os.ReadFile("testdata/consumer/config/genesis.json")
+				require.NoError(t, err)
+				err = os.WriteFile(filepath.Join(path, "config", "genesis.json"), bz, 0o777)
+				require.NoError(t, err)
+			},
+		},
+		{
+			name:           "ok: isInitialized returns false",
+			args:           []string{"isInitialized"},
+			expectedOutput: "false",
+		},
+		{
+			name: "ok: isInitialized returns true",
+			args: []string{"isInitialized"},
+			setup: func(t *testing.T, path string) {
+				// isInitialized returns true if there's a consumer genesis with an
+				// InitialValSet length != 0
+				// Add priv_validator_key.json to path
+				bz, err := os.ReadFile("testdata/consumer/config/priv_validator_key.json")
+				require.NoError(t, err)
+				err = os.WriteFile(filepath.Join(path, "config", "priv_validator_key.json"), bz, 0o777)
+				require.NoError(t, err)
+
+				// Add genesis.json to path
+				bz, err = os.ReadFile("testdata/consumer/config/genesis.json")
+				require.NoError(t, err)
+				err = os.WriteFile(filepath.Join(path, "config", "genesis.json"), bz, 0o777)
+				require.NoError(t, err)
+
+				// Call writeGenesis to create the genesis
+				chainer := mocks.NewChainerInterface(t)
+				chainer.EXPECT().ID().Return("id", nil).Maybe()
+				chainer.EXPECT().AppPath().Return("apppath").Maybe()
+				chainer.EXPECT().ConfigPath().Return("configpath").Maybe()
+				chainer.EXPECT().Home().Return(path, nil).Maybe()
+				chainer.EXPECT().RPCPublicAddress().Return("rpcPublicAddress", nil).Maybe()
+				_, err = Execute(context.Background(), consumerPlugin, []string{"writeGenesis"}, plugin.WithChain(chainer))
+				require.NoError(t, err)
+			},
+			expectedOutput: "true",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			homePath := t.TempDir()
+			err := os.MkdirAll(filepath.Join(homePath, "config"), 0o777)
+			require.NoError(t, err)
+			chainer := mocks.NewChainerInterface(t)
+			chainer.EXPECT().ID().Return("id", nil).Maybe()
+			chainer.EXPECT().AppPath().Return("apppath").Maybe()
+			chainer.EXPECT().ConfigPath().Return("configpath").Maybe()
+			chainer.EXPECT().Home().Return(homePath, nil).Maybe()
+			chainer.EXPECT().RPCPublicAddress().Return("rpcPublicAddress", nil).Maybe()
+			if tt.setup != nil {
+				tt.setup(t, homePath)
+			}
+
+			out, err := Execute(
+				context.Background(),
+				consumerPlugin,
+				tt.args,
+				plugin.WithChain(chainer),
+			)
+
+			if tt.expectedError != "" {
+				require.Error(t, err)
+				require.Regexp(t, tt.expectedError, err.Error())
+				return
+			}
+			require.NoError(t, err)
+			require.Equal(t, tt.expectedOutput, out)
+		})
+	}
+}

ignite/internal/plugin/execute_test.go

@@ -15,23 +15,23 @@ import (
 
 func TestPluginExecute(t *testing.T) {
 	tests := []struct {
-		name          string
-		pluginPath    string
-		expectedOut   string
-		expectedError string
+		name           string
+		pluginPath     string
+		expectedOutput string
+		expectedError  string
 	}{
 		{
 			name:          "fail: plugin doesnt exist",
 			pluginPath:    "/not/exists",
 			expectedError: "local app path \"/not/exists\" not found: stat /not/exists: no such file or directory",
 		},
 		{
-			name:        "ok: plugin execute ok ",
-			pluginPath:  "testdata/execute_ok",
-			expectedOut: "ok args=[arg1 arg2] chainid=id appPath=apppath configPath=configpath home=home rpcAddress=rpcPublicAddress\n",
+			name:           "ok: plugin execute ok",
+			pluginPath:     "testdata/execute_ok",
+			expectedOutput: "ok args=[arg1 arg2] chainid=id appPath=apppath configPath=configpath home=home rpcAddress=rpcPublicAddress\n",
 		},
 		{
-			name:          "ok: plugin execute fail ",
+			name:          "ok: plugin execute fail",
 			pluginPath:    "testdata/execute_fail",
 			expectedError: "fail",
 		},
@@ -64,7 +64,7 @@ func TestPluginExecute(t *testing.T) {
 				return
 			}
 			require.NoError(t, err)
-			require.Equal(t, tt.expectedOut, out)
+			require.Equal(t, tt.expectedOutput, out)
 		})
 	}
 }

ignite/internal/plugin/testdata/consumer/config/genesis.json

@@ -0,0 +1,9 @@
+{
+  "app_name": "test",
+  "app_version": "",
+  "genesis_time": "2024-01-19T10:27:44.742750573Z",
+  "chain_id": "test",
+  "initial_height": 1,
+  "app_hash": null,
+  "app_state": {}
+}

ignite/internal/plugin/testdata/consumer/config/priv_validator_key.json

@@ -0,0 +1,11 @@
+{
+  "address": "2D3C15095E5EAA318CAEDE1C2D02C77581584751",
+  "pub_key": {
+    "type": "tendermint/PubKeyEd25519",
+    "value": "uBOT+dDuUvXjJrkfwMNrS4bRT4/O+fBnpwfYpR6n1Wk="
+  },
+  "priv_key": {
+    "type": "tendermint/PrivKeyEd25519",
+    "value": "HovIzTJTGMrQx5oBikjfypyMZYF9QP5MxS+S+S/3QYq4E5P50O5S9eMmuR/Aw2tLhtFPj8758GenB9ilHqfVaQ=="
+  }
+}