Skip to content

Commit eded7bd

Browse files
authored
docs: update docs for v29 (#4576)
Closes: #4560 Added a homepage as well: ![image](https://github.com/user-attachments/assets/c3487a43-e957-421d-96dc-73292b0cf694)
1 parent 8d9618b commit eded7bd

File tree

30 files changed

+971
-1780
lines changed

30 files changed

+971
-1780
lines changed

docs/docs/01-welcome/01-index.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
slug: /
2+
slug: /welcome
33
---
44

55
import ProjectsTable from '@site/src/components/ProjectsTable';
@@ -19,18 +19,10 @@ Beyond these, Ignite has been instrumental in a wide array of blockchain applica
1919
- **CometBFT Integration:** Built with the CometBFT consensus engine (formerly Tendermint), ensuring robust consensus mechanisms in your blockchain solutions.
2020
- **Cross-Domain Applications:** Ignite is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes).
2121

22-
## Install Ignite CLI
23-
24-
Get started with Ignite CLI by running this simple installation command:
25-
26-
```
27-
curl https://get.ignite.com/cli! | bash
28-
```
29-
3022
## Embracing the Cosmos Ecosystem
3123

3224
Ignite CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK.
33-
This ecosystem is home to over [$50 billion worth of blockchain projects](https://cosmos.network/ecosystem/tokens/), showcasing the scalability and versatility of the technologies at play.
25+
This ecosystem is home to over [$100 billion worth of blockchain projects](https://cosmos.network/ecosystem/tokens/), showcasing the scalability and versatility of the technologies at play.
3426

3527
## Projects using Tendermint and Cosmos SDK
3628

docs/docs/01-welcome/02-install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Ignite CLI is supported for the following operating systems:
2323

2424
Ignite CLI is written in the Go programming language. To use Ignite CLI on a local system:
2525

26-
- Install [Go](https://golang.org/doc/install) (**version 1.23** or higher)
26+
- Install [Go](https://golang.org/doc/install) (**version 1.24** or higher)
2727
- Ensure the Go environment variables are [set properly](https://golang.org/doc/gopath_code#GOPATH) on your system
2828

2929
## Verify your Ignite CLI version

docs/docs/02-guide/02-introduction.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Introduction
66

7-
In this tutorial, we will be using Ignite CLI to create a new blockchain. Ignite
7+
In this guide, we will be using Ignite CLI to create a new blockchain. Ignite
88
CLI is a command line interface that allows users to quickly and easily create
99
blockchain networks. By using Ignite CLI, we can quickly create a new blockchain
1010
without having to manually set up all the necessary components.
@@ -14,7 +14,7 @@ directory structure and files that were created. This will give us an
1414
understanding of how the blockchain is organized and how the different
1515
components of the blockchain interact with each other.
1616

17-
By the end of this tutorial, you will have a basic understanding of how to use
17+
By the end of this guide, you will have a basic understanding of how to use
1818
Ignite CLI to create a new blockchain, and you will have a high-level
1919
understanding of the directory structure and files that make up a blockchain.
2020
This knowledge will be useful as you continue to explore the world of blockchain
@@ -115,7 +115,7 @@ automatically build and release a blockchain binary. GitHub Actions is a tool
115115
that allows developers to automate their software development workflows,
116116
including building, testing, and deploying their projects. The workflow in the
117117
`.github` directory is used to automate the process of building the blockchain
118-
binary and releasing it, which can save time and effort for developers.
118+
binary and releasing it, which can save time and effort for developers.
119119

120120
The `readme.md` file is a readme file that provides an overview of the
121121
blockchain project. This file typically includes information such as the
@@ -140,7 +140,7 @@ starts the node locally and enables automatic code reloading so that changes to
140140
the code can be reflected in the running blockchain without having to restart
141141
the node. This allows for faster development and testing of the blockchain.
142142

143-
Congratulations! 🥳 You have successfully created a brand-new Cosmos blockchain
143+
**Congratulations!** 🥳 You have successfully created a brand-new Cosmos blockchain
144144
using the Ignite CLI. This blockchain uses the delegated proof of stake (DPoS)
145145
consensus algorithm, and comes with a set of standard modules for token
146146
transfers, governance, and inflation. Now that you have a basic understanding of

docs/docs/02-guide/03-hello-world.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,22 @@ title: Hello World
77

88
**Introduction**
99

10-
In this tutorial, you'll build a simple blockchain using Ignite CLI that responds to a custom query with "Hello %s!", where "%s" is a name passed in the query.
10+
In this tutorial, you'll build a simple blockchain using Ignite CLI that responds to a custom query with `Hello %s!`, where `%s` is a name passed in the query.
1111
This will enhance your understanding of creating custom queries in a Cosmos SDK blockchain.
1212

1313
## Setup and Scaffold
1414

1515
1. **Create a New Blockchain:**
1616

17-
```bash
18-
ignite scaffold chain hello
19-
```
17+
```bash
18+
ignite scaffold chain hello
19+
```
2020

2121
2. **Navigate to the Blockchain Directory:**
2222

23-
```bash
24-
cd hello
25-
```
23+
```bash
24+
cd hello
25+
```
2626

2727
## Adding a Custom Query
2828

@@ -36,14 +36,13 @@ This command generates code for a new query, `say-hello`, which accepts a name,
3636

3737
- **Understanding the Scaffolded Code:**
3838

39-
- `proto/hello/hello/query.proto`: Defines the request and response structure.
40-
- `x/hello/client/cli/query_say_hello.go`: Contains the CLI commands for the query.
41-
- `x/hello/keeper/query_say_hello.go`: Houses the logic for the query response.
42-
39+
- `proto/hello/hello/query.proto`: Defines the request and response structure.
40+
- `x/hello/client/cli/query_say_hello.go`: Contains the CLI commands for the query.
41+
- `x/hello/keeper/query_say_hello.go`: Houses the logic for the query response.
4342

4443
## Customizing the Query Response
4544

46-
In the Cosmos SDK, queries are requests for information from the blockchain, used to access data like the ledger's current state or transaction details. While the SDK offers several built-in query methods, developers can also craft custom queries for specific data retrieval or complex operations.
45+
In the Cosmos SDK, queries are requests for information from the blockchain, used to access data like the ledger's current state or transaction details. While the SDK offers several built-in query methods, developers can also craft custom queries for specific data retrieval or complex operations.
4746

4847
- **Modify `query_say_hello.go`:**
4948

@@ -53,27 +52,27 @@ Update the `SayHello` function in `x/hello/keeper/query_say_hello.go` to return
5352
package keeper
5453

5554
import (
56-
"context"
57-
"fmt"
55+
"context"
56+
"fmt"
5857

59-
"hello/x/hello/types"
58+
"hello/x/hello/types"
6059

61-
sdk "github.com/cosmos/cosmos-sdk/types"
62-
"google.golang.org/grpc/codes"
63-
"google.golang.org/grpc/status"
60+
sdk "github.com/cosmos/cosmos-sdk/types"
61+
"google.golang.org/grpc/codes"
62+
"google.golang.org/grpc/status"
6463
)
6564

6665
func (q queryServer) SayHello(ctx context.Context, req *types.QuerySayHelloRequest) (*types.QuerySayHelloResponse, error) {
67-
if req == nil {
68-
return nil, status.Error(codes.InvalidArgument, "invalid request")
69-
}
66+
if req == nil {
67+
return nil, status.Error(codes.InvalidArgument, "invalid request")
68+
}
7069

71-
// Validation and Context unwrapping
72-
sdkCtx := sdk.UnwrapSDKContext(ctx)
70+
// Validation and Context unwrapping
71+
sdkCtx := sdk.UnwrapSDKContext(ctx)
7372

74-
_ = sdkCtx
75-
// Custom Response
76-
return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
73+
_ = sdkCtx
74+
// Custom Response
75+
return &types.QuerySayHelloResponse{Name: fmt.Sprintf("Hello %s!", req.Name)}, nil
7776
}
7877
```
7978

@@ -86,7 +85,7 @@ ignite chain serve
8685
```
8786

8887
2. **Test the Query:**
89-
88+
9089
Use the command-line interface to submit a query.
9190

9291
```
@@ -97,4 +96,4 @@ Expect a response: `Hello world!`
9796

9897
## Conclusion
9998

100-
Congratulations! 🎉 You've successfully created a blockchain module with a custom query using Ignite CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of Ignite CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.
99+
Congratulations! 🎉 You've successfully created a blockchain module with a custom query using Ignite CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of Ignite CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.

docs/docs/02-guide/07-simapp.md

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -101,64 +101,3 @@ After the parameters are scaffolded, change the
101101
`x/<module>/module_simulation.go` file to set the random parameters into the
102102
`RandomizedParams` method. The simulation will change the params randomly
103103
according to call the function.
104-
105-
## Invariants
106-
107-
Simulating a chain can help you prevent [chain invariants
108-
errors](https://docs.cosmos.network/main/building-modules/invariants). An
109-
invariant is a function called by the chain to check if something broke,
110-
invalidating the chain data. To create a new invariant and check the chain
111-
integrity, you must create a method to validate the invariants and register all
112-
invariants.
113-
114-
115-
For example, in `x/earth/keeper/invariants.go`:
116-
117-
```go title="x/earth/keeper/invariants.go"
118-
package keeper
119-
120-
import (
121-
"fmt"
122-
123-
sdk "github.com/cosmos/cosmos-sdk/types"
124-
"github.com/tendermint/spn/x/launch/types"
125-
)
126-
127-
const zeroLaunchTimestampRoute = "zero-launch-timestamp"
128-
129-
// RegisterInvariants registers all module invariants
130-
func RegisterInvariants(ir sdk.InvariantRegistry, k Keeper) {
131-
ir.RegisterRoute(types.ModuleName, zeroLaunchTimestampRoute,
132-
ZeroLaunchTimestampInvariant(k))
133-
}
134-
135-
// ZeroLaunchTimestampInvariant invariant that checks if the
136-
// `LaunchTimestamp is zero
137-
func ZeroLaunchTimestampInvariant(k Keeper) sdk.Invariant {
138-
return func(ctx sdk.Context) (string, bool) {
139-
all := k.GetAllChain(ctx)
140-
for _, chain := range all {
141-
if chain.LaunchTimestamp == 0 {
142-
return sdk.FormatInvariant(
143-
types.ModuleName, zeroLaunchTimestampRoute,
144-
"LaunchTimestamp is not set while LaunchTriggered is set",
145-
), true
146-
}
147-
}
148-
return "", false
149-
}
150-
}
151-
```
152-
153-
Now, register the keeper invariants into the `x/earth/module.go` file:
154-
155-
```go
156-
package earth
157-
158-
// ...
159-
160-
// RegisterInvariants registers the capability module's invariants.
161-
func (am AppModule) RegisterInvariants(ir sdk.InvariantRegistry) {
162-
keeper.RegisterInvariants(ir, am.keeper)
163-
}
164-
```

docs/docs/04-clients/02-typescript.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ description: Information about the generated TypeScript client code.
44

55
# TypeScript frontend
66

7+
:::warning
8+
The TypeScript client is being reworked and is not yet stable.
9+
In the meantime, refer to the [Ignite CCA App](https://ignite.com/marketplace/cca).
10+
:::
11+
712
Ignite offers powerful functionality for generating client-side code for your
813
blockchain. Think of this as a one-click client SDK generation tailored
914
specifically for your blockchain.
@@ -43,7 +48,7 @@ ignite chain serve -r
4348

4449
## Setting up a TypeScript frontend client
4550

46-
The best way to get started building with the TypeScript client is by using
51+
The best way to get started building with the TypeScript client is by using
4752
[Vite](https://vitejs.dev). Vite provides boilerplate code for
4853
vanilla TS projects as well as React, Vue, Lit, Svelte and Preact frameworks.
4954
You can find additional information at the [Vite Getting Started
@@ -365,10 +370,10 @@ transacting via Keplr like so:
365370
import { Client } from '../../ts-client';
366371

367372
const client = new Client({
368-
apiURL: "http://localhost:1317",
369-
rpcURL: "http://localhost:26657",
370-
prefix: "cosmos"
371-
}
373+
apiURL: "http://localhost:1317",
374+
rpcURL: "http://localhost:26657",
375+
prefix: "cosmos"
376+
}
372377
);
373378
await client.useKeplr();
374379
```
@@ -386,10 +391,10 @@ something like:
386391
import { Client } from '../../ts-client';
387392

388393
const client = new Client({
389-
apiURL: "http://localhost:1317",
390-
rpcURL: "http://localhost:26657",
391-
prefix: "cosmos"
392-
}
394+
apiURL: "http://localhost:1317",
395+
rpcURL: "http://localhost:26657",
396+
prefix: "cosmos"
397+
}
393398
);
394399
await client.useKeplr({
395400
chainName: 'My Great Chain',
@@ -415,10 +420,10 @@ const mnemonic =
415420
const wallet = await DirectSecp256k1HdWallet.fromMnemonic(mnemonic);
416421

417422
const client = new Client({
418-
apiURL: "http://localhost:1317",
419-
rpcURL: "http://localhost:26657",
420-
prefix: "cosmos"
421-
}
423+
apiURL: "http://localhost:1317",
424+
rpcURL: "http://localhost:26657",
425+
prefix: "cosmos"
426+
}
422427
);
423428
await client.useKeplr();
424429

docs/docs/04-clients/03-vue.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Vue frontend
22

3+
:::warning
4+
The Vue frontend is being reworked and is not yet stable.
5+
In the meantime, refer to the [Ignite CCA App](https://ignite.com/marketplace/cca).
6+
:::
7+
38
Welcome to this tutorial on using Ignite to develop a web application for your
49
blockchain with Vue 3. Ignite is a tool that simplifies the process of building
510
a blockchain application by providing a set of templates and generators that can

docs/docs/04-clients/04-react.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# React frontend
22

3+
:::warning
4+
The React frontend is being reworked and is not yet stable.
5+
In the meantime, refer to the [Ignite CCA App](https://ignite.com/marketplace/cca).
6+
:::
7+
38
Welcome to this tutorial on using Ignite to develop a web application for your
49
blockchain with React. Ignite is a tool that simplifies the process of building
510
a blockchain application by providing a set of templates and generators that can

0 commit comments

Comments
 (0)