Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
98 lines
2.5 KiB
Go
98 lines
2.5 KiB
Go
package ignitecmd
|
|
|
|
import (
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/ignite/cli/v29/ignite/pkg/cliui"
|
|
"github.com/ignite/cli/v29/ignite/pkg/xgenny"
|
|
"github.com/ignite/cli/v29/ignite/services/scaffolder"
|
|
)
|
|
|
|
// NewScaffoldParams returns the command to scaffold a Cosmos SDK parameters into a module.
|
|
func NewScaffoldParams() *cobra.Command {
|
|
c := &cobra.Command{
|
|
Use: "params [param]...",
|
|
Short: "Parameters for a custom Cosmos SDK module",
|
|
Long: `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.
|
|
`,
|
|
Args: cobra.MinimumNArgs(1),
|
|
PreRunE: migrationPreRunHandler,
|
|
RunE: scaffoldParamsHandler,
|
|
}
|
|
|
|
flagSetPath(c)
|
|
flagSetClearCache(c)
|
|
|
|
c.Flags().AddFlagSet(flagSetYes())
|
|
|
|
c.Flags().String(flagModule, "", "module to add the query into. Default: app's main module")
|
|
|
|
return c
|
|
}
|
|
|
|
func scaffoldParamsHandler(cmd *cobra.Command, args []string) error {
|
|
var (
|
|
params = args[0:]
|
|
appPath = flagGetPath(cmd)
|
|
moduleName = flagGetModule(cmd)
|
|
)
|
|
|
|
session := cliui.New(
|
|
cliui.StartSpinnerWithText(statusScaffolding),
|
|
cliui.WithoutUserInteraction(getYes(cmd)),
|
|
)
|
|
defer session.End()
|
|
|
|
cfg, _, err := getChainConfig(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
cacheStorage, err := newCache(cmd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
sc, err := scaffolder.New(cmd.Context(), appPath, cfg.Build.Proto.Path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
err = sc.CreateParams(moduleName, params...)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
sm, err := sc.ApplyModifications(xgenny.ApplyPreRun(scaffolder.AskOverwriteFiles(session)))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if err := sc.PostScaffold(cmd.Context(), cacheStorage, false); err != nil {
|
|
return err
|
|
}
|
|
|
|
modificationsStr, err := sm.String()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
session.Println(modificationsStr)
|
|
session.Printf("\n🎉 New parameters added to the module:\n\n- %s\n\n", strings.Join(params, "\n- "))
|
|
|
|
return nil
|
|
}
|