Skip to content

Commit 85e69d3

Browse files
committed
Add msg-builder readme
1 parent f98a8bd commit 85e69d3

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,9 @@ codegen({
119119
},
120120
messageComposer: {
121121
enabled: false
122+
},
123+
msgBuilder: {
124+
enabled: false
122125
}
123126
}
124127
}).then(() => {
@@ -252,6 +255,28 @@ cosmwasm-ts-codegen generate \
252255
| ------------------------------ | ------------------------------------------------------------------- |
253256
| `messageComposer.enabled` | enable the messageComposer plugin |
254257

258+
### Msg Builder
259+
260+
Generate raw message jsons for use in your application with the `msg-builder` command.
261+
262+
[see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
263+
264+
#### Msg Builder via CLI
265+
266+
```sh
267+
cosmwasm-ts-codegen generate \
268+
--plugin msg-builder \
269+
--schema ./schema \
270+
--out ./ts \
271+
--name MyContractName
272+
```
273+
#### Message Composer Options
274+
275+
| option | description |
276+
-------------| ------------------------------ | ------------------------------------------------------------------- |
277+
| `msgBuilder.enabled` | enable the msgBilder plugin |
278+
279+
255280
### Bundles
256281

257282
The bundler will make a nice package of all your contracts. For example:
@@ -389,6 +414,10 @@ https://gist.github.com/pyramation/a9520ccf131177b1841e02a97d7d3731
389414

390415
https://gist.github.com/pyramation/43320e8b952751a0bd5a77dbc5b601f4
391416

417+
- `cosmwasm-ts-codegen generate --plugin msg-builder`
418+
419+
https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26
420+
392421

393422
### JSON Schema
394423

packages/ts-codegen/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ The quickest and easiest way to interact with CosmWasm Contracts. `@cosmwasm/ts-
3636
- [React Query](#react-query)
3737
- [Recoil](#recoil)
3838
- [Message Composer](#message-composer)
39+
- [Msg Builder](#msg-builder)
3940
- [Bundles](#bundles)
4041
- [CLI Usage and Examples](#cli-usage-and-examples)
4142
- [Advanced Usage](#advanced-usage)
@@ -119,6 +120,9 @@ codegen({
119120
},
120121
messageComposer: {
121122
enabled: false
123+
},
124+
msgBuilder: {
125+
enabled: false
122126
}
123127
}
124128
}).then(() => {
@@ -252,6 +256,28 @@ cosmwasm-ts-codegen generate \
252256
| ------------------------------ | ------------------------------------------------------------------- |
253257
| `messageComposer.enabled` | enable the messageComposer plugin |
254258

259+
### Msg Builder
260+
261+
Generate raw message jsons for use in your application with the `msg-builder` command.
262+
263+
[see example output code](https://gist.github.com/adairrr/b394e62beb9856b0351883f776650f26)
264+
265+
#### Msg Builder via CLI
266+
267+
```sh
268+
cosmwasm-ts-codegen generate \
269+
--plugin msg-builder \
270+
--schema ./schema \
271+
--out ./ts \
272+
--name MyContractName
273+
```
274+
#### Message Composer Options
275+
276+
| option | description |
277+
-------------| ------------------------------ | ------------------------------------------------------------------- |
278+
| `msgBuilder.enabled` | enable the msgBilder plugin |
279+
280+
255281
### Bundles
256282

257283
The bundler will make a nice package of all your contracts. For example:

0 commit comments

Comments
 (0)