create band cli command

Author: Pantani

starport/cmd/scaffold.go

@@ -27,6 +27,7 @@ func NewScaffold() *cobra.Command {
 		Args:    cobra.ExactArgs(1),
 	}
 
+	c.AddCommand(NewScaffoldBandchain())
 	c.AddCommand(NewScaffoldChain())
 	c.AddCommand(NewScaffoldModule())
 	c.AddCommand(NewScaffoldList())

starport/cmd/scaffold_band.go

@@ -0,0 +1,55 @@
+package starportcmd
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/tendermint/starport/starport/pkg/clispinner"
+	"github.com/tendermint/starport/starport/pkg/placeholder"
+	"github.com/tendermint/starport/starport/services/scaffolder"
+)
+
+// NewScaffoldBandchain creates a new Bandchain oracle in the module
+func NewScaffoldBandchain() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "band [oracleName] ... --module [moduleName]",
+		Short: "Scaffold an IBC Bandchain oracle",
+		Long:  "Scaffold an IBC Bandchain oracle in a specific IBC-enabled Cosmos SDK module",
+		Args:  cobra.MinimumNArgs(1),
+		RunE:  createBandchainHandler,
+	}
+
+	c.Flags().String(flagModule, "", "IBC Module to add the packet into")
+
+	return c
+}
+
+func createBandchainHandler(cmd *cobra.Command, args []string) error {
+	s := clispinner.New().SetText("Scaffolding...")
+	defer s.Stop()
+
+	oracle := args[0]
+	module, err := cmd.Flags().GetString(flagModule)
+	if err != nil {
+		return err
+	}
+	if module == "" {
+		return errors.New("please specify a module to create the packet into: --module <module_name>")
+	}
+
+	sc, err := scaffolder.New(appPath)
+	if err != nil {
+		return err
+	}
+	sm, err := sc.AddOracle(placeholder.New(), module, oracle)
+	if err != nil {
+		return err
+	}
+
+	s.Stop()
+
+	fmt.Println(sourceModificationToString(sm))
+	fmt.Printf("\n🎉 Created a packet `%[1]v`.\n\n", args[0])
+	return nil
+}

starport/cmd/scaffold_module.go

@@ -18,7 +18,6 @@ import (
 const (
 	flagDep                 = "dep"
 	flagIBC                 = "ibc"
-	flagOracle              = "oracle"
 	flagIBCOrdering         = "ordering"
 	flagRequireRegistration = "require-registration"
 )
@@ -34,7 +33,6 @@ func NewScaffoldModule() *cobra.Command {
 	}
 	c.Flags().StringSlice(flagDep, []string{}, "module dependencies (e.g. --dep account,bank)")
 	c.Flags().Bool(flagIBC, false, "scaffold an IBC module")
-	c.Flags().Bool(flagOracle, false, "scaffold a Bandchain oracle into the module to send queries to the oracle chain")
 	c.Flags().String(flagIBCOrdering, "none", "channel ordering of the IBC module [none|ordered|unordered]")
 	c.Flags().Bool(flagRequireRegistration, false, "if true command will fail if module can't be registered")
 	return c
@@ -62,16 +60,6 @@ func scaffoldModuleHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	// Check if the module must be a Bandchain oracle module
-	oracle, err := cmd.Flags().GetBool(flagOracle)
-	if err != nil {
-		return err
-	}
-	if oracle {
-		ibcModule = true
-		options = append(options, scaffolder.WithOracleIntegration())
-	}
-
 	// Check if the module must be an IBC module
 	if ibcModule {
 		options = append(options, scaffolder.WithIBCChannelOrdering(ibcOrdering), scaffolder.WithIBC())

starport/services/scaffolder/module.go

@@ -35,12 +35,9 @@ const (
 
 // moduleCreationOptions holds options for creating a new module
 type moduleCreationOptions struct {
-	// ibc if ibc is needed
+	// chainID is the chain's id.
 	ibc bool
 
-	// oracle if oracle integration is needed
-	oracle bool
-
 	// homePath of the chain's config dir.
 	ibcChannelOrdering string
 
@@ -72,13 +69,6 @@ func WithIBCChannelOrdering(ordering string) ModuleCreationOption {
 	}
 }
 
-// WithOracleIntegration configures the Bandchain oracle integration
-func WithOracleIntegration() ModuleCreationOption {
-	return func(m *moduleCreationOptions) {
-		m.oracle = true
-	}
-}
-
 // WithDependencies specifies the name of the modules that the module depends on
 func WithDependencies(dependencies []modulecreate.Dependency) ModuleCreationOption {
 	return func(m *moduleCreationOptions) {
@@ -133,7 +123,6 @@ func (s *Scaffolder) CreateModule(
 		AppName:      path.Package,
 		OwnerName:    owner(path.RawPath),
 		IsIBC:        creationOpts.ibc,
-		IsOracle:     creationOpts.oracle,
 		IBCOrdering:  creationOpts.ibcChannelOrdering,
 		Dependencies: creationOpts.dependencies,
 	}
@@ -147,16 +136,7 @@ func (s *Scaffolder) CreateModule(
 
 	// Scaffold IBC module
 	if opts.IsIBC {
-		g, err := modulecreate.NewIBC(tracer, opts)
-		if err != nil {
-			return sm, err
-		}
-		gens = append(gens, g)
-	}
-
-	// Scaffold Oracle
-	if opts.IsOracle {
-		g, err := modulecreate.NewOracle(tracer, opts)
+		g, err = modulecreate.NewIBC(tracer, opts)
 		if err != nil {
 			return sm, err
 		}

starport/services/scaffolder/oracle.go

@@ -0,0 +1,73 @@
+package scaffolder
+
+import (
+	"fmt"
+	"github.com/gobuffalo/genny"
+	"github.com/tendermint/starport/starport/pkg/gomodulepath"
+	"github.com/tendermint/starport/starport/pkg/multiformatname"
+	"github.com/tendermint/starport/starport/pkg/placeholder"
+	"github.com/tendermint/starport/starport/pkg/xgenny"
+	"github.com/tendermint/starport/starport/templates/ibc"
+	"os"
+)
+
+// AddOracle adds a new Bandchain oracle integration.
+func (s *Scaffolder) AddOracle(
+	tracer *placeholder.Tracer,
+	moduleName,
+	oracleName string,
+) (sm xgenny.SourceModification, err error) {
+	path, err := gomodulepath.ParseAt(s.path)
+	if err != nil {
+		return sm, err
+	}
+
+	mfName, err := multiformatname.NewName(moduleName, multiformatname.NoNumber)
+	if err != nil {
+		return sm, err
+	}
+	moduleName = mfName.Lowercase
+
+	name, err := multiformatname.NewName(oracleName)
+	if err != nil {
+		return sm, err
+	}
+
+	if err := checkComponentValidity(s.path, moduleName, name); err != nil {
+		return sm, err
+	}
+
+	// Module must implement IBC
+	ok, err := isIBCModule(s.path, moduleName)
+	if err != nil {
+		return sm, err
+	}
+	if !ok {
+		return sm, fmt.Errorf("the module %s doesn't implement IBC module interface", moduleName)
+	}
+
+	// Generate the packet
+	var (
+		g    *genny.Generator
+		opts = &ibc.OracleOptions{
+			AppName:    path.Package,
+			ModulePath: path.RawPath,
+			ModuleName: moduleName,
+			OwnerName:  owner(path.RawPath),
+			OracleName: name,
+		}
+	)
+	g, err = ibc.NewOracle(tracer, opts)
+	if err != nil {
+		return sm, err
+	}
+	sm, err = xgenny.RunWithValidation(tracer, g)
+	if err != nil {
+		return sm, err
+	}
+	pwd, err := os.Getwd()
+	if err != nil {
+		return sm, err
+	}
+	return sm, s.finish(pwd, path.RawPath)
+}