@cosmwasm/ts-codegen 0.34.1 → 0.35.0

package/README.md

@@ -47,7 +47,7 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
     - [Exporting Schemas](#exporting-schemas)
 - [Developing](#developing)
 - [Related](#related)
-## Quickstart 
+## Quickstart
 
 Clone your project and `cd` into your contracts folder
 
@@ -122,7 +122,7 @@ codegen({
     messageComposer: {
       enabled: false
     },
-    msgBuilder: {
+    messageBuilder: {
       enabled: false
     },
     useContractsHooks: {
@@ -133,7 +133,7 @@ codegen({
   console.log('✨ all done!');
 });
 ```
-#### Types 
+#### Types
 
 Typescript types and interfaces are generated in separate files so they can be imported into various generated plugins.
 
@@ -149,7 +149,7 @@ Typescript types and interfaces are generated in separate files so they can be i
 
 ### Client
 
-The `client` plugin will generate TS client classes for your contracts. This option generates a `QueryClient` for queries as well as a `Client` for queries and mutations. 
+The `client` plugin will generate TS client classes for your contracts. This option generates a `QueryClient` for queries as well as a `Client` for queries and mutations.
 
 [see example output code](https://gist.github.com/pyramation/30508678b7563e286f06ccc5ac384817)
 
@@ -189,7 +189,7 @@ Generate [react-query v3](https://react-query-v3.tanstack.com/) or [react-query
 | `reactQuery.camelize`       | use camelCase style for property names                                       |
 
 
-#### React Query via CLI 
+#### React Query via CLI
 
 Here is an example without optional client, using v3 for `react-query`, without mutations:
 
@@ -231,7 +231,7 @@ cosmwasm-ts-codegen generate \
     --plugin recoil \
     --schema ./schema \
     --out ./ts \
-    --name MyContractName 
+    --name MyContractName
 ```
 
 #### Recoil Options
@@ -253,7 +253,7 @@ cosmwasm-ts-codegen generate \
     --plugin message-composer \
     --schema ./schema \
     --out ./ts \
-    --name MyContractName 
+    --name MyContractName
 ```
 #### Message Composer Options
 
@@ -263,7 +263,7 @@ cosmwasm-ts-codegen generate \
 
 ### Message Builder
 
-Generate raw message jsons for use in your application with the `msg-builder` command.
+Generate raw message jsons for use in your application with the `message-builder` command.
 
 [see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
 
@@ -271,16 +271,16 @@ Generate raw message jsons for use in your application with the `msg-builder` co
 
 ```sh
 cosmwasm-ts-codegen generate \
-    --plugin msg-builder \
+    --plugin message-builder \
     --schema ./schema \
     --out ./ts \
-    --name MyContractName 
+    --name MyContractName
 ```
 #### Message Builder Options
 
-| option               | description                    |
-|--------------------- | ------------------------------ |
-| `msgBuilder.enabled` | enable the msgBuilder plugin   |
+| option                   | description                        |
+|------------------------- | ---------------------------------- |
+| `messageBuilder.enabled` | enable the messageBuilder plugin   |
 
 
 ### Use Contracts Hooks
@@ -296,8 +296,8 @@ import { useChain } from '@cosmos-kit/react';
 import { ContractsProvider } from '../path/to/codegen/contracts-context';
 
 export default function YourComponent() {
-  
-  const { 
+
+  const {
     address,
     getCosmWasmClient,
     getSigningCosmWasmClient
@@ -317,6 +317,16 @@ export default function YourComponent() {
 };
 ```
 
+If you're using Babel, please make sure include '@babel/preset-react' in devDeps and presets in .babelrc.js:
+
+```js
+ presets: [
+      '@babel/typescript',
+      '@babel/env',
+      '@babel/preset-react',
+     ]
+```
+
 #### Use Contracts Hooks Usage
 
 Once enabled, you can get contracts very simply:
@@ -357,11 +367,64 @@ const { CwAdminFactoryClient } = contracts.CwAdminFactory;
 | `bundle.scope`        | name of the scope, defaults to `contracts` (you can use `.` to make more scopes) |
 | `bundle.bundleFile`   | name of the bundle file                                                          |
 
+#### Coding Style
+
+| option                | description                          | default |
+| --------------------- | ---------------------------------------------- |
+| `useShorthandCtor`    |  Enable using shorthand constructor. | true    |
+
+Using shorthand constructor (Might not be transpiled correctly with babel):
+
+```ts
+  constructor(
+    protected address: string | undefined,
+    protected cosmWasmClient: CosmWasmClient | undefined,
+    protected signingCosmWasmClient: SigningCosmWasmClient | undefined,
+    private TSign?: new (
+      client: SigningCosmWasmClient,
+      sender: string,
+      contractAddress: string
+    ) => TSign,
+    private TQuery?: new (
+      client: CosmWasmClient,
+      contractAddress: string
+    ) => TQuery,
+    private TMsgComposer?: new (
+      sender: string,
+      contractAddress: string
+    ) => TMsgComposer
+  ) {}
+```
+
+Without using shorthand constructor:
+
+```ts
+  address: string | undefined;
+  ...
+  TMsgComposer?: new (
+    sender: string,
+    contractAddress: string
+  ) => TMsgComposer;
+
+  constructor(
+    address: string | undefined,
+    ...
+    TMsgComposer?: new (
+      sender: string,
+      contractAddress: string
+    ) => TMsgComposer
+  ) {
+    this.address = address;
+    ...
+    this.TMsgComposer = TMsgComposer;
+  }
+```
+
 ### CLI Usage and Examples
 
 #### Interactive prompt
 
-The CLI is interactive, and if you don't specify an option, it will interactively prompt you. 
+The CLI is interactive, and if you don't specify an option, it will interactively prompt you.
 
 ```sh
 cosmwasm-ts-codegen generate
@@ -444,12 +507,12 @@ cosmwasm-ts-codegen generate \
 for lower-level access, you can import the various plugins directly:
 
 ```ts
-import { 
+import {
   generateTypes,
   generateClient,
   generateReactQuery,
   generateRecoil,
-  generateMessageComposer,
+  generateMessageComposer
 } from '@cosmwasm/ts-codegen';
 ```
 ### Example Output
@@ -474,7 +537,7 @@ https://gist.github.com/pyramation/a9520ccf131177b1841e02a97d7d3731
 
 https://gist.github.com/pyramation/43320e8b952751a0bd5a77dbc5b601f4
 
-- `cosmwasm-ts-codegen generate --plugin msg-builder`
+- `cosmwasm-ts-codegen generate --plugin message-builder`
 
 https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26
 
@@ -541,7 +604,7 @@ export_schema_with_title(
 ### Initial setup
 
 ```
-yarn 
+yarn
 yarn bootstrap
 ```
 
@@ -568,7 +631,7 @@ See the [docs](https://github.com/CosmWasm/ts-codegen/blob/main/packages/wasm-as
 
 Checkout these related projects:
 
-* [@cosmology/telescope](https://github.com/osmosis-labs/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
+* [@cosmology/telescope](https://github.com/cosmology-tech/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
 * [chain-registry](https://github.com/cosmology-tech/chain-registry) an npm module for the official Cosmos chain-registry.
 * [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit) A wallet connector for the Cosmos ⚛️
 * [create-cosmos-app](https://github.com/cosmology-tech/create-cosmos-app) set up a modern Cosmos app by running one command.