Merge branch 'develop' into ilgooz/migration-refactor

Author: jeronimoalbi

changelog.md

@@ -2,8 +2,12 @@
 
 ## Unreleased
 
+- Updated `nodetime`: `ts-proto` to `v1.126.0`, `protobufjs` to `v7.1.1`, `swagger-typescript-api` to `v9.2.0`
+- Switched codegen client to use `axios` instead of `fetch`
+
 ### Fixes
 
+- Change vuex generation to use a default TS client path.
 - Fix cli action org in templates.
 - Seal the capability keeper in the `app.go` template
 

docs/docs/clients/01-typescript.md

@@ -35,6 +35,37 @@ ignite generate ts-client
 
 To prevent regenerating the client, remove the `client:typescript` property from `config.yml`.	
 
+## Setup
+
+The best way to get started building with the TypeScript client is by using a [Vite](https://vitejs.dev/) boilerplate. Vite provides boilerplates for vanilla TS projects as well as react, vue, lit, svelte and preact frameworks.
+You can find additional information at the [Vite Getting Started guide](https://vitejs.dev/guide/).
+
+You will also need to polyfill the client's dependencies. The following is an example of setting up a vanilla TS project with the necessary polyfills.
+
+```bash
+npm create vite@latest my-frontend-app -- --template vanilla-ts
+npm install --save-dev buffer @rollup/plugin-node-resolve
+```
+
+You must then create the necessary `vite.config.ts` file.
+
+```typescript
+import { nodeResolve } from '@rollup/plugin-node-resolve'
+import { Buffer } from 'buffer'
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  define: {
+    global: {
+      Buffer: Buffer
+    }
+  },
+  plugins: [nodeResolve()],
+})
+```
+
+You are then ready to use the generated client code inside this project directly or by publishing the client and installing it as any other npm package.
+
 ## Usage
 
 The code generated in `ts-client` comes with a `package.json` file ready to publish which you can modify to suit your needs.
@@ -178,4 +209,4 @@ const tx_result = await client.sendMsgSend(
 		memo
 	}
 );
-```
+```

go.mod

@@ -50,7 +50,7 @@ require (
 	github.com/stretchr/testify v1.8.0
 	github.com/takuoki/gocase v1.0.0
 	github.com/tendermint/flutter/v2 v2.0.4
-	github.com/tendermint/spn v0.2.1-0.20220907161743-aab4d3df1f2b
+	github.com/tendermint/spn v0.2.1-0.20220921200247-8bafad876bdd
 	github.com/tendermint/tendermint v0.34.21
 	github.com/tendermint/tm-db v0.6.7
 	github.com/vektra/mockery/v2 v2.14.0

go.sum

@@ -1713,6 +1713,10 @@ github.com/tendermint/go-amino v0.16.0 h1:GyhmgQKvqF82e2oZeuMSp9JTN0N09emoSZlb2l
 github.com/tendermint/go-amino v0.16.0/go.mod h1:TQU0M1i/ImAo+tYpZi73AU3V/dKeCoMC9Sphe2ZwGME=
 github.com/tendermint/spn v0.2.1-0.20220907161743-aab4d3df1f2b h1:QqEBIiWRC+uPM8FCXuxcvzTS6isR/lycQJDRHgsmg2c=
 github.com/tendermint/spn v0.2.1-0.20220907161743-aab4d3df1f2b/go.mod h1:CMzd3oBkjR9I1h/BEaU1K2V78XqARFWGjxPP9Xy/FIE=
+github.com/tendermint/spn v0.2.1-0.20220921185243-142531a50099 h1:vXANQeYDrMkzAKz1EP7GSccY6KuLniZ+2pn9kHuzqpw=
+github.com/tendermint/spn v0.2.1-0.20220921185243-142531a50099/go.mod h1:p4b3ZAVTgLGxIpXZsXVeQuOxVUk1/kcwBIIlOMTZtsE=
+github.com/tendermint/spn v0.2.1-0.20220921200247-8bafad876bdd h1:Sp1MgPWq73/a8WVJvE/B6/xOt7cXEzLFT/+KBtIiuk8=
+github.com/tendermint/spn v0.2.1-0.20220921200247-8bafad876bdd/go.mod h1:p4b3ZAVTgLGxIpXZsXVeQuOxVUk1/kcwBIIlOMTZtsE=
 github.com/tendermint/tendermint v0.34.21 h1:UiGGnBFHVrZhoQVQ7EfwSOLuCtarqCSsRf8VrklqB7s=
 github.com/tendermint/tendermint v0.34.21/go.mod h1:XDvfg6U7grcFTDx7VkzxnhazQ/bspGJAn4DZ6DcLLjQ=
 github.com/tendermint/tm-db v0.6.7 h1:fE00Cbl0jayAoqlExN6oyQJ7fR/ZtoVOmvPJ//+shu8=

ignite/chainconfig/chainconfig.go

@@ -1,6 +1,11 @@
 package chainconfig
 
 import (
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
 	"github.com/ignite/cli/ignite/chainconfig/config"
 	v0 "github.com/ignite/cli/ignite/chainconfig/v0"
 	v1 "github.com/ignite/cli/ignite/chainconfig/v1"
@@ -14,6 +19,10 @@ var (
 	// ConfigFileNames is a list of recognized names as for Ignite's config file.
 	ConfigFileNames = []string{"config.yml", "config.yaml"}
 
+	// DefaultTSClientPath defines the default relative path to use when generating the TS client.
+	// The path is relative to the app's directory.
+	DefaultTSClientPath = "ts-client"
+
 	// LatestVersion defines the latest version of the config.
 	LatestVersion config.Version = 1
 
@@ -31,3 +40,50 @@ type Config = v1.Config
 func DefaultConfig() *Config {
 	return v1.DefaultConfig()
 }
+
+// FaucetHost returns the faucet host to use.
+func FaucetHost(cfg *Config) string {
+	// We keep supporting Port option for backward compatibility
+	// TODO: drop this option in the future
+	host := cfg.Faucet.Host
+	if cfg.Faucet.Port != 0 {
+		host = fmt.Sprintf(":%d", cfg.Faucet.Port)
+	}
+
+	return host
+}
+
+// TSClientPath returns the relative path to the Typescript client directory.
+// Path is relative to the app's directory.
+func TSClientPath(conf *Config) string {
+	if path := strings.TrimSpace(conf.Client.Typescript.Path); path != "" {
+		return filepath.Clean(path)
+	}
+
+	return DefaultTSClientPath
+}
+
+// CreateConfigDir creates config directory if it is not created yet.
+func CreateConfigDir() error {
+	path, err := ConfigDirPath()
+	if err != nil {
+		return err
+	}
+
+	return os.MkdirAll(path, 0o755)
+}
+
+// LocateDefault locates the default path for the config file.
+// Returns ErrConfigNotFound when no config file found.
+func LocateDefault(root string) (path string, err error) {
+	for _, name := range ConfigFileNames {
+		path = filepath.Join(root, name)
+		if _, err := os.Stat(path); err == nil {
+			return path, nil
+		} else if !os.IsNotExist(err) {
+			return "", err
+		}
+	}
+
+	return "", ErrConfigNotFound
+}

ignite/chainconfig/parser.go

@@ -2,10 +2,8 @@ package chainconfig
 
 import (
 	"bytes"
-	"fmt"
 	"io"
 	"os"
-	"path/filepath"
 
 	"gopkg.in/yaml.v2"
 
@@ -69,43 +67,6 @@ func ReadConfigVersion(configFile io.Reader) (config.Version, error) {
 	return c.Version, err
 }
 
-// LocateDefault locates the default path for the config file.
-// Returns ErrConfigNotFound when no config file found.
-func LocateDefault(root string) (path string, err error) {
-	for _, name := range ConfigFileNames {
-		path = filepath.Join(root, name)
-		if _, err := os.Stat(path); err == nil {
-			return path, nil
-		} else if !os.IsNotExist(err) {
-			return "", err
-		}
-	}
-
-	return "", ErrConfigNotFound
-}
-
-// FaucetHost returns the faucet host to use.
-func FaucetHost(cfg *Config) string {
-	// We keep supporting Port option for backward compatibility
-	// TODO: drop this option in the future
-	host := cfg.Faucet.Host
-	if cfg.Faucet.Port != 0 {
-		host = fmt.Sprintf(":%d", cfg.Faucet.Port)
-	}
-
-	return host
-}
-
-// CreateConfigDir creates config directory if it is not created yet.
-func CreateConfigDir() error {
-	path, err := ConfigDirPath()
-	if err != nil {
-		return err
-	}
-
-	return os.MkdirAll(path, 0755)
-}
-
 func decodeConfig(r io.Reader, version config.Version) (config.Converter, error) {
 	c, ok := Versions[version]
 	if !ok {

ignite/cmd/generate_typescript_client.go

@@ -3,6 +3,7 @@ package ignitecmd
 import (
 	"github.com/spf13/cobra"
 
+	"github.com/ignite/cli/ignite/chainconfig"
 	"github.com/ignite/cli/ignite/pkg/cliui"
 	"github.com/ignite/cli/ignite/services/chain"
 )
@@ -13,7 +14,10 @@ func NewGenerateTSClient() *cobra.Command {
 		Short: "Generate Typescript client for your chain's frontend",
 		RunE:  generateTSClientHandler,
 	}
+
 	c.Flags().AddFlagSet(flagSetProto3rdParty(""))
+	c.Flags().StringP(flagOutput, "o", chainconfig.DefaultTSClientPath, "typescript client output path")
+
 	return c
 }
 
@@ -33,7 +37,13 @@ func generateTSClientHandler(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateTSClient()); err != nil {
+	output, err := cmd.Flags().GetString(flagOutput)
+	if err != nil {
+		return err
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateTSClient(output))
+	if err != nil {
 		return err
 	}
 

ignite/cmd/network_chain_list.go

@@ -1,8 +1,11 @@
 package ignitecmd
 
 import (
+	"errors"
 	"fmt"
+	"time"
 
+	"github.com/cosmos/cosmos-sdk/types/query"
 	"github.com/spf13/cobra"
 
 	"github.com/ignite/cli/ignite/pkg/cliui"
@@ -11,7 +14,18 @@ import (
 	"github.com/ignite/cli/ignite/services/network/networktypes"
 )
 
-var LaunchSummaryHeader = []string{"launch ID", "chain ID", "source", "campaign ID", "network", "reward"}
+var LaunchSummaryHeader = []string{
+	"launch ID",
+	"chain ID",
+	"source",
+	"phase",
+}
+
+var LaunchSummaryAdvancedHeader = []string{
+	"campaign ID",
+	"network",
+	"reward",
+}
 
 // NewNetworkChainList returns a new command to list all published chains on Ignite
 func NewNetworkChainList() *cobra.Command {
@@ -21,13 +35,27 @@ func NewNetworkChainList() *cobra.Command {
 		Args:  cobra.NoArgs,
 		RunE:  networkChainListHandler,
 	}
+	c.Flags().Bool(flagAdvanced, false, "Show advanced information about the chains")
+	c.Flags().Uint64(flagLimit, 100, "Limit of results per page")
+	c.Flags().Uint64(flagPage, 1, "Page for chain list result")
+
 	return c
 }
 
 func networkChainListHandler(cmd *cobra.Command, _ []string) error {
+	var (
+		advanced, _ = cmd.Flags().GetBool(flagAdvanced)
+		limit, _    = cmd.Flags().GetUint64(flagLimit)
+		page, _     = cmd.Flags().GetUint64(flagPage)
+	)
+
 	session := cliui.New()
 	defer session.Cleanup()
 
+	if page == 0 {
+		return errors.New("invalid page value")
+	}
+
 	nb, err := newNetworkBuilder(cmd, CollectEvents(session.EventBus()))
 	if err != nil {
 		return err
@@ -36,40 +64,70 @@ func networkChainListHandler(cmd *cobra.Command, _ []string) error {
 	if err != nil {
 		return err
 	}
-	chainLaunches, err := n.ChainLaunchesWithReward(cmd.Context())
+	chainLaunches, err := n.ChainLaunchesWithReward(cmd.Context(), &query.PageRequest{
+		Offset: limit * (page - 1),
+		Limit:  limit,
+	})
 	if err != nil {
 		return err
 	}
 
 	session.StopSpinner()
 
-	return renderLaunchSummaries(chainLaunches, session)
+	return renderLaunchSummaries(chainLaunches, session, advanced)
 }
 
 // renderLaunchSummaries writes into the provided out, the list of summarized launches
-func renderLaunchSummaries(chainLaunches []networktypes.ChainLaunch, session cliui.Session) error {
+func renderLaunchSummaries(chainLaunches []networktypes.ChainLaunch, session cliui.Session, advanced bool) error {
+	header := LaunchSummaryHeader
+	if advanced {
+		// advanced information show the campaign ID, type of network and rewards for incentivized testnet
+		header = append(header, LaunchSummaryAdvancedHeader...)
+	}
+
 	var launchEntries [][]string
 
+	// iterate and fetch summary for chains
 	for _, c := range chainLaunches {
-		campaign := "no campaign"
-		if c.CampaignID > 0 {
-			campaign = fmt.Sprintf("%d", c.CampaignID)
-		}
 
-		reward := entrywriter.None
-		if len(c.Reward) > 0 {
-			reward = c.Reward
+		// get the current phase of the chain
+		var phase string
+		switch {
+		case !c.LaunchTriggered:
+			phase = "coordinating"
+		case time.Now().Before(c.LaunchTime):
+			phase = "launching"
+		default:
+			phase = "launched"
 		}
 
-		launchEntries = append(launchEntries, []string{
+		entry := []string{
 			fmt.Sprintf("%d", c.ID),
 			c.ChainID,
 			c.SourceURL,
-			campaign,
-			c.Network.String(),
-			reward,
-		})
+			phase,
+		}
+
+		// add advanced information
+		if advanced {
+			campaign := "no campaign"
+			if c.CampaignID > 0 {
+				campaign = fmt.Sprintf("%d", c.CampaignID)
+			}
+
+			reward := entrywriter.None
+			if len(c.Reward) > 0 {
+				reward = c.Reward
+			}
+
+			entry = append(entry,
+				campaign,
+				c.Network.String(),
+				reward)
+		}
+
+		launchEntries = append(launchEntries, entry)
 	}
 
-	return session.PrintTable(LaunchSummaryHeader, launchEntries...)
+	return session.PrintTable(header, launchEntries...)
 }

ignite/pkg/cosmosgen/generate_typescript.go

@@ -164,7 +164,7 @@ func (g *tsGenerator) generateModuleTemplate(
 		m.Pkg.Path,
 		includePaths,
 		tsOut,
-		protoc.Plugin(tsprotoPluginPath, "--ts_proto_opt=snakeToCamel=true"),
+		protoc.Plugin(tsprotoPluginPath, "--ts_proto_opt=snakeToCamel=true --ts_proto_opt=esModuleInterop=true "),
 		protoc.Env("NODE_OPTIONS="), // unset nodejs options to avoid unexpected issues with vercel "pkg"
 		protoc.WithCommand(protocCmd),
 	)