@cosmwasm/ts-codegen 0.31.2 → 0.31.4

package/README.md

@@ -36,6 +36,8 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
     - [React Query](#react-query)
     - [Recoil](#recoil)
     - [Message Composer](#message-composer)
+    - [Message Builder](#message-builder)
+    - [Use Contracts Hooks](#use-contracts-hooks)
     - [Bundles](#bundles)
     - [CLI Usage and Examples](#cli-usage-and-examples)
     - [Advanced Usage](#advanced-usage)
@@ -256,13 +258,13 @@ cosmwasm-ts-codegen generate \
 | ------------------------------ | ------------------------------------------------------------------- |
 | `messageComposer.enabled`      | enable the messageComposer plugin                                   |
 
-### Msg Builder
+### Message Builder
 
 Generate raw message jsons for use in your application with the `msg-builder` command.
 
 [see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
 
-#### Msg Builder via CLI
+#### Message Builder via CLI
 
 ```sh
 cosmwasm-ts-codegen generate \
@@ -271,12 +273,66 @@ cosmwasm-ts-codegen generate \
     --out ./ts \
     --name MyContractName 
 ```
-#### Message Composer Options
+#### Message Builder Options
 
 | option      | description                                                         |
 |------------ | ------------------------------ | ------------------------------------------------------------------- |
-| `msgBuilder.enabled` | enable the msgBilder plugin                                   |
+| `msgBuilder.enabled` | enable the msgBuilder plugin                                   |
+
+
+### Use Contracts Hooks
+
+| option                           | description                             |
+| -------------------------------- | --------------------------------------- |
+| `useContractsHooks.enabled`      | enable the `useContracts` plugin        |
+
+#### Use Contracts Provider Usage
+
+```tsx
+import { useChain } from '@cosmos-kit/react';
+import { ContractsProvider } from '../path/to/codegen/contracts-context';
+
+export default function YourComponent() {
+  
+  const { 
+    address,
+    getCosmWasmClient,
+    getSigningCosmWasmClient
+  } = useChain(chainName);
+
+  return (
+    <ContractsProvider
+      contractsConfig={{
+        address,
+        getCosmWasmClient,
+        getSigningCosmWasmClient,
+      }}
+    >
+        <SomeCoolComponent />
+    </ContractsProvider>
+  )
+};
+```
+
+#### Use Contracts Hooks Usage
+
+Once enabled, you can get contracts very simply:
+
+```ts
+const { marketplace } = useContracts();
+```
 
+```ts
+const marketplaceClient = marketplace.signingClient(marketplaceContract);
+await marketplaceClient.updateAskPrice({
+  collection: token.collectionAddr,
+  price: {
+    amount,
+    denom,
+  },
+  tokenId,
+});
+```
 
 ### Bundles
 

package/main/generators/create-helpers.js

@@ -29,7 +29,7 @@ var write = function write(outPath, file, content) {
 var createHelpers = function createHelpers(input, builderContext) {
   var _input$options, _input$options$useCon, _Object$keys;
 
-  if ((_input$options = input.options) !== null && _input$options !== void 0 && (_input$options$useCon = _input$options.useContracts) !== null && _input$options$useCon !== void 0 && _input$options$useCon.enabled && (_Object$keys = Object.keys(builderContext.providers)) !== null && _Object$keys !== void 0 && _Object$keys.length) {
+  if ((_input$options = input.options) !== null && _input$options !== void 0 && (_input$options$useCon = _input$options.useContractsHooks) !== null && _input$options$useCon !== void 0 && _input$options$useCon.enabled && (_Object$keys = Object.keys(builderContext.providers)) !== null && _Object$keys !== void 0 && _Object$keys.length) {
     write(input.outPath, "contractContextBase.ts", _helpers.contractContextBase);
     write(input.outPath, "contracts-context.tsx", _helpers.contractsContextTSX);
   }

package/main/plugins/provider-bundle.js

@@ -76,7 +76,7 @@ var ContractsProviderBundlePlugin = /*#__PURE__*/function (_BuilderPluginBase) {
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                if ((_this$option = this.option) !== null && _this$option !== void 0 && (_this$option$useContr = _this$option.useContracts) !== null && _this$option$useContr !== void 0 && _this$option$useContr.enabled) {
+                if ((_this$option = this.option) !== null && _this$option !== void 0 && (_this$option$useContr = _this$option.useContractsHooks) !== null && _this$option$useContr !== void 0 && _this$option$useContr.enabled) {
                   _context.next = 2;
                   break;
                 }

package/main/plugins/provider.js

@@ -83,7 +83,7 @@ var ContractsContextProviderPlugin = /*#__PURE__*/function (_BuilderPluginBase)
           while (1) {
             switch (_context.prev = _context.next) {
               case 0:
-                if ((_this$option = this.option) !== null && _this$option !== void 0 && (_this$option$useContr = _this$option.useContracts) !== null && _this$option$useContr !== void 0 && _this$option$useContr.enabled) {
+                if ((_this$option = this.option) !== null && _this$option !== void 0 && (_this$option$useContr = _this$option.useContractsHooks) !== null && _this$option$useContr !== void 0 && _this$option$useContr.enabled) {
                   _context.next = 2;
                   break;
                 }

package/module/generators/create-helpers.js

@@ -18,7 +18,7 @@ const write = (outPath, file, content) => {
 };
 
 export const createHelpers = (input, builderContext) => {
-  if (input.options?.useContracts?.enabled && Object.keys(builderContext.providers)?.length) {
+  if (input.options?.useContractsHooks?.enabled && Object.keys(builderContext.providers)?.length) {
     write(input.outPath, "contractContextBase.ts", contractContextBase);
     write(input.outPath, "contracts-context.tsx", contractsContextTSX);
   }

package/module/plugins/provider-bundle.js

@@ -20,7 +20,7 @@ export class ContractsProviderBundlePlugin extends BuilderPluginBase {
   }
 
   async doRender(name, context) {
-    if (!this.option?.useContracts?.enabled) {
+    if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
 

package/module/plugins/provider.js

@@ -19,7 +19,7 @@ export class ContractsContextProviderPlugin extends BuilderPluginBase {
   }
 
   async doRender(name, context) {
-    if (!this.option?.useContracts?.enabled) {
+    if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmwasm/ts-codegen",
-  "version": "0.31.2",
+  "version": "0.31.4",
   "description": "@cosmwasm/ts-codegen converts your CosmWasm smart contracts into dev-friendly TypeScript classes so you can focus on shipping code.",
   "author": "Dan Lynch <pyramation@gmail.com>",
   "homepage": "https://github.com/cosmwasm/ts-codegen",
@@ -98,5 +98,5 @@
     "shelljs": "0.8.5",
     "wasm-ast-types": "^0.24.0"
   },
-  "gitHead": "ac5ac9a874b56929f76b052a6a719f5c1015ccab"
+  "gitHead": "4c207bade9c6e542e9fc4d29b60866f4d7ff1627"
 }

package/src/builder/builder.ts

@@ -1,4 +1,4 @@
-import { RenderOptions, defaultOptions, RenderContext, ContractInfo, MessageComposerOptions, BuilderContext} from "wasm-ast-types";
+import { RenderOptions, defaultOptions, RenderContext, ContractInfo, MessageComposerOptions, BuilderContext } from "wasm-ast-types";
 
 import { header } from '../utils/header';
 import { join } from "path";
@@ -48,13 +48,13 @@ export interface BundleOptions {
 };
 
 export interface UseContractsOptions {
-  enabled?: boolean;
-  filename?: string;
+    enabled?: boolean;
+    filename?: string;
 };
 
 export type TSBuilderOptions = {
     bundle?: BundleOptions;
-    useContracts?: UseContractsOptions;
+    useContractsHooks?: UseContractsOptions;
 } & RenderOptions;
 
 export type BuilderFileType = 'type' | 'client' | 'recoil' | 'react-query' | 'message-composer' | 'msg-builder' | 'plugin';
@@ -125,7 +125,7 @@ export class TSBuilder {
             [].push.apply(this.plugins, plugins);
         }
 
-        this.plugins.forEach(plugin=> plugin.setBuilder(this))
+        this.plugins.forEach(plugin => plugin.setBuilder(this))
     }
 
     async build() {
@@ -134,7 +134,7 @@ export class TSBuilder {
     }
 
     // lifecycle functions
-    private async process(){
+    private async process() {
         for (const contractOpt of this.contracts) {
             const contract = getContract(contractOpt);
             //resolve contract schema.
@@ -147,16 +147,16 @@ export class TSBuilder {
         }
     }
 
-    private async render(name: string, contractInfo: ContractInfo){
-      for (const plugin of this.plugins) {
-          let files = await plugin.render(name, contractInfo, this.outPath);
-          if(files && files.length){
-              [].push.apply(this.files, files);
-          }
-      }
+    private async render(name: string, contractInfo: ContractInfo) {
+        for (const plugin of this.plugins) {
+            let files = await plugin.render(name, contractInfo, this.outPath);
+            if (files && files.length) {
+                [].push.apply(this.files, files);
+            }
+        }
     }
 
-    private async after(){
+    private async after() {
         if (this.options.bundle.enabled) {
             this.bundle();
         }
@@ -166,21 +166,21 @@ export class TSBuilder {
         contractsProviderBundlePlugin.setBuilder(this);
 
         let files = await contractsProviderBundlePlugin.render(
-          "",
-          {
-            schemas: [],
-          },
-          this.outPath
+            "",
+            {
+                schemas: [],
+            },
+            this.outPath
         );
-        if(files && files.length){
-          [].push.apply(this.files, files);
+        if (files && files.length) {
+            [].push.apply(this.files, files);
         }
 
         createHelpers({
-          outPath: this.outPath,
-          contracts: this.contracts,
-          options: this.options,
-          plugins: this.plugins,
+            outPath: this.outPath,
+            contracts: this.contracts,
+            options: this.options,
+            plugins: this.plugins,
         }, this.builderContext);
     }
 
@@ -190,8 +190,8 @@ export class TSBuilder {
 
         const bundleFile = this.options.bundle.bundleFile;
         const bundlePath = join(
-          this.options?.bundle?.bundlePath ?? this.outPath,
-          bundleFile
+            this.options?.bundle?.bundlePath ?? this.outPath,
+            bundleFile
         );
         const bundleVariables = {};
         const importPaths = [];
@@ -215,7 +215,7 @@ export class TSBuilder {
             ]
         )).code;
 
-        if(this.options?.bundle?.bundlePath){
+        if (this.options?.bundle?.bundlePath) {
             mkdirp(this.options?.bundle?.bundlePath);
         }
 

package/src/generators/create-helpers.ts

@@ -21,7 +21,7 @@ const write = (outPath: string, file: string, content: string) => {
 };
 
 export const createHelpers = (input: TSBuilderInput, builderContext: BuilderContext) => {
-  if (input.options?.useContracts?.enabled && Object.keys(builderContext.providers)?.length) {
+  if (input.options?.useContractsHooks?.enabled && Object.keys(builderContext.providers)?.length) {
     write(input.outPath, "contractContextBase.ts", contractContextBase);
     write(input.outPath, "contracts-context.tsx", contractsContextTSX);
   }

package/src/plugins/provider-bundle.ts

@@ -36,7 +36,7 @@ export class ContractsProviderBundlePlugin extends BuilderPluginBase<TSBuilderOp
       body: any[];
     }[]
   > {
-    if (!this.option?.useContracts?.enabled) {
+    if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
 

package/src/plugins/provider.ts

@@ -39,7 +39,7 @@ export class ContractsContextProviderPlugin extends BuilderPluginBase<TSBuilderO
       body: any[];
     }[]
   > {
-    if (!this.option?.useContracts?.enabled) {
+    if (!this.option?.useContractsHooks?.enabled) {
       return;
     }
 

package/types/src/builder/builder.d.ts

@@ -18,7 +18,7 @@ export interface UseContractsOptions {
 }
 export type TSBuilderOptions = {
     bundle?: BundleOptions;
-    useContracts?: UseContractsOptions;
+    useContractsHooks?: UseContractsOptions;
 } & RenderOptions;
 export type BuilderFileType = 'type' | 'client' | 'recoil' | 'react-query' | 'message-composer' | 'msg-builder' | 'plugin';
 export interface BuilderFile {