feat(cosmogen): implement 3rd party generation root template

changelog.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+## [`v29.1.0`](https://github.com/ignite/cli/releases/tag/v29.1.0)
+
 ### Features
 
 - [#4728](https://github.com/ignite/cli/pull/4728) Ask before overwriting a `xgenny` file.
@@ -14,7 +16,7 @@
 
 ### Fixes
 
-- [#4691](https://github.com/ignite/cli/pull/4691), [#4706](https://github.com/ignite/cli/pull/4706), [#4725](https://github.com/ignite/cli/pull/4725) Fix ts-client query template and solely Go template for `ts-client` generation.
+- [#4691](https://github.com/ignite/cli/pull/4691), [#4706](https://github.com/ignite/cli/pull/4706), [#4725](https://github.com/ignite/cli/pull/4725), [#4737](https://github.com/ignite/cli/pull/4737) Fix ts-client query template and solely Go template for `ts-client` generation.
 
 ## [`v29.0.0`](https://github.com/ignite/cli/releases/tag/v29.0.0)
 

ignite/pkg/cosmosbuf/buf.go

@@ -76,6 +76,7 @@ type (
 		fileByFile     bool
 		includeImports bool
 		includeWKT     bool
+		moduleName     string
 	}
 
 	// GenOption configures code generation.
@@ -89,6 +90,7 @@ func newGenOptions() genOptions {
 		fileByFile:     false,
 		includeWKT:     false,
 		includeImports: false,
+		moduleName:     "",
 	}
 }
 
@@ -124,6 +126,13 @@ func IncludeWKT() GenOption {
 	}
 }
 
+// WithModuleName sets the module name to filter protos for.
+func WithModuleName(value string) GenOption {
+	return func(o *genOptions) {
+		o.moduleName = value
+	}
+}
+
 // FileByFile runs the generate command for each proto file.
 func FileByFile() GenOption {
 	return func(o *genOptions) {
@@ -244,9 +253,13 @@ func (b Buf) Generate(
 	for _, apply := range options {
 		apply(&opts)
 	}
-
+	modulePath := protoPath
+	if opts.moduleName != "" {
+		path := append([]string{protoPath}, strings.Split(opts.moduleName, ".")...)
+		modulePath = filepath.Join(path...)
+	}
 	// find all proto files into the path.
-	foundFiles, err := xos.FindFiles(protoPath, xos.WithExtension(xos.ProtoFile))
+	foundFiles, err := xos.FindFiles(modulePath, xos.WithExtension(xos.ProtoFile))
 	if err != nil || len(foundFiles) == 0 {
 		return err
 	}

ignite/pkg/cosmosgen/generate_typescript.go

@@ -59,6 +59,11 @@ func (g *generator) generateTS(ctx context.Context) error {
 		return err
 	}
 
+	// add third party modules to for the root template.
+	for _, modules := range g.thirdModules {
+		data.Modules = append(data.Modules, modules...)
+	}
+
 	return tsg.generateRootTemplates(data)
 }
 
@@ -132,6 +137,7 @@ func (g *tsGenerator) generateModuleTemplate(
 	// All "cosmossdk.io" module packages must use SDK's
 	// proto path which is where the proto files are stored.
 	protoPath := filepath.Join(appPath, g.g.protoDir) // use module app path
+
 	if module.IsCosmosSDKPackage(appPath) {
 		protoPath = filepath.Join(g.g.sdkDir, "proto")
 	}
@@ -143,7 +149,7 @@ func (g *tsGenerator) generateModuleTemplate(
 		typesOut,
 		g.g.tsTemplate(),
 		cosmosbuf.IncludeWKT(),
-		// TODO: we should exclude folders that are irrelevant for the module.
+		cosmosbuf.WithModuleName(m.Pkg.Name),
 	); err != nil {
 		return err
 	}

ignite/pkg/cosmosgen/generate_typescript_test.go

@@ -1,8 +1,10 @@
 package cosmosgen
 
 import (
+	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/ettle/strcase"
@@ -38,16 +40,23 @@ func TestGenerateTypeScript(t *testing.T) {
 		buf:          buf,
 		appModules:   m,
 		opts: &generateOptions{
-			useCache: false,
+			tsClientRootPath: tsClientDir,
+			useCache:         false,
 			jsOut: func(m module.Module) string {
-				return filepath.Join(tsClientDir, strcase.ToKebab(m.Name))
+				return filepath.Join(tsClientDir, fmt.Sprintf("%s.%s.%s", "ignite", "planet", strcase.ToKebab(m.Name)))
 			},
 		},
 	})
 
 	err = g.generateModuleTemplate(t.Context(), appDir, m[0])
 	require.NoError(err, "failed to generate TypeScript files")
 
+	err = g.generateRootTemplates(generatePayload{
+		Modules:   m,
+		PackageNS: strings.ReplaceAll(appDir, "/", "-"),
+	})
+	require.NoError(err)
+
 	// compare all generated files to golden files
 	goldenDir := filepath.Join(testdataDir, "expected_files", "ts-client")
 	_ = filepath.Walk(goldenDir, func(path string, info os.FileInfo, err error) error {

ignite/pkg/cosmosgen/testdata/expected_files/ts-client/client.ts

@@ -0,0 +1,164 @@
+/// <reference path="./types.d.ts" />
+import {
+  GeneratedType,
+  OfflineSigner,
+  EncodeObject,
+  Registry,
+} from "@cosmjs/proto-signing";
+import { SigningStargateClient, StdFee } from "@cosmjs/stargate";
+import { Env } from "./env";
+import { UnionToIntersection, Return, Constructor } from "./helpers";
+import { IgntModule } from "./modules";
+import { EventEmitter } from "events";
+import { ChainInfo } from "@keplr-wallet/types";
+
+const defaultFee = {
+  amount: [],
+  gas: "200000",
+};
+
+export class IgniteClient extends EventEmitter {
+	static plugins: IgntModule[] = [];
+  env: Env;
+  signer?: OfflineSigner;
+  registry: Array<[string, GeneratedType]> = [];
+  static plugin<T extends IgntModule | IgntModule[]>(plugin: T) {
+    const currentPlugins = this.plugins;
+
+    class AugmentedClient extends this {
+      static plugins = currentPlugins.concat(plugin);
+    }
+
+    if (Array.isArray(plugin)) {
+      type Extension = UnionToIntersection<Return<T>['module']>
+      return AugmentedClient as typeof IgniteClient & Constructor<Extension>;  
+    }
+
+    type Extension = Return<T>['module']
+    return AugmentedClient as typeof IgniteClient & Constructor<Extension>;
+  }
+
+  async signAndBroadcast(msgs: EncodeObject[], fee: StdFee, memo: string) {
+    if (this.signer) {
+      const { address } = (await this.signer.getAccounts())[0];
+      const signingClient = await SigningStargateClient.connectWithSigner(this.env.rpcURL, this.signer, { registry: new Registry(this.registry) });
+      return await signingClient.signAndBroadcast(address, msgs, fee ? fee : defaultFee, memo)
+    } else {
+      throw new Error(" Signer is not present.");
+    }
+  }
+
+  constructor(env: Env, signer?: OfflineSigner) {
+    super();
+    this.env = env;
+    this.setMaxListeners(0);
+    this.signer = signer;
+    const classConstructor = this.constructor as typeof IgniteClient;
+    classConstructor.plugins.forEach(plugin => {
+      const pluginInstance = plugin(this);
+      Object.assign(this, pluginInstance.module)
+      if (this.registry) {
+        this.registry = this.registry.concat(pluginInstance.registry)
+      }
+		});		
+  }
+  useSigner(signer: OfflineSigner) {    
+      this.signer = signer;
+      this.emit("signer-changed", this.signer);
+  }
+  removeSigner() {    
+      this.signer = undefined;
+      this.emit("signer-changed", this.signer);
+  }
+  async useKeplr(keplrChainInfo: Partial<ChainInfo> = {}) {
+    // Using queryClients directly because BaseClient has no knowledge of the modules at this stage
+    try {
+      const queryClient = (
+        await import("./cosmos.base.tendermint.v1beta1/module")
+      ).queryClient;
+      const bankQueryClient = (await import("./cosmos.bank.v1beta1/module"))
+        .queryClient;
+      const stakingQueryClient = (await import("./cosmos.staking.v1beta1/module")).queryClient;
+      const stakingqc = stakingQueryClient({ addr: this.env.apiURL });
+      const staking = await (await stakingqc.queryParams()).data;
+      const qc = queryClient({ addr: this.env.apiURL });
+      const node_info = await (await qc.serviceGetNodeInfo()).data;
+      const chainId = node_info.default_node_info?.network ?? "";
+      const chainName = chainId?.toUpperCase() + " Network";
+      const bankqc = bankQueryClient({ addr: this.env.apiURL });
+      const tokens = await (await bankqc.queryTotalSupply()).data;
+      const addrPrefix = this.env.prefix ?? "cosmos";
+      const rpc = this.env.rpcURL;
+      const rest = this.env.apiURL;
+
+      let bip44 = {
+        coinType: 118,
+      };
+
+      let bech32Config = {
+        bech32PrefixAccAddr: addrPrefix,
+        bech32PrefixAccPub: addrPrefix + "pub",
+        bech32PrefixValAddr: addrPrefix + "valoper",
+        bech32PrefixValPub: addrPrefix + "valoperpub",
+        bech32PrefixConsAddr: addrPrefix + "valcons",
+        bech32PrefixConsPub: addrPrefix + "valconspub",
+      };
+
+      let currencies =
+        tokens.supply?.map((x) => {
+          const y = {
+            coinDenom: x.denom?.toUpperCase() ?? "",
+            coinMinimalDenom: x.denom ?? "",
+            coinDecimals: 0,
+          };
+          return y;
+        }) ?? [];
+
+      let stakeCurrency = {
+              coinDenom: staking.params?.bond_denom?.toUpperCase() ?? "",
+              coinMinimalDenom: staking.params?.bond_denom ?? "",
+              coinDecimals: 0,
+            };
+
+      let feeCurrencies =
+        tokens.supply?.map((x) => {
+          const y = {
+            coinDenom: x.denom?.toUpperCase() ?? "",
+            coinMinimalDenom: x.denom ?? "",
+            coinDecimals: 0,
+          };
+          return y;
+        }) ?? [];
+
+      if (chainId) {
+        const suggestOptions: ChainInfo = {
+          chainId,
+          chainName,
+          rpc,
+          rest,
+          stakeCurrency,
+          bip44,
+          bech32Config,
+          currencies,
+          feeCurrencies,
+          ...keplrChainInfo,
+        };
+        await window.keplr.experimentalSuggestChain(suggestOptions);
+
+        window.keplr.defaultOptions = {
+          sign: {
+            preferNoSetFee: true,
+            preferNoSetMemo: true,
+          },
+        };
+      }
+      await window.keplr.enable(chainId);
+      this.signer = window.keplr.getOfflineSigner(chainId);
+      this.emit("signer-changed", this.signer);
+    } catch (e) {
+      throw new Error(
+        "Could not load tendermint, staking and bank modules. Please ensure your client loads them to use useKeplr()"
+      );
+    }
+  }
+}

ignite/pkg/cosmosgen/testdata/expected_files/ts-client/env.ts

@@ -0,0 +1,7 @@
+import { OfflineSigner } from "@cosmjs/proto-signing";
+
+export interface Env {
+  apiURL: string
+  rpcURL: string
+  prefix?: string
+}

ignite/pkg/cosmosgen/testdata/expected_files/ts-client/helpers.ts

@@ -0,0 +1,32 @@
+export type Constructor<T> = new (...args: any[]) => T;
+
+export type AnyFunction = (...args: any) => any;
+
+export type UnionToIntersection<Union> =
+  (Union extends any
+    ? (argument: Union) => void
+    : never
+  ) extends (argument: infer Intersection) => void
+      ? Intersection
+  : never;
+
+export type Return<T> =
+  T extends AnyFunction
+  ? ReturnType<T>
+  : T extends AnyFunction[]
+  ? UnionToIntersection<ReturnType<T[number]>>
+      : never
+
+
+export const MissingWalletError = new Error("wallet is required");
+
+export function getStructure(template) {
+	let structure = { fields: []  as Array<unknown>}
+	for (const [key, value] of Object.entries(template)) {
+		let field: any = {}
+		field.name = key
+		field.type = typeof value
+		structure.fields.push(field)
+	}
+	return structure
+}

ignite/pkg/cosmosgen/testdata/expected_files/ts-client/mars/module.ts → ignite/pkg/cosmosgen/testdata/expected_files/ts-client/ignite.planet.mars/module.ts

@@ -6,8 +6,8 @@ import { msgTypes } from './registry';
 import { IgniteClient } from "../client"
 import { MissingWalletError } from "../helpers"
 import { Api } from "./rest";
-import { MsgMyMessageRequest } from "./types/planet/mars/mars";
-import { MsgBarRequest } from "./types/planet/mars/mars";
+import { MsgMyMessageRequest } from "./types/ignite/planet/mars/mars";
+import { MsgBarRequest } from "./types/ignite/planet/mars/mars";
 
 import { AnotherType as typeAnotherType} from "./types"
 

ignite/pkg/cosmosgen/testdata/testchain/ts-client/mars/registry.ts → ignite/pkg/cosmosgen/testdata/expected_files/ts-client/ignite.planet.mars/registry.ts

@@ -1,6 +1,6 @@
 import { GeneratedType } from "@cosmjs/proto-signing";
-import { MsgMyMessageRequest } from "./types/planet/mars/mars";
-import { MsgBarRequest } from "./types/planet/mars/mars";
+import { MsgMyMessageRequest } from "./types/ignite/planet/mars/mars";
+import { MsgBarRequest } from "./types/ignite/planet/mars/mars";
 
 const msgTypes: Array<[string, GeneratedType]>  = [
     ["/ignite.planet.mars.MsgMyMessageRequest", MsgMyMessageRequest],

ignite/pkg/cosmosgen/testdata/testchain/ts-client/mars/rest.ts → ignite/pkg/cosmosgen/testdata/expected_files/ts-client/ignite.planet.mars/rest.ts

@@ -1,15 +1,15 @@
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
-import { QuerySimpleResponse } from "./types/planet/mars/mars";
-import { QuerySimpleParamsResponse } from "./types/planet/mars/mars";
-import { QueryWithPaginationResponse } from "./types/planet/mars/mars";
-import { QueryWithQueryParamsResponse } from "./types/planet/mars/mars";
-import { QueryWithQueryParamsWithPaginationResponse } from "./types/planet/mars/mars";
+import { QuerySimpleResponse } from "./types/ignite/planet/mars/mars";
+import { QuerySimpleParamsResponse } from "./types/ignite/planet/mars/mars";
+import { QueryWithPaginationResponse } from "./types/ignite/planet/mars/mars";
+import { QueryWithQueryParamsResponse } from "./types/ignite/planet/mars/mars";
+import { QueryWithQueryParamsWithPaginationResponse } from "./types/ignite/planet/mars/mars";
 
-import { QuerySimpleRequest } from "./types/planet/mars/mars";
-import { QuerySimpleParamsRequest } from "./types/planet/mars/mars";
-import { QueryWithPaginationRequest } from "./types/planet/mars/mars";
-import { QueryWithQueryParamsRequest } from "./types/planet/mars/mars";
-import { QueryWithQueryParamsWithPaginationRequest } from "./types/planet/mars/mars";
+import { QuerySimpleRequest } from "./types/ignite/planet/mars/mars";
+import { QuerySimpleParamsRequest } from "./types/ignite/planet/mars/mars";
+import { QueryWithPaginationRequest } from "./types/ignite/planet/mars/mars";
+import { QueryWithQueryParamsRequest } from "./types/ignite/planet/mars/mars";
+import { QueryWithQueryParamsWithPaginationRequest } from "./types/ignite/planet/mars/mars";
 
 
 import type {SnakeCasedPropertiesDeep} from 'type-fest';

ignite/pkg/cosmosgen/testdata/expected_files/ts-client/ignite.planet.mars/types.ts

@@ -0,0 +1,7 @@
+import { AnotherType } from "./types/ignite/planet/mars/mars"
+
+
+export {     
+    AnotherType,
+
+ }