Skip to content

Commit 6f451ee

Browse files
chore(docs): deploy version v29.3.0 (#4789)
Co-authored-by: julienrbrt <[email protected]>
1 parent 4aa6676 commit 6f451ee

File tree

3 files changed

+133
-20
lines changed

3 files changed

+133
-20
lines changed

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

Lines changed: 62 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -957,6 +957,7 @@ ignite chain serve [flags]
957957
--generate-clients generate code for the configured clients on reset or source code change
958958
-h, --help help for serve
959959
--home string directory where the blockchain node is initialized
960+
-o, --output-file string output file logging the chain output (no UI, no stdin, listens for SIGTERM, implies --yes) (default: stdout)
960961
-p, --path string path of the app (default ".")
961962
--quit-on-fail quit program if the app fails to start
962963
-r, --reset-once reset the app state once on init
@@ -2040,19 +2041,28 @@ Type definition
20402041

20412042
Type information
20422043

2043-
Currently supports:
2044-
2045-
| Type | Alias | Index | Code Type | Description |
2046-
|--------------|---------|-------|-----------|---------------------------------|
2047-
| string | - | yes | string | Text type |
2048-
| array.string | strings | no | []string | List of text type |
2049-
| bool | - | yes | bool | Boolean type |
2050-
| int | - | yes | int64 | Integer type |
2051-
| array.int | ints | no | []int64 | List of integers types |
2052-
| uint | - | yes | uint64 | Unsigned integer type |
2053-
| array.uint | uints | no | []uint64 | List of unsigned integers types |
2054-
| coin | - | no | sdk.Coin | Cosmos SDK coin type |
2055-
| array.coin | coins | no | sdk.Coins | List of Cosmos SDK coin types |
2044+
Types Usage
2045+
address use '<FIELD_NAME>:address' to scaffold string types (eg: cosmos1abcdefghijklmnopqrstuvwxyz0123456).
2046+
array.coin use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2047+
array.dec.coin use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2048+
array.int use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1).
2049+
array.string use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz).
2050+
array.uint use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40).
2051+
bool use '<FIELD_NAME>:bool' to scaffold bool types (eg: true).
2052+
bytes use '<FIELD_NAME>:bytes' to scaffold []byte types (eg: 3,2,3,5).
2053+
coin use '<FIELD_NAME>:coin' to scaffold sdk.Coin types (eg: 10token).
2054+
coins use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2055+
custom use the custom type to scaffold already created chain types.
2056+
dec.coin use '<FIELD_NAME>:dec.coin' to scaffold sdk.DecCoin types (eg: 100001token).
2057+
dec.coins use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations.
2058+
int use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111).
2059+
int64 use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111).
2060+
ints use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1).
2061+
string use '<FIELD_NAME>:string' to scaffold string types (eg: xyz).
2062+
strings use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz).
2063+
uint use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111).
2064+
uint64 use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111).
2065+
uints use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40).
20562066

20572067
Field Usage:
20582068
- fieldName
@@ -2311,3 +2321,42 @@ ignite version [flags]
23112321

23122322
* [ignite](#ignite) - Ignite CLI offers everything you need to scaffold, test, build, and launch your blockchain
23132323

2324+
# Scaffold Type
2325+
2326+
Ignites provides a set of scaffold types that can be used to generate code for your application.
2327+
These types are used in the `ignite scaffold` command.
2328+
2329+
## Available Scaffold Types
2330+
2331+
| Type | Usage |
2332+
| --- | --- |
2333+
| address | use '<FIELD_NAME>:address' to scaffold string types (eg: cosmos1abcdefghijklmnopqrstuvwxyz0123456). |
2334+
| array.coin | use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2335+
| array.dec.coin | use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2336+
| array.int | use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1). |
2337+
| array.string | use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz). |
2338+
| array.uint | use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40). |
2339+
| bool | use '<FIELD_NAME>:bool' to scaffold bool types (eg: true). |
2340+
| bytes | use '<FIELD_NAME>:bytes' to scaffold []byte types (eg: 3,2,3,5). |
2341+
| coin | use '<FIELD_NAME>:coin' to scaffold sdk.Coin types (eg: 10token). |
2342+
| coins | use '<FIELD_NAME>:array.coin' to scaffold sdk.Coins types (eg: 20stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2343+
| custom | use the custom type to scaffold already created chain types. |
2344+
| dec.coin | use '<FIELD_NAME>:dec.coin' to scaffold sdk.DecCoin types (eg: 100001token). |
2345+
| dec.coins | use '<FIELD_NAME>:array.dec.coin' to scaffold sdk.DecCoins types (eg: 20000002stake). Disclaimer: Only one `coins` or `dec.coins` field can accept multiple CLI values per command due to AutoCLI limitations. |
2346+
| int | use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111). |
2347+
| int64 | use '<FIELD_NAME>:int' to scaffold int64 types (eg: 111). |
2348+
| ints | use '<FIELD_NAME>:array.int' to scaffold []int64 types (eg: 5,4,3,2,1). |
2349+
| string | use '<FIELD_NAME>:string' to scaffold string types (eg: xyz). |
2350+
| strings | use '<FIELD_NAME>:array.string' to scaffold []string types (eg: abc,xyz). |
2351+
| uint | use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111). |
2352+
| uint64 | use '<FIELD_NAME>:uint' to scaffold uint64 types (eg: 111). |
2353+
| uints | use '<FIELD_NAME>:array.uint' to scaffold []uint64 types (eg: 13,26,31,40). |
2354+
2355+
2356+
Field Usage:
2357+
2358+
- fieldName
2359+
- fieldName:fieldType
2360+
2361+
2362+
If no :fieldType, default (string) is used

docs/versioned_docs/version-v29/04-clients/02-typescript.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
description: Information about the generated TypeScript client code.
33
---
44

5-
# TypeScript frontend
5+
# TypeScript library
66

77
Ignite offers powerful functionality for generating client-side code for your
88
blockchain. Think of this as a one-click client SDK generation tailored
@@ -35,6 +35,17 @@ SDK modules:
3535
ignite generate ts-client --clear-cache
3636
```
3737

38+
:::tip
39+
In order to not rely on the remote `buf.build` service, you can install the
40+
`protoc-gen-ts_proto` binary locally and Ignite will use it instead of the remote plugin.
41+
42+
```sh
43+
npm install -g ts-proto
44+
```
45+
46+
Learn more at <https://github.com/stephenh/ts-proto>
47+
:::
48+
3849
Run a command to start your blockchain node:
3950

4051
```

docs/versioned_docs/version-v29/08-configuration/01-config.md

Lines changed: 59 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,59 @@ to describe the development environment for your blockchain.
1414
Only a default set of parameters is provided. If more nuanced configuration is
1515
required, you can add these parameters to the `config.yml` file.
1616

17+
## Genesis
18+
19+
The genesis file is the initial block of your blockchain. It is required to launch a chain because it contains important
20+
information such as token balances and modules' state.
21+
By default, genesis is stored at `$DATA_DIR/config/genesis.json`.
22+
23+
Since the genesis file is frequently reinitialized during development, you can persistently set options using the
24+
`genesis` property in your `config.yml`:
25+
26+
```yml
27+
genesis:
28+
app_state:
29+
staking:
30+
params:
31+
bond_denom: "denom"
32+
```
33+
34+
To discover which properties the genesis file supports, initialize a chain and inspect the generated genesis file in the
35+
data directory.
36+
37+
### Overriding Genesis Parameters (e.g., chain_id, balances, etc.)
38+
39+
You may need to customize specific parameters in the genesis file, such as `chain_id`, token balances, module
40+
parameters, or custom state.
41+
42+
To override genesis values with Ignite CLI, persistently set overrides in the `genesis`property of your `config.yml`.
43+
Any YAML structure under `genesis` will be merged into the generated `genesis.json` during initialization.
44+
45+
Eg: Changing `chain_id` and `staking` parameters
46+
47+
```yml
48+
genesis:
49+
chain_id: "my-custom-chain"
50+
app_state:
51+
staking:
52+
params:
53+
bond_denom: "mytoken"
54+
bank:
55+
balances:
56+
- address: "cosmos1..."
57+
coins:
58+
- denom: "mytoken"
59+
amount: "1000000"
60+
```
61+
62+
- `chain_id`: Sets the chain ID for your blockchain.
63+
- `app_state`: Allows you to modify module states (e.g., staking, bank, etc.).
64+
65+
> ⚠️ If you set `chain_id` in the `genesis`, it will persist across `ignite chain init` or `ignite chain serve` runs.
66+
67+
The `genesis` property supports deep merging and can override any field present in the generated genesis file.
68+
For more complex setups, you can use the `include` field in `config.yml` to split overrides into multiple files.
69+
1770
## Validation
1871

1972
Ignite uses the `validation` field to determine the kind of validation
@@ -41,9 +94,9 @@ A list of user accounts created during genesis of the blockchain.
4194
```yml
4295
accounts:
4396
- name: alice
44-
coins: ['20000token', '200000000stake']
97+
coins: [ '20000token', '200000000stake' ]
4598
- name: bob
46-
coins: ['10000token', '100000000stake']
99+
coins: [ '10000token', '100000000stake' ]
47100
```
48101

49102
Ignite uses information from `accounts` when initializing the chain with `ignite
@@ -80,7 +133,7 @@ address of this key pair.
80133
```yml
81134
accounts:
82135
- name: bob
83-
coins: ['20000token', '200000000stake']
136+
coins: [ '20000token', '200000000stake' ]
84137
address: cosmos1s39200s6v4c96ml2xzuh389yxpd0guk2mzn3mz
85138
```
86139

@@ -91,7 +144,7 @@ address will be derived from a mnemonic.
91144
```yml
92145
accounts:
93146
- name: bob
94-
coins: ['20000token', '200000000stake']
147+
coins: [ '20000token', '200000000stake' ]
95148
mnemonic: cargo ramp supreme review change various throw air figure humble soft steel slam pole betray inhale already dentist enough away office apple sample glue
96149
```
97150

@@ -114,7 +167,7 @@ can use the `cointype` field to provide the integer value
114167
```yml
115168
accounts:
116169
- name: bob
117-
coins: ['20000token', '200000000stake']
170+
coins: [ '20000token', '200000000stake' ]
118171
cointype: 7777777
119172
```
120173

@@ -212,7 +265,7 @@ The faucet service sends tokens to addresses.
212265
```yml
213266
faucet:
214267
name: bob
215-
coins: ["5token", "100000stake"]
268+
coins: [ "5token", "100000stake" ]
216269
```
217270

218271
`name` refers to a key name in the `accounts` list. This is a required property.

0 commit comments

Comments
 (0)