From dc08afaeea33aa469123ab168aff910a94ab88ca Mon Sep 17 00:00:00 2001 From: julienrbrt <29894366+julienrbrt@users.noreply.github.com> Date: Thu, 3 Jul 2025 20:53:35 +0000 Subject: [PATCH] chore(docs): deploy version v29.1.0 --- .../version-v29/02-guide/04-ibc.md | 8 +- .../03-CLI-Commands/01-cli-commands.md | 139 ++++++++++++++++-- .../version-v29/04-clients/03-vue.md | 14 +- .../08-configuration/02-config_example.md | 4 +- 4 files changed, 138 insertions(+), 27 deletions(-) diff --git a/docs/versioned_docs/version-v29/02-guide/04-ibc.md b/docs/versioned_docs/version-v29/02-guide/04-ibc.md index e351f85ace..ad90c7b1b7 100644 --- a/docs/versioned_docs/version-v29/02-guide/04-ibc.md +++ b/docs/versioned_docs/version-v29/02-guide/04-ibc.md @@ -201,7 +201,7 @@ To identify the creator of the post in the receiving blockchain, add the command because it would automatically become a parameter in the `SendIbcPost` CLI command. -```protobuf title="proto/planet/blog/packet.proto" +```protobuf title="proto/planet/blog/v1/packet.proto" message IbcPostPacketData { string title = 1; string content = 2; @@ -338,6 +338,8 @@ from the packet. ```go title="x/blog/keeper/ibc_post.go" package keeper +import transfertypes "github.com/cosmos/ibc-go/v10/modules/apps/transfer/types" + func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channeltypes.Packet, data types.IbcPostPacketData, ack channeltypes.Acknowledgement) error { switch dispatchedAck := ack.Response.(type) { case *channeltypes.Acknowledgement_Error: @@ -346,7 +348,7 @@ func (k Keeper) OnAcknowledgementIbcPostPacket(ctx sdk.Context, packet channelty case *channeltypes.Acknowledgement_Result: // Decode the packet acknowledgment var packetAck types.IbcPostPacketAck - if err := types.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil { + if err := transfertypes.ModuleCdc.UnmarshalJSON(dispatchedAck.Result, &packetAck); err != nil { // The counter-party module doesn't implement the correct acknowledgment format return errors.New("cannot unmarshal acknowledgment") } @@ -410,6 +412,7 @@ The `earth.yml` and `mars.yml` files are required in the project directory: ```yaml title="earth.yml" version: 1 +validation: sovereign build: proto: path: proto @@ -438,6 +441,7 @@ validators: ```yaml title="mars.yml" version: 1 +validation: sovereign build: proto: path: proto diff --git a/docs/versioned_docs/version-v29/03-CLI-Commands/01-cli-commands.md b/docs/versioned_docs/version-v29/03-CLI-Commands/01-cli-commands.md index 2d1071db0a..66eb0ea2b5 100644 --- a/docs/versioned_docs/version-v29/03-CLI-Commands/01-cli-commands.md +++ b/docs/versioned_docs/version-v29/03-CLI-Commands/01-cli-commands.md @@ -534,6 +534,7 @@ chain. * [ignite chain faucet](#ignite-chain-faucet) - Send coins to an account * [ignite chain init](#ignite-chain-init) - Initialize your chain * [ignite chain lint](#ignite-chain-lint) - Lint codebase using golangci-lint +* [ignite chain modules](#ignite-chain-modules) - Manage modules * [ignite chain serve](#ignite-chain-serve) - Start a blockchain node in development * [ignite chain simulate](#ignite-chain-simulate) - Run simulation testing for the blockchain @@ -845,6 +846,63 @@ ignite chain lint [flags] * [ignite chain](#ignite-chain) - Build, init and start a blockchain node +## ignite chain modules + +Manage modules + +**Synopsis** + +The modules command allows you to manage modules in the codebase. + +**Options** + +``` + -h, --help help for modules +``` + +**Options inherited from parent commands** + +``` + -c, --config string path to Ignite config file (default: ./config.yml) + -y, --yes answers interactive yes/no questions with yes +``` + +**SEE ALSO** + +* [ignite chain](#ignite-chain) - Build, init and start a blockchain node +* [ignite chain modules list](#ignite-chain-modules-list) - List all Cosmos SDK modules in the app + + +## ignite chain modules list + +List all Cosmos SDK modules in the app + +**Synopsis** + +The list command lists all modules in the app. + +``` +ignite chain modules list [flags] +``` + +**Options** + +``` + -h, --help help for list +``` + +**Options inherited from parent commands** + +``` + -c, --config string path to Ignite config file (default: ./config.yml) + -y, --yes answers interactive yes/no questions with yes +``` + +**SEE ALSO** + +* [ignite chain modules](#ignite-chain-modules) - Manage modules + + ## ignite chain serve Start a blockchain node in development @@ -1029,9 +1087,9 @@ meant to be edited by hand. * [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain * [ignite generate composables](#ignite-generate-composables) - TypeScript frontend client and Vue 3 composables -* [ignite generate hooks](#ignite-generate-hooks) - TypeScript frontend client and React hooks * [ignite generate openapi](#ignite-generate-openapi) - OpenAPI spec for your chain * [ignite generate proto-go](#ignite-generate-proto-go) - Compile protocol buffer files to Go source code required by Cosmos SDK +* [ignite generate ts-client](#ignite-generate-ts-client) - TypeScript frontend client ## ignite generate composables @@ -1064,20 +1122,19 @@ ignite generate composables [flags] * [ignite generate](#ignite-generate) - Generate clients, API docs from source code -## ignite generate hooks +## ignite generate openapi -TypeScript frontend client and React hooks +OpenAPI spec for your chain ``` -ignite generate hooks [flags] +ignite generate openapi [flags] ``` **Options** ``` - -h, --help help for hooks - -o, --output string React hooks output path - -y, --yes answers interactive yes/no questions with yes + -h, --help help for openapi + -y, --yes answers interactive yes/no questions with yes ``` **Options inherited from parent commands** @@ -1094,18 +1151,18 @@ ignite generate hooks [flags] * [ignite generate](#ignite-generate) - Generate clients, API docs from source code -## ignite generate openapi +## ignite generate proto-go -OpenAPI spec for your chain +Compile protocol buffer files to Go source code required by Cosmos SDK ``` -ignite generate openapi [flags] +ignite generate proto-go [flags] ``` **Options** ``` - -h, --help help for openapi + -h, --help help for proto-go -y, --yes answers interactive yes/no questions with yes ``` @@ -1123,19 +1180,42 @@ ignite generate openapi [flags] * [ignite generate](#ignite-generate) - Generate clients, API docs from source code -## ignite generate proto-go +## ignite generate ts-client + +TypeScript frontend client + +**Synopsis** + +Generate a framework agnostic TypeScript client for your blockchain project. + +By default the TypeScript client is generated in the "ts-client/" directory. You +can customize the output directory in config.yml: + + client: + typescript: + path: new-path + +Output can also be customized by using a flag: + + ignite generate ts-client --output new-path + +TypeScript client code can be automatically regenerated on reset or source code +changes when the blockchain is started with a flag: + + ignite chain serve --generate-clients -Compile protocol buffer files to Go source code required by Cosmos SDK ``` -ignite generate proto-go [flags] +ignite generate ts-client [flags] ``` **Options** ``` - -h, --help help for proto-go - -y, --yes answers interactive yes/no questions with yes + -h, --help help for ts-client + -o, --output string TypeScript client output path + --use-cache use build cache to speed-up generation + -y, --yes answers interactive yes/no questions with yes ``` **Options inherited from parent commands** @@ -1254,6 +1334,7 @@ with an "--ibc" flag. Note that the default module is not IBC-enabled. * [ignite scaffold query](#ignite-scaffold-query) - Query for fetching data from a blockchain * [ignite scaffold single](#ignite-scaffold-single) - CRUD for data stored in a single location * [ignite scaffold type](#ignite-scaffold-type) - Type definition +* [ignite scaffold vue](#ignite-scaffold-vue) - Vue 3 web app template ## ignite scaffold chain @@ -2014,6 +2095,32 @@ ignite scaffold type NAME [field:type] ... [flags] * [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more +## ignite scaffold vue + +Vue 3 web app template + +``` +ignite scaffold vue [flags] +``` + +**Options** + +``` + -h, --help help for vue + -y, --yes answers interactive yes/no questions with yes +``` + +**Options inherited from parent commands** + +``` + -v, --verbose verbose output +``` + +**SEE ALSO** + +* [ignite scaffold](#ignite-scaffold) - Create a new blockchain, module, message, query, and more + + ## ignite testnet Simulate and manage test networks diff --git a/docs/versioned_docs/version-v29/04-clients/03-vue.md b/docs/versioned_docs/version-v29/04-clients/03-vue.md index f62f1f4e55..66f8d8fd9f 100644 --- a/docs/versioned_docs/version-v29/04-clients/03-vue.md +++ b/docs/versioned_docs/version-v29/04-clients/03-vue.md @@ -99,20 +99,22 @@ purposes, but you should not do this in production. In the `example` directory run the following command to start your blockchain: -``` +```bash ignite chain serve ``` To start your Vue application, go to the `vue` directory and run the following command in a separate terminal window: -``` -npm install && npm run dev +:::note +Make sure you have [pnpm](https://pnpm.io/) installed. +::: + +```bash +pnpm install && pnpm dev ``` -It is recommended to run `npm install` before starting your app with `npm run -dev` to ensure that all dependencies are installed (including the ones that the -API client has, see `vue/postinstall.js`). +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`). Open your browser and navigate to [http://localhost:5173/](http://localhost:5173/). diff --git a/docs/versioned_docs/version-v29/08-configuration/02-config_example.md b/docs/versioned_docs/version-v29/08-configuration/02-config_example.md index b38e49eef0..dfe2c581f5 100644 --- a/docs/versioned_docs/version-v29/08-configuration/02-config_example.md +++ b/docs/versioned_docs/version-v29/08-configuration/02-config_example.md @@ -37,8 +37,6 @@ client: # Configures client code generation. path: (string) # Relative path where the application's Typescript files are located. composables: # Configures Vue 3 composables code generation. path: (string) # Relative path where the application's composable files are located. - hooks: # Configures React hooks code generation. - path: (string) # Relative path where the application's hooks files are located. openapi: # Configures OpenAPI spec generation for the API. path: (string) # Relative path where the application's OpenAPI files are located. 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 sequence: (uint) # Sequence number of the signing account (offline mode only). sign-mode: (string) # Chooses sign mode (direct|amino-json), an advanced feature. timeout-height: (uint) # Sets a block timeout height to prevent the transaction from being committed past a certain height. -``` +``` \ No newline at end of file