feat: scaffold IBC module and IBC packets

go.mod

@@ -46,10 +46,11 @@ require (
 	github.com/stretchr/testify v1.7.0
 	github.com/tendermint/spn v0.0.0-20201215081711-b9ec9286ed83
 	github.com/tendermint/tendermint v0.34.3
+	golang.org/x/crypto v0.0.0-20210218145215-b8e89b74b9df // indirect
 	golang.org/x/mod v0.4.1
 	golang.org/x/net v0.0.0-20210119194325-5f4716e94777 // indirect
 	golang.org/x/sync v0.0.0-20201207232520-09787c993a3a
-	golang.org/x/sys v0.0.0-20210218085108-9555bcde0c6a // indirect
+	golang.org/x/sys v0.0.0-20210218155724-8ebf48af031b // indirect
 	golang.org/x/term v0.0.0-20201210144234-2321bbc49cbf // indirect
 	google.golang.org/grpc v1.35.0
 )

integration/cmd_ibc_test.go

@@ -0,0 +1,131 @@
+// +build !relayer
+
+package integration_test
+
+import (
+	"testing"
+
+	"github.com/tendermint/starport/starport/pkg/cmdrunner/step"
+)
+
+func TestCreateModuleWithIBC(t *testing.T) {
+
+	var (
+		env  = newEnv(t)
+		path = env.Scaffold("ibcblog", Stargate)
+	)
+
+	env.Must(env.Exec("create an IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "foo", "--ibc"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create a type in an IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "type", "user", "email", "--module", "foo"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create an IBC module with an ordered channel",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "--ibc", "orderedfoo", "--ordering", "ordered"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create an IBC module with an unordered channel",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "--ibc", "unorderedfoo", "--ordering", "unordered"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create an non IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "foobar"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.EnsureAppIsSteady(path)
+}
+
+func TestCreateIBCPacket(t *testing.T) {
+
+	var (
+		env  = newEnv(t)
+		path = env.Scaffold("ibcblog2", Stargate)
+	)
+
+	env.Must(env.Exec("create an IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "foo", "--ibc"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create a packet",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "bar", "text", "--module", "foo"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("should prevent creating a packet with no module specified",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "bar", "text"),
+			step.Workdir(path),
+		)),
+		ExecShouldError(),
+	))
+
+	env.Must(env.Exec("should prevent creating a packet in a non existent module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "bar", "text", "--module", "nomodule"),
+			step.Workdir(path),
+		)),
+		ExecShouldError(),
+	))
+
+	env.Must(env.Exec("should prevent creating an existing packet",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "bar", "post", "--module", "foo"),
+			step.Workdir(path),
+		)),
+		ExecShouldError(),
+	))
+
+	env.Must(env.Exec("create a packet with custom type fields",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "ticket", "num:int", "victory:bool", "--module", "foo"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create a packet with no field",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "empty", "--module", "foo"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("create a non-IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "module", "create", "bar"),
+			step.Workdir(path),
+		)),
+	))
+
+	env.Must(env.Exec("should prevent creating a packet in a non IBC module",
+		step.NewSteps(step.New(
+			step.Exec("starport", "packet", "foo", "text", "--module", "bar"),
+			step.Workdir(path),
+		)),
+		ExecShouldError(),
+	))
+
+	env.EnsureAppIsSteady(path)
+}

integration/cmd_type_test.go

@@ -204,7 +204,7 @@ func TestCreateTypeInCustomModule(t *testing.T) {
 func TestCreateTypeInCustomModuleWithStargate(t *testing.T) {
 	var (
 		env  = newEnv(t)
-		path = env.Scaffold("blog", Launchpad)
+		path = env.Scaffold("blog", Stargate)
 	)
 
 	env.Must(env.Exec("create a module",
@@ -235,7 +235,7 @@ func TestCreateTypeInCustomModuleWithStargate(t *testing.T) {
 		)),
 	))
 
-	env.Must(env.Exec("should prevent creating a type in a non existant module",
+	env.Must(env.Exec("should prevent creating a type in a non existent module",
 		step.NewSteps(step.New(
 			step.Exec("starport", "type", "user", "email", "--module", "idontexist"),
 			step.Workdir(path),

starport/interface/cli/starport/cmd/cmd.go

@@ -41,6 +41,7 @@ func New() *cobra.Command {
 	c.AddCommand(NewRelayer())
 	c.AddCommand(NewVersion())
 	c.AddCommand(NewNetwork())
+	c.AddCommand(NewIBCPacket())
 	c.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 	return c
 }

starport/interface/cli/starport/cmd/module-create.go

@@ -5,6 +5,35 @@ import (
 
 	"github.com/spf13/cobra"
 	"github.com/tendermint/starport/starport/services/scaffolder"
+	"github.com/tendermint/starport/starport/templates/module"
+)
+
+const (
+	flagIBC         = "ibc"
+	flagIBCOrdering = "ordering"
+)
+
+var ibcRouterPlaceholderInstruction = fmt.Sprintf(`
+💬 To enable scaffolding of IBC modules, remove these lines from app/app.go:
+
+%s
+
+💬 Then, find the following line:
+
+%s
+
+💬 Finally, add this block of code below:
+
+%s
+`,
+	infoColor(`ibcRouter := porttypes.NewRouter()
+ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule)
+app.IBCKeeper.SetRouter(ibcRouter)`),
+	infoColor(module.PlaceholderSgAppKeeperDefinition),
+	infoColor(`ibcRouter := porttypes.NewRouter()
+ibcRouter.AddRoute(ibctransfertypes.ModuleName, transferModule)
+`+module.PlaceholderIBCAppRouter+`
+app.IBCKeeper.SetRouter(ibcRouter)`),
 )
 
 // NewModuleCreate creates a new module create command to scaffold an
@@ -17,13 +46,40 @@ func NewModuleCreate() *cobra.Command {
 		Args:  cobra.MinimumNArgs(1),
 		RunE:  createModuleHandler,
 	}
+	c.Flags().Bool(flagIBC, false, "scaffold an IBC module")
+	c.Flags().String(flagIBCOrdering, "none", "channel ordering of the IBC module [none|ordered|unordered]")
 	return c
 }
 
 func createModuleHandler(cmd *cobra.Command, args []string) error {
+	var options []scaffolder.ModuleCreationOption
+
 	name := args[0]
+
+	ibcModule, err := cmd.Flags().GetBool(flagIBC)
+	if err != nil {
+		return err
+	}
+
+	ibcOrdering, err := cmd.Flags().GetString(flagIBCOrdering)
+	if err != nil {
+		return err
+	}
+
+	// Check if the module must be an IBC module
+	if ibcModule {
+		options = append(options, scaffolder.WithIBCChannelOrdering(ibcOrdering), scaffolder.WithIBC())
+	}
+
 	sc := scaffolder.New(appPath)
-	if err := sc.CreateModule(name); err != nil {
+	if err := sc.CreateModule(name, options...); err != nil {
+
+		// If this is an old scaffolded application that doesn't contain the necessary placeholder
+		// We give instruction to the user to modify the application
+		if err == scaffolder.ErrNoIBCRouterPlaceholder {
+			fmt.Print(ibcRouterPlaceholderInstruction)
+		}
+
 		return err
 	}
 	fmt.Printf("\n🎉 Module created %s.\n\n", name)

starport/interface/cli/starport/cmd/packet.go

@@ -0,0 +1,43 @@
+package starportcmd
+
+import (
+	"errors"
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"github.com/tendermint/starport/starport/services/scaffolder"
+)
+
+// NewIBCPacket creates a new packet in the module
+func NewIBCPacket() *cobra.Command {
+	c := &cobra.Command{
+		Use:   "packet [packetName] [field1] [field2] ... --module [module_name]",
+		Short: "Creates a new interpretable IBC packet.",
+		Long:  "Use starport ibc packet to create a new packet in your IBC module.",
+		Args:  cobra.MinimumNArgs(1),
+		RunE:  createPacketHandler,
+	}
+
+	c.Flags().String(moduleFlag, "", "IBC Module to add the packet into")
+
+	return c
+}
+
+func createPacketHandler(cmd *cobra.Command, args []string) error {
+	packet := args[0]
+	fields := args[1:]
+	module, err := cmd.Flags().GetString(moduleFlag)
+	if err != nil {
+		return err
+	}
+	if module == "" {
+		return errors.New("please specify a module to create the packet into: --module <module_name>")
+	}
+
+	sc := scaffolder.New(appPath)
+	if err := sc.AddPacket(module, packet, fields...); err != nil {
+		return err
+	}
+	fmt.Printf("\n🎉 Created a packet `%[1]v`.\n\n", args[0])
+	return nil
+}