@cosmwasm/ts-codegen 0.30.0 → 0.31.0

package/src/helpers/contractsContextTSX.ts

@@ -0,0 +1,73 @@
+export const contractsContextTSX = `
+import React, { useEffect, useMemo, useRef, useState, useContext } from 'react';
+import {
+  CosmWasmClient,
+  SigningCosmWasmClient,
+} from '@cosmjs/cosmwasm-stargate';
+
+import { IContractsContext, getProviders } from './contractContextProviders';
+
+interface ContractsConfig {
+  address: string | undefined;
+  getCosmWasmClient: () => Promise<CosmWasmClient>;
+  getSigningCosmWasmClient: () => Promise<SigningCosmWasmClient>;
+}
+
+const ContractsContext = React.createContext<IContractsContext | null>(null);
+
+export const ContractsProvider = ({
+  children,
+  contractsConfig,
+}: {
+  children: React.ReactNode;
+  contractsConfig: ContractsConfig;
+}) => {
+  const [cosmWasmClient, setCosmWasmClient] = useState<CosmWasmClient>();
+  const [signingCosmWasmClient, setSigningCosmWasmClient] =
+    useState<SigningCosmWasmClient>();
+
+  const { address, getCosmWasmClient, getSigningCosmWasmClient } =
+    contractsConfig;
+
+  const prevAddressRef = useRef<string | undefined>(address);
+
+  const contracts: IContractsContext = useMemo(() => {
+    return getProviders(address, cosmWasmClient, signingCosmWasmClient);
+  }, [address, cosmWasmClient, signingCosmWasmClient]);
+
+  useEffect(() => {
+    const connectSigningCwClient = async () => {
+      if (address && prevAddressRef.current !== address) {
+        const signingCosmWasmClient = await getSigningCosmWasmClient();
+        setSigningCosmWasmClient(signingCosmWasmClient);
+      } else if (!address) {
+        setSigningCosmWasmClient(undefined);
+      }
+      prevAddressRef.current = address;
+    };
+    connectSigningCwClient();
+  }, [address, getSigningCosmWasmClient]);
+
+  useEffect(() => {
+    const connectCosmWasmClient = async () => {
+      const cosmWasmClient = await getCosmWasmClient();
+      setCosmWasmClient(cosmWasmClient);
+    };
+    connectCosmWasmClient();
+  }, [getCosmWasmClient]);
+
+  return (
+    <ContractsContext.Provider value={contracts}>
+      {children}
+    </ContractsContext.Provider>
+  );
+};
+
+export const useContracts = () => {
+  const contracts = useContext(ContractsContext);
+  if (contracts === null) {
+    throw new Error('useContracts must be used within a ContractsProvider');
+  }
+  return contracts;
+};
+`;

package/src/helpers/index.ts

@@ -0,0 +1,2 @@
+export * from './contractContextBase';
+export * from './contractsContextTSX';

package/src/plugins/client.ts

@@ -1,22 +1,24 @@
-import { pascal } from 'case';
-import * as w from 'wasm-ast-types';
-import { findExecuteMsg, findAndParseTypes, findQueryMsg } from '../utils';
+import { pascal } from "case";
+import * as w from "wasm-ast-types";
+import { findExecuteMsg, findAndParseTypes, findQueryMsg } from "../utils";
 import {
   RenderContext,
   ContractInfo,
   RenderContextBase,
   getMessageProperties,
-  RenderOptions
-} from 'wasm-ast-types';
-import { BuilderFileType } from '../builder';
-import { BuilderPluginBase } from './plugin-base';
+  RenderOptions,
+} from "wasm-ast-types";
+import { BuilderFileType } from "../builder";
+import { BuilderPluginBase } from "./plugin-base";
+
+export const TYPE = "client";
 
 export class ClientPlugin extends BuilderPluginBase<RenderOptions> {
   initContext(
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(
@@ -38,8 +40,8 @@ export class ClientPlugin extends BuilderPluginBase<RenderOptions> {
 
     const { schemas } = context.contract;
 
-    const localname = pascal(name) + '.client.ts';
-    const TypesFile = pascal(name) + '.types';
+    const localname = pascal(name) + ".client.ts";
+    const TypesFile = pascal(name) + ".types";
     const QueryMsg = findQueryMsg(schemas);
     const ExecuteMsg = findExecuteMsg(schemas);
     const typeHash = await findAndParseTypes(schemas);
@@ -62,6 +64,13 @@ export class ClientPlugin extends BuilderPluginBase<RenderOptions> {
       body.push(
         w.createQueryClass(context, QueryClient, ReadOnlyInstance, QueryMsg)
       );
+
+      context.addProviderInfo(
+        name,
+        w.PROVIDER_TYPES.QUERY_CLIENT_TYPE,
+        QueryClient,
+        localname
+      );
     }
 
     // execute messages
@@ -89,20 +98,27 @@ export class ClientPlugin extends BuilderPluginBase<RenderOptions> {
             ExecuteMsg
           )
         );
+
+        context.addProviderInfo(
+          name,
+          w.PROVIDER_TYPES.SIGNING_CLIENT_TYPE,
+          Client,
+          localname
+        );
       }
     }
 
-    if (typeHash.hasOwnProperty('Coin')) {
+    if (typeHash.hasOwnProperty("Coin")) {
       // @ts-ignore
       delete context.utils.Coin;
     }
 
     return [
       {
-        type: 'client',
+        type: TYPE,
         localname,
-        body
-      }
+        body,
+      },
     ];
   }
 }

package/src/plugins/message-composer.ts

@@ -1,23 +1,25 @@
-import { pascal } from 'case';
-import * as w from 'wasm-ast-types';
-import { findAndParseTypes, findExecuteMsg } from '../utils';
+import { pascal } from "case";
+import * as w from "wasm-ast-types";
+import { findAndParseTypes, findExecuteMsg } from "../utils";
 import {
   MessageComposerOptions,
   getMessageProperties,
   ContractInfo,
   RenderContextBase,
   RenderContext,
-  RenderOptions
-} from 'wasm-ast-types';
-import { BuilderFileType } from '../builder';
-import { BuilderPluginBase } from './plugin-base';
+  RenderOptions,
+} from "wasm-ast-types";
+import { BuilderFileType } from "../builder";
+import { BuilderPluginBase } from "./plugin-base";
+
+export const TYPE = "message-composer";
 
 export class MessageComposerPlugin extends BuilderPluginBase<RenderOptions> {
   initContext(
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(
@@ -39,8 +41,8 @@ export class MessageComposerPlugin extends BuilderPluginBase<RenderOptions> {
 
     const { schemas } = context.contract;
 
-    const localname = pascal(name) + '.message-composer.ts';
-    const TypesFile = pascal(name) + '.types';
+    const localname = pascal(name) + ".message-composer.ts";
+    const TypesFile = pascal(name) + ".types";
     const ExecuteMsg = findExecuteMsg(schemas);
     const typeHash = await findAndParseTypes(schemas);
 
@@ -61,20 +63,27 @@ export class MessageComposerPlugin extends BuilderPluginBase<RenderOptions> {
         body.push(
           w.createMessageComposerClass(context, TheClass, Interface, ExecuteMsg)
         );
+
+        context.addProviderInfo(
+          name,
+          w.PROVIDER_TYPES.MESSAGE_COMPOSER_TYPE,
+          TheClass,
+          localname
+        );
       }
     }
 
-    if (typeHash.hasOwnProperty('Coin')) {
+    if (typeHash.hasOwnProperty("Coin")) {
       // @ts-ignore
       delete context.utils.Coin;
     }
 
     return [
       {
-        type: 'message-composer',
+        type: TYPE,
         localname,
-        body
-      }
+        body,
+      },
     ];
   }
 }

package/src/plugins/msg-builder.ts

@@ -16,7 +16,7 @@ export class MsgBuilderPlugin extends BuilderPluginBase<RenderOptions> {
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(

package/src/plugins/plugin-base.ts

@@ -1,15 +1,16 @@
-import { sync as mkdirp } from 'mkdirp';
-import { join } from 'path';
-import { writeFileSync } from 'fs';
-import { header } from '../utils/header';
+import { sync as mkdirp } from "mkdirp";
+import { join } from "path";
+import { writeFileSync } from "fs";
+import { header } from "../utils/header";
+import { ContractInfo, UtilMapping, IContext } from "wasm-ast-types";
+import generate from "@babel/generator";
+import * as t from "@babel/types";
 import {
-  ContractInfo,
-  UtilMapping,
-  IContext
-} from 'wasm-ast-types';
-import generate from '@babel/generator';
-import * as t from '@babel/types';
-import { BuilderFile, BuilderFileType, TSBuilderOptions } from '../builder';
+  BuilderFile,
+  BuilderFileType,
+  TSBuilder,
+  TSBuilderOptions,
+} from "../builder";
 
 /**
  * IBuilderPlugin is a common plugin that render generated code.
@@ -20,6 +21,10 @@ export interface IBuilderPlugin {
    */
   utils: UtilMapping;
 
+  builder?: TSBuilder;
+
+  setBuilder(builder: TSBuilder);
+
   /**
    * render generated cdoe.
    * @param name the name of contract
@@ -30,19 +35,27 @@ export interface IBuilderPlugin {
   render(
     name: string,
     contractInfo: ContractInfo,
-    outPath: string,
+    outPath: string
   ): Promise<BuilderFile[]>;
 }
 
 /**
  * BuilderPluginBase enable ts-codegen users implement their own plugins by only implement a few functions.
  */
-export abstract class BuilderPluginBase<TOpt extends { enabled?: boolean }> implements IBuilderPlugin {
+export abstract class BuilderPluginBase<TOpt extends { enabled?: boolean }>
+  implements IBuilderPlugin
+{
+  builder?: TSBuilder;
   option: TOpt;
   utils: UtilMapping;
 
-  constructor(opt: TOpt) {
+  constructor(opt: TOpt, builder?: TSBuilder) {
     this.option = opt;
+    this.builder = builder;
+  }
+
+  setBuilder(builder: TSBuilder) {
+    this.builder = builder;
   }
 
   async render(
@@ -65,7 +78,7 @@ export abstract class BuilderPluginBase<TOpt extends { enabled?: boolean }> impl
     }
 
     return results.map((result) => {
-      const imports = context.getImports(this.utils);
+      const imports = context.getImports(this.utils, result.localname);
       const code =
         header + generate(t.program([...imports, ...result.body])).code;
 
@@ -78,7 +91,7 @@ export abstract class BuilderPluginBase<TOpt extends { enabled?: boolean }> impl
         pluginType: result.pluginType,
         contract: name,
         localname: result.localname,
-        filename
+        filename,
       };
     });
   }
@@ -88,10 +101,7 @@ export abstract class BuilderPluginBase<TOpt extends { enabled?: boolean }> impl
    * @param contract
    * @param options
    */
-  abstract initContext(
-    contract: ContractInfo,
-    options?: TOpt
-  ): IContext;
+  abstract initContext(contract: ContractInfo, options?: TOpt): IContext;
 
   /**
    * render generated code here.

package/src/plugins/provider-bundle.ts

@@ -0,0 +1,97 @@
+import { pascal } from "case";
+import * as w from "wasm-ast-types";
+import { ContractInfo, RenderContextBase, RenderContext } from "wasm-ast-types";
+import { BuilderFileType, TSBuilderOptions } from "../builder";
+import { BuilderPluginBase } from "./plugin-base";
+import { GetLocalBaseNameByContractName } from "./provider";
+
+export class ContractsProviderBundlePlugin extends BuilderPluginBase<TSBuilderOptions> {
+  constructor(opt: TSBuilderOptions) {
+    super(opt);
+
+    this.utils = {
+      CosmWasmClient: "@cosmjs/cosmwasm-stargate",
+      SigningCosmWasmClient: "@cosmjs/cosmwasm-stargate",
+      IQueryClientProvider: "__contractContextBase__",
+      ISigningClientProvider: "__contractContextBase__",
+      IMessageComposerProvider: "__contractContextBase__",
+    };
+  }
+
+  initContext(
+    contract: ContractInfo,
+    options?: TSBuilderOptions
+  ): RenderContextBase<TSBuilderOptions> {
+    return new RenderContext(contract, options, this.builder.builderContext);
+  }
+
+  async doRender(
+    name: string,
+    context: RenderContext
+  ): Promise<
+    {
+      type: BuilderFileType;
+      pluginType?: string;
+      localname: string;
+      body: any[];
+    }[]
+  > {
+    if (!this.option?.useContracts?.enabled) {
+      return;
+    }
+
+    const providerInfos = context.getProviderInfos();
+
+    if (!Object.keys(providerInfos)?.length) {
+      return;
+    }
+
+    const localname = "contractContextProviders.ts";
+
+    const body = [];
+
+    context.addUtil("CosmWasmClient");
+    context.addUtil("SigningCosmWasmClient");
+
+    context.addUtil("IQueryClientProvider");
+    context.addUtil("ISigningClientProvider");
+    context.addUtil("IMessageComposerProvider");
+
+    for (const name in providerInfos) {
+      if (Object.prototype.hasOwnProperty.call(providerInfos, name)) {
+        const providerInfo = providerInfos[name];
+
+        for (const key in providerInfo) {
+          if (Object.prototype.hasOwnProperty.call(providerInfo, key)) {
+            const info = providerInfo[key];
+
+            body.push(
+              w.importStmt(
+                [info.classname],
+                `./${info.basename}`
+              )
+            );
+          }
+        }
+
+        body.push(
+          w.importStmt(
+            [pascal(name)],
+            `./${GetLocalBaseNameByContractName(name)}`
+          )
+        );
+      }
+    }
+
+    body.push(w.createIContractsContext(providerInfos));
+    body.push(w.createGettingProviders(providerInfos));
+
+    return [
+      {
+        type: "plugin",
+        localname,
+        body,
+      },
+    ];
+  }
+}

package/src/plugins/provider.ts

@@ -0,0 +1,114 @@
+import { pascal } from "case";
+import * as w from "wasm-ast-types";
+import { ContractInfo, RenderContextBase, RenderContext } from "wasm-ast-types";
+import { BuilderFileType, TSBuilderOptions } from "../builder";
+import { BuilderPluginBase } from "./plugin-base";
+
+export const GetLocalNameByContractName = (name) =>
+  `${pascal(name)}.provider.ts`;
+
+export const GetLocalBaseNameByContractName = (name) =>
+  `${pascal(name)}.provider`;
+
+export class ContractsContextProviderPlugin extends BuilderPluginBase<TSBuilderOptions> {
+  constructor(opt: TSBuilderOptions) {
+    super(opt);
+
+    this.utils = {
+      ContractBase: "__contractContextBase__",
+      IContractConstructor: "__contractContextBase__",
+      IEmptyClient: "__contractContextBase__",
+    };
+  }
+
+  initContext(
+    contract: ContractInfo,
+    options?: TSBuilderOptions
+  ): RenderContextBase<TSBuilderOptions> {
+    return new RenderContext(contract, options, this.builder.builderContext);
+  }
+
+  async doRender(
+    name: string,
+    context: RenderContext
+  ): Promise<
+    {
+      type: BuilderFileType;
+      pluginType?: string;
+      localname: string;
+      body: any[];
+    }[]
+  > {
+    if (!this.option?.useContracts?.enabled) {
+      return;
+    }
+
+    const providerInfo = context.getProviderInfos()[name];
+
+    if (!Object.keys(providerInfo)?.length) {
+      return;
+    }
+
+    context.addUtil("ContractBase");
+    context.addUtil("IContractConstructor");
+
+    const localname = GetLocalNameByContractName(name);
+    let needEmptyClientType = false;
+    let clientFile = null;
+    let clientClasses = [];
+
+    const body = [];
+
+    const signClientProviderInfo =
+      providerInfo[w.PROVIDER_TYPES.SIGNING_CLIENT_TYPE];
+
+    if (signClientProviderInfo) {
+      clientFile = `./${signClientProviderInfo.basename}`;
+      clientClasses.push(signClientProviderInfo.classname);
+    } else {
+      needEmptyClientType = true;
+    }
+
+    const queryClientProviderInfo =
+      providerInfo[w.PROVIDER_TYPES.QUERY_CLIENT_TYPE];
+
+    if (queryClientProviderInfo) {
+      clientFile = `./${queryClientProviderInfo.basename}`;
+      clientClasses.push(queryClientProviderInfo.classname);
+    } else {
+      needEmptyClientType = true;
+    }
+
+    if (clientFile) {
+      body.push(w.importStmt(clientClasses, clientFile));
+    }
+
+    const messageComposerProviderInfo =
+      providerInfo[w.PROVIDER_TYPES.MESSAGE_COMPOSER_TYPE];
+
+    if (messageComposerProviderInfo) {
+      body.push(
+        w.importStmt(
+          [messageComposerProviderInfo.classname],
+          `./${messageComposerProviderInfo.basename}`
+        )
+      );
+    } else {
+      needEmptyClientType = true;
+    }
+
+    if (needEmptyClientType) {
+      context.addUtil("IEmptyClient");
+    }
+
+    body.push(w.createProvider(name, providerInfo));
+
+    return [
+      {
+        type: "plugin",
+        localname,
+        body,
+      },
+    ];
+  }
+}

package/src/plugins/react-query.ts

@@ -16,7 +16,7 @@ export class ReactQueryPlugin extends BuilderPluginBase<RenderOptions> {
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(

package/src/plugins/recoil.ts

@@ -19,7 +19,7 @@ export class RecoilPlugin extends BuilderPluginBase<RenderOptions> {
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(

package/src/plugins/types.ts

@@ -16,7 +16,7 @@ export class TypesPlugin extends BuilderPluginBase<RenderOptions> {
     contract: ContractInfo,
     options?: RenderOptions
   ): RenderContextBase<RenderOptions> {
-    return new RenderContext(contract, options);
+    return new RenderContext(contract, options, this.builder.builderContext);
   }
 
   async doRender(

package/src/utils/files.ts

@@ -0,0 +1,73 @@
+import * as t from "@babel/types";
+import { parse, ParserPlugin } from "@babel/parser";
+import { sync as mkdirp } from "mkdirp";
+import { writeFileSync } from "fs";
+import { dirname } from "path";
+import generate from "@babel/generator";
+import { unused } from "./unused";
+import traverse from "@babel/traverse";
+
+export const writeAstToFile = (
+  outPath: string,
+  program: t.Statement[],
+  filename: string,
+  removeUnusedImports = false,
+  isTsDisable = false,
+  isEslintDisable = false
+) => {
+  const ast = t.program(program);
+  const content = generate(ast).code;
+
+  if (removeUnusedImports) {
+    const plugins: ParserPlugin[] = ["typescript"];
+    const newAst = parse(content, {
+      sourceType: "module",
+      plugins,
+    });
+    traverse(newAst, unused);
+    const content2 = generate(newAst).code;
+    writeContentToFile(
+      outPath,
+      content2,
+      filename,
+      isTsDisable,
+      isEslintDisable
+    );
+  } else {
+    writeContentToFile(
+      outPath,
+      content,
+      filename,
+      isTsDisable,
+      isEslintDisable
+    );
+  }
+};
+
+export const writeContentToFile = (
+  outPath: string,
+  content: string,
+  filename: string,
+  isTsDisable = false,
+  isEslintDisable = false
+) => {
+  let esLintPrefix = "";
+  let tsLintPrefix = "";
+
+  let nameWithoutPath = filename.replace(outPath, "");
+  // strip off leading slash
+  if (nameWithoutPath.startsWith("/"))
+    nameWithoutPath = nameWithoutPath.replace(/^\//, "");
+
+  if (isTsDisable) {
+    tsLintPrefix = `//@ts-nocheck\n`;
+  }
+
+  if (isEslintDisable) {
+    esLintPrefix = `/* eslint-disable */\n`;
+  }
+
+  const text = tsLintPrefix + esLintPrefix + content;
+  mkdirp(dirname(filename));
+  writeFileSync(filename, text);
+};

package/src/utils/schemas.ts

@@ -79,9 +79,7 @@ export const findQueryMsg = (schemas) => {
 
 export const findExecuteMsg = (schemas) => {
     const ExecuteMsg = schemas.find(schema =>
-        schema.title === 'ExecuteMsg' ||
-        schema.title === 'ExecuteMsg_for_Empty' || // if cleanse is used, this is never
-        schema.title === 'ExecuteMsgForEmpty'
+      schema.title.startsWith('ExecuteMsg')
     );
     return ExecuteMsg;
 };