Merge branch 'main' into feat/auto-migdoc

ignite · Mar 1, 2024 · ba21ba9 · ba21ba9
2 parents 6f7c06e + 3ca22be
commit ba21ba9
Show file tree

Hide file tree

Showing 21 changed files with 107 additions and 1,090 deletions.
diff --git a/changelog.md b/changelog.md
@@ -10,14 +10,16 @@
 
 ### Changes
 
+- [#3993](https://github.com/ignite/cli/pull/3993) Oracle scaffolding was deprecated and has been removed
 - [#3959](https://github.com/ignite/cli/pull/3959) Remove app name prefix from the `.gitignore` file
-- [#3962](https://github.com/ignite/cli/pull/3962) Rename all RPC endpoints and autocli commands generated for `map`/`list`/`single` types 
+- [#3962](https://github.com/ignite/cli/pull/3962) Rename all RPC endpoints and autocli commands generated for `map`/`list`/`single` types
 - [#3972](https://github.com/ignite/cli/pull/3972) Skip Ignite app loading for some base commands that don't allow apps
 - [#3976](https://github.com/ignite/cli/pull/3976) Remove error checks for Cobra command value get calls
 - [#3983](https://github.com/ignite/cli/pull/3983) Bump `cosmos-sdk` to `v0.50.4` and `ibc-go` to `v8.1.0`
 
 ### Fixes
 
+- [#3995](https://github.com/ignite/cli/pull/3995) Fix interface check for ibc modules
 - [#3953](https://github.com/ignite/cli/pull/3953) Fix apps `Stdout` is redirected to `Stderr`
 - [#3863](https://github.com/ignite/cli/pull/3963) Fix breaking issue for app client API when reading app chain info
 - [#3969](https://github.com/ignite/cli/pull/3969) Get first config validator using a getter to avoid index errors

diff --git a/docs/docs/08-references/01-cli.md b/docs/docs/08-references/01-cli.md
@@ -3023,11 +3023,13 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled.
 
 * [ignite](#ignite)	 - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain
 * [ignite scaffold chain](#ignite-scaffold-chain)	 - New Cosmos SDK blockchain
+* [ignite scaffold configs](#ignite-scaffold-configs)	 - Configs for a custom Cosmos SDK module
 * [ignite scaffold list](#ignite-scaffold-list)	 - CRUD for data stored as an array
 * [ignite scaffold map](#ignite-scaffold-map)	 - CRUD for data stored as key-value pairs
 * [ignite scaffold message](#ignite-scaffold-message)	 - Message to perform state transition on the blockchain
 * [ignite scaffold module](#ignite-scaffold-module)	 - Custom Cosmos SDK module
 * [ignite scaffold packet](#ignite-scaffold-packet)	 - Message for sending an IBC packet
+* [ignite scaffold params](#ignite-scaffold-params)	 - Parameters for a custom Cosmos SDK module
 * [ignite scaffold query](#ignite-scaffold-query)	 - Query for fetching data from a blockchain
 * [ignite scaffold react](#ignite-scaffold-react)	 - React web app template
 * [ignite scaffold single](#ignite-scaffold-single)	 - CRUD for data stored in a single location
@@ -3090,14 +3092,53 @@ ignite scaffold chain [name] [flags]
 **Options**
 
 ```
-      --address-prefix string   account address prefix (default "cosmos")
-      --clear-cache             clear the build cache (advanced)
-  -h, --help                    help for chain
-      --minimal                 create a minimal blockchain (with the minimum required Cosmos SDK modules)
-      --no-module               create a project without a default module
-      --params strings          add default module parameters
-  -p, --path string             create a project in a specific path
-      --skip-git                skip Git repository initialization
+      --address-prefix string    account address prefix (default "cosmos")
+      --clear-cache              clear the build cache (advanced)
+  -h, --help                     help for chain
+      --minimal                  create a minimal blockchain (with the minimum required Cosmos SDK modules)
+      --module-configs strings   add module configs
+      --no-module                create a project without a default module
+      --params strings           add default module parameters
+  -p, --path string              create a project in a specific path
+      --skip-git                 skip Git repository initialization
+```
+
+**SEE ALSO**
+
+* [ignite scaffold](#ignite-scaffold)	 - Create a new blockchain, module, message, query, and more
+
+
+## ignite scaffold configs
+
+Configs for a custom Cosmos SDK module
+
+**Synopsis**
+
+Scaffold a new config for a Cosmos SDK module.
+
+A Cosmos SDK module can have configurations. An example of a config is "address prefix" of the
+"auth" module. A config can be scaffolded into a module using the "--module-configs" into
+the scaffold module command or using the "scaffold configs" command. By default 
+configs are of type "string", but you can specify a type for each config. For example:
+
+	ignite scaffold configs foo baz:uint bar:bool
+
+Refer to Cosmos SDK documentation to learn more about modules, dependencies and
+configs.
+
+
+```
+ignite scaffold configs [configs]... [flags]
+```
+
+**Options**
+
+```
+      --clear-cache     clear the build cache (advanced)
+  -h, --help            help for configs
+      --module string   module to add the query into (default: app's main module)
+  -p, --path string     path of the app (default ".")
+  -y, --yes             answers interactive yes/no questions with yes
 ```
 
 **SEE ALSO**
@@ -3438,15 +3479,16 @@ ignite scaffold module [name] [flags]
 **Options**
 
 ```
-      --clear-cache            clear the build cache (advanced)
-      --dep strings            add a dependency on another module
-  -h, --help                   help for module
-      --ibc                    add IBC functionality
-      --ordering string        channel ordering of the IBC module [none|ordered|unordered] (default "none")
-      --params strings         add module parameters
-  -p, --path string            path of the app (default ".")
-      --require-registration   fail if module can't be registered
-  -y, --yes                    answers interactive yes/no questions with yes
+      --clear-cache              clear the build cache (advanced)
+      --dep strings              add a dependency on another module
+  -h, --help                     help for module
+      --ibc                      add IBC functionality
+      --module-configs strings   add module configs
+      --ordering string          channel ordering of the IBC module [none|ordered|unordered] (default "none")
+      --params strings           add module parameters
+  -p, --path string              path of the app (default ".")
+      --require-registration     fail if module can't be registered
+  -y, --yes                      answers interactive yes/no questions with yes
 ```
 
 **SEE ALSO**
@@ -3484,6 +3526,46 @@ ignite scaffold packet [packetName] [field1] [field2] ... --module [moduleName]
 * [ignite scaffold](#ignite-scaffold)	 - Create a new blockchain, module, message, query, and more
 
 
+## ignite scaffold params
+
+Parameters for a custom Cosmos SDK module
+
+**Synopsis**
+
+Scaffold a new parameter for a Cosmos SDK module.
+
+A Cosmos SDK module can have parameters (or "params"). Params are values that
+can be set at the genesis of the blockchain and can be modified while the
+blockchain is running. An example of a param is "Inflation rate change" of the
+"mint" module. A params can be scaffolded into a module using the "--params" into
+the scaffold module command or using the "scaffold params" command. By default 
+params are of type "string", but you can specify a type for each param. For example:
+
+	ignite scaffold params foo baz:uint bar:bool
+
+Refer to Cosmos SDK documentation to learn more about modules, dependencies and
+params.
+
+
+```
+ignite scaffold params [param]... [flags]
+```
+
+**Options**
+
+```
+      --clear-cache     clear the build cache (advanced)
+  -h, --help            help for params
+      --module string   module to add the query into. Default: app's main module
+  -p, --path string     path of the app (default ".")
+  -y, --yes             answers interactive yes/no questions with yes
+```
+
+**SEE ALSO**
+
+* [ignite scaffold](#ignite-scaffold)	 - Create a new blockchain, module, message, query, and more
+
+
 ## ignite scaffold query
 
 Query for fetching data from a blockchain

diff --git a/ignite/cmd/scaffold.go b/ignite/cmd/scaffold.go
@@ -129,7 +129,6 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled.
 		NewScaffoldMessage(),
 		NewScaffoldQuery(),
 		NewScaffoldPacket(),
-		NewScaffoldBandchain(),
 		NewScaffoldVue(),
 		NewScaffoldReact(),
 	)

diff --git a/ignite/cmd/scaffold_band.go b/ignite/cmd/scaffold_band.go
diff --git a/ignite/services/scaffolder/component.go b/ignite/services/scaffolder/component.go
@@ -130,7 +130,6 @@ func checkForbiddenComponentName(name multiformatname.Name) error {
 	// Check with names already used from the scaffolded code
 	switch name.LowerCase {
 	case
-		"oracle",
 		"logger",
 		"keeper",
 		"query",
@@ -199,32 +198,6 @@ func checkGoReservedWord(name string) error {
 	return nil
 }
 
-// checkForbiddenOracleFieldName returns true if the name is forbidden as an oracle field name.
-//
-// Deprecated: This function is no longer maintained.
-func checkForbiddenOracleFieldName(name string) error {
-	mfName, err := multiformatname.NewName(name, multiformatname.NoNumber)
-	if err != nil {
-		return err
-	}
-
-	// Check with names already used from the scaffolded code
-	switch mfName.UpperCase {
-	case
-		"CLIENTID",
-		"ORACLESCRIPTID",
-		"SOURCECHANNEL",
-		"CALLDATA",
-		"ASKCOUNT",
-		"MINCOUNT",
-		"FEELIMIT",
-		"PREPAREGAS",
-		"EXECUTEGAS":
-		return errors.Errorf("%s is used by Ignite scaffolder", name)
-	}
-	return nil
-}
-
 // containsCustomTypes returns true if the list of fields contains at least one custom type.
 func containsCustomTypes(fields []string) bool {
 	for _, field := range fields {

diff --git a/ignite/services/scaffolder/component_test.go b/ignite/services/scaffolder/component_test.go
@@ -21,7 +21,7 @@ func TestCheckForbiddenComponentName(t *testing.T) {
 		},
 		{
 			name:        "should prevent forbidden name",
-			compName:    "oracle",
+			compName:    "genesis",
 			shouldError: true,
 		},
 	}