Mukan Erkin Törük
26b204bd04
Some checks are pending
Docs Deploy / build_and_deploy (push) Waiting to run
Generate Docs / cli (push) Waiting to run
Generate Config Doc / cli (push) Waiting to run
Go formatting / go-formatting (push) Waiting to run
Check links / markdown-link-check (push) Waiting to run
Integration / pre-test (push) Waiting to run
Integration / test on (push) Blocked by required conditions
Integration / status (push) Blocked by required conditions
Lint / Lint Go code (push) Waiting to run
Test / test (ubuntu-latest) (push) Waiting to run
31 lines
1.4 KiB
Markdown
31 lines
1.4 KiB
Markdown
---
|
|
sidebar_position: 12
|
|
description: Scaffold module parameters to be accessible to the module.
|
|
---
|
|
|
|
# Module parameters
|
|
|
|
Sometimes you need to set default parameters for a module. The Cosmos SDK [params package](https://docs.cosmos.network/main/modules/params) provides a globally available parameter that is saved into the key-value store.
|
|
|
|
Params are managed and centralized by the Cosmos SDK `params` module and are updated with a governance proposal.
|
|
|
|
You can use Ignite CLI to scaffold parameters to be accessible for the module. Parameters have default values that can be changed when the chain is live. Since the parameters are managed and centralized by the Cosmos SDK params module, they can be easily updated using a governance proposal.
|
|
|
|
To scaffold a module with params using the `--params` flag:
|
|
|
|
```bash
|
|
ignite scaffold module launch --params minLaunch:uint,maxLaunch:int
|
|
```
|
|
|
|
After the parameters are scaffolded, change the `x/<module>/types/params.go` file to set the default values and validate the fields.
|
|
|
|
The params module supports all [built-in Ignite CLI types](./05-types.md).
|
|
|
|
## Params types
|
|
|
|
| Type | Code type | Description |
|
|
| ------ | --------- | ----------------------- |
|
|
| string | string | Text type |
|
|
| bool | bool | Boolean type |
|
|
| int | int32 | Integer number |
|
|
| uint | uint64 | Unsigned integer number |
|