Skip to content

Commit b85ac32

Browse files
chore(docs): deploy version v29.1.0 (#4755)
Co-authored-by: julienrbrt <[email protected]>
1 parent 81e5595 commit b85ac32

File tree

4 files changed

+138
-27
lines changed

4 files changed

+138
-27
lines changed

docs/versioned_docs/version-v29/02-guide/04-ibc.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ To identify the creator of the post in the receiving blockchain, add the
201201
command because it would automatically become a parameter in the `SendIbcPost`
202202
CLI command.
203203

204-
```protobuf title="proto/planet/blog/packet.proto"
204+
```protobuf title="proto/planet/blog/v1/packet.proto"
205205
message IbcPostPacketData {
206206
string title = 1;
207207
string content = 2;
@@ -338,6 +338,8 @@ from the packet.
338338
```go title="x/blog/keeper/ibc_post.go"
339339
package keeper
340340

341+
import transfertypes "github.com/cosmos/ibc-go/v10/modules/apps/transfer/types"
342+
341343
func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData, ack channeltypes.Acknowledgement) error {
342344
switch dispatchedAck := ack.Response.(type) {
343345
case *channeltypes.Acknowledgement_Error:
@@ -346,7 +348,7 @@ func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channelty
346348
case *channeltypes.Acknowledgement_Result:
347349
// Decode the packet acknowledgment
348350
var packetAck types.IbcPostPacketAck
349-
if err := types.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil {
351+
if err := transfertypes.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil {
350352
// The counter-party module doesn't implement the correct acknowledgment format
351353
return errors.New("cannot unmarshal acknowledgment")
352354
}
@@ -410,6 +412,7 @@ The `earth.yml` and `mars.yml` files are required in the project directory:
410412

411413
```yaml title="earth.yml"
412414
version: 1
415+
validation: sovereign
413416
build:
414417
proto:
415418
path: proto
@@ -438,6 +441,7 @@ validators:
438441
439442
```yaml title="mars.yml"
440443
version: 1
444+
validation: sovereign
441445
build:
442446
proto:
443447
path: proto

docs/versioned_docs/version-v29/03-CLI-Commands/01-cli-commands.md

Lines changed: 123 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -534,6 +534,7 @@ chain.
534534
* [ignite chain faucet](#ignite-chain-faucet) - Send coins to an account
535535
* [ignite chain init](#ignite-chain-init) - Initialize your chain
536536
* [ignite chain lint](#ignite-chain-lint) - Lint codebase using golangci-lint
537+
* [ignite chain modules](#ignite-chain-modules) - Manage modules
537538
* [ignite chain serve](#ignite-chain-serve) - Start a blockchain node in development
538539
* [ignite chain simulate](#ignite-chain-simulate) - Run simulation testing for the blockchain
539540

@@ -845,6 +846,63 @@ ignite chain lint [flags]
845846
* [ignite chain](#ignite-chain) - Build, init and start a blockchain node
846847

847848

849+
## ignite chain modules
850+
851+
Manage modules
852+
853+
**Synopsis**
854+
855+
The modules command allows you to manage modules in the codebase.
856+
857+
**Options**
858+
859+
```
860+
-h, --help help for modules
861+
```
862+
863+
**Options inherited from parent commands**
864+
865+
```
866+
-c, --config string path to Ignite config file (default: ./config.yml)
867+
-y, --yes answers interactive yes/no questions with yes
868+
```
869+
870+
**SEE ALSO**
871+
872+
* [ignite chain](#ignite-chain) - Build, init and start a blockchain node
873+
* [ignite chain modules list](#ignite-chain-modules-list) - List all Cosmos SDK modules in the app
874+
875+
876+
## ignite chain modules list
877+
878+
List all Cosmos SDK modules in the app
879+
880+
**Synopsis**
881+
882+
The list command lists all modules in the app.
883+
884+
```
885+
ignite chain modules list [flags]
886+
```
887+
888+
**Options**
889+
890+
```
891+
-h, --help help for list
892+
```
893+
894+
**Options inherited from parent commands**
895+
896+
```
897+
-c, --config string path to Ignite config file (default: ./config.yml)
898+
-y, --yes answers interactive yes/no questions with yes
899+
```
900+
901+
**SEE ALSO**
902+
903+
* [ignite chain modules](#ignite-chain-modules) - Manage modules
904+
905+
848906
## ignite chain serve
849907

850908
Start a blockchain node in development
@@ -1029,9 +1087,9 @@ meant to be edited by hand.
10291087

10301088
* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain
10311089
* [ignite generate composables](#ignite-generate-composables) - TypeScript frontend client and Vue 3 composables
1032-
* [ignite generate hooks](#ignite-generate-hooks) - TypeScript frontend client and React hooks
10331090
* [ignite generate openapi](#ignite-generate-openapi) - OpenAPI spec for your chain
10341091
* [ignite generate proto-go](#ignite-generate-proto-go) - Compile protocol buffer files to Go source code required by Cosmos SDK
1092+
* [ignite generate ts-client](#ignite-generate-ts-client) - TypeScript frontend client
10351093

10361094

10371095
## ignite generate composables
@@ -1064,20 +1122,19 @@ ignite generate composables [flags]
10641122
* [ignite generate](#ignite-generate) - Generate clients, API docs from source code
10651123

10661124

1067-
## ignite generate hooks
1125+
## ignite generate openapi
10681126

1069-
TypeScript frontend client and React hooks
1127+
OpenAPI spec for your chain
10701128

10711129
```
1072-
ignite generate hooks [flags]
1130+
ignite generate openapi [flags]
10731131
```
10741132

10751133
**Options**
10761134

10771135
```
1078-
-h, --help help for hooks
1079-
-o, --output string React hooks output path
1080-
-y, --yes answers interactive yes/no questions with yes
1136+
-h, --help help for openapi
1137+
-y, --yes answers interactive yes/no questions with yes
10811138
```
10821139

10831140
**Options inherited from parent commands**
@@ -1094,18 +1151,18 @@ ignite generate hooks [flags]
10941151
* [ignite generate](#ignite-generate) - Generate clients, API docs from source code
10951152

10961153

1097-
## ignite generate openapi
1154+
## ignite generate proto-go
10981155

1099-
OpenAPI spec for your chain
1156+
Compile protocol buffer files to Go source code required by Cosmos SDK
11001157

11011158
```
1102-
ignite generate openapi [flags]
1159+
ignite generate proto-go [flags]
11031160
```
11041161

11051162
**Options**
11061163

11071164
```
1108-
-h, --help help for openapi
1165+
-h, --help help for proto-go
11091166
-y, --yes answers interactive yes/no questions with yes
11101167
```
11111168

@@ -1123,19 +1180,42 @@ ignite generate openapi [flags]
11231180
* [ignite generate](#ignite-generate) - Generate clients, API docs from source code
11241181

11251182

1126-
## ignite generate proto-go
1183+
## ignite generate ts-client
1184+
1185+
TypeScript frontend client
1186+
1187+
**Synopsis**
1188+
1189+
Generate a framework agnostic TypeScript client for your blockchain project.
1190+
1191+
By default the TypeScript client is generated in the "ts-client/" directory. You
1192+
can customize the output directory in config.yml:
1193+
1194+
client:
1195+
typescript:
1196+
path: new-path
1197+
1198+
Output can also be customized by using a flag:
1199+
1200+
ignite generate ts-client --output new-path
1201+
1202+
TypeScript client code can be automatically regenerated on reset or source code
1203+
changes when the blockchain is started with a flag:
1204+
1205+
ignite chain serve --generate-clients
11271206

1128-
Compile protocol buffer files to Go source code required by Cosmos SDK
11291207

11301208
```
1131-
ignite generate proto-go [flags]
1209+
ignite generate ts-client [flags]
11321210
```
11331211

11341212
**Options**
11351213

11361214
```
1137-
-h, --help help for proto-go
1138-
-y, --yes answers interactive yes/no questions with yes
1215+
-h, --help help for ts-client
1216+
-o, --output string TypeScript client output path
1217+
--use-cache use build cache to speed-up generation
1218+
-y, --yes answers interactive yes/no questions with yes
11391219
```
11401220

11411221
**Options inherited from parent commands**
@@ -1254,6 +1334,7 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled.
12541334
* [ignite scaffold query](#ignite-scaffold-query) - Query for fetching data from a blockchain
12551335
* [ignite scaffold single](#ignite-scaffold-single) - CRUD for data stored in a single location
12561336
* [ignite scaffold type](#ignite-scaffold-type) - Type definition
1337+
* [ignite scaffold vue](#ignite-scaffold-vue) - Vue 3 web app template
12571338

12581339

12591340
## ignite scaffold chain
@@ -2014,6 +2095,32 @@ ignite scaffold type NAME [field:type] ... [flags]
20142095
* [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more
20152096

20162097

2098+
## ignite scaffold vue
2099+
2100+
Vue 3 web app template
2101+
2102+
```
2103+
ignite scaffold vue [flags]
2104+
```
2105+
2106+
**Options**
2107+
2108+
```
2109+
-h, --help help for vue
2110+
-y, --yes answers interactive yes/no questions with yes
2111+
```
2112+
2113+
**Options inherited from parent commands**
2114+
2115+
```
2116+
-v, --verbose verbose output
2117+
```
2118+
2119+
**SEE ALSO**
2120+
2121+
* [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more
2122+
2123+
20172124
## ignite testnet
20182125

20192126
Simulate and manage test networks

docs/versioned_docs/version-v29/04-clients/03-vue.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,20 +99,22 @@ purposes, but you should not do this in production.
9999

100100
In the `example` directory run the following command to start your blockchain:
101101

102-
```
102+
```bash
103103
ignite chain serve
104104
```
105105

106106
To start your Vue application, go to the `vue` directory and run the following
107107
command in a separate terminal window:
108108

109-
```
110-
npm install && npm run dev
109+
:::note
110+
Make sure you have [pnpm](https://pnpm.io/) installed.
111+
:::
112+
113+
```bash
114+
pnpm install && pnpm dev
111115
```
112116

113-
It is recommended to run `npm install` before starting your app with `npm run
114-
dev` to ensure that all dependencies are installed (including the ones that the
115-
API client has, see `vue/postinstall.js`).
117+
It is recommended to run `pnpm install` before starting your app with `pnpm dev` to ensure that all dependencies are installed (including the ones that the API client has, see `vue/postinstall.js`).
116118

117119
Open your browser and navigate to
118120
[http://localhost:5173/](http://localhost:5173/).

docs/versioned_docs/version-v29/08-configuration/02-config_example.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,6 @@ client: # Configures client code generation.
3737
path: (string) # Relative path where the application&#39;s Typescript files are located.
3838
composables: # Configures Vue 3 composables code generation.
3939
path: (string) # Relative path where the application&#39;s composable files are located.
40-
hooks: # Configures React hooks code generation.
41-
path: (string) # Relative path where the application&#39;s hooks files are located.
4240
openapi: # Configures OpenAPI spec generation for the API.
4341
path: (string) # Relative path where the application&#39;s OpenAPI files are located.
4442
genesis: (key/value) # Custom genesis block modifications. Follow the nesting of the genesis file here to access all the parameters.
@@ -86,4 +84,4 @@ validators: (list) # Contains information related to the list of validators and
8684
sequence: (uint) # Sequence number of the signing account (offline mode only).
8785
sign-mode: (string) # Chooses sign mode (direct|amino-json), an advanced feature.
8886
timeout-height: (uint) # Sets a block timeout height to prevent the transaction from being committed past a certain height.
89-
```
87+
```

0 commit comments

Comments
 (0)