Skip to content

Commit

Permalink
docs: update doc to reflect latest changes (#212)
Browse files Browse the repository at this point in the history
doc: update doc to reflect latest changes

[skip_ci]
  • Loading branch information
fmorency authored Aug 6, 2024
1 parent d321226 commit 8d1a5f4
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 35 deletions.
12 changes: 1 addition & 11 deletions INTEGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -217,17 +217,7 @@ app_state.slashing.params.downtime_jail_duration
600s
```

## PoA - Genesis params

The PoA module can be configured to pre-define the admin controls. One admin must be set for a valid network. If you do not yet have an admin, set the chain's governance address. (CLI: `appd q auth module-account gov`)

```json
// base + module accounts, DAOs, and multisigs are supported.
app_state.poa.params.admins
["admin1...", "admin2..."]
```

## Staking - Genesis Params
### Staking - Genesis Params

You must modify the genesis staking parameters for some other PoA configuration options.

Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ Our security policy can be found in the [SECURITY.md](./SECURITY.md) file.

## Integration

Since this module depends on x/staking, carefully read through the [Integration Guide](./INTEGRATION.md) to add it to your network. This design choice was made to allow for the PoA module to have backwards compatibility with:
Since this module depends on `x/staking`, carefully read through the [Integration Guide](./INTEGRATION.md) to add it to your network. This design choice was made to allow for the PoA module to have backwards compatibility with:
- Website UIs
- Uptime bots
- Validator scripts
- in-process multi-validator testnets

The default POA administrator is set to the `x/gov` module address. One can change the POA administrator by setting the `POA_ADMIN_ADDRESS` environment variable to a valid address. E.g.,

```bash
# Override the default PoA admin address
POA_ADMIN_ADDRESS="cosmos1hj5fveer5cjtn4wd6wstzugjfdxzl0xpxvjjvr" poad start
````

## Configuration

After integrating the PoA module into your chain, read the [network considerations](./INTEGRATION.md#network-considerations) before launching the network.
Expand Down
19 changes: 0 additions & 19 deletions simapp/proposal-params.json

This file was deleted.

4 changes: 0 additions & 4 deletions simapp/test_node.sh
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,7 @@ poad tx poa remove-pending $(poad q poa pending-validators --output=json | jq .p
# Submit via proposal (who is authority of the simapp for governance)
poad tx gov submit-proposal simapp/proposal.json --home=$HOME_DIR --from=acc1 --yes
poad tx gov submit-proposal simapp/proposal-params.json --home=$HOME_DIR --from=acc1 --yes
poad tx gov vote 1 yes --home=$HOME_DIR --from=acc1 --yes
poad q poa params
poad tx poa update-params cosmos1hj5fveer5cjtn4wd6wstzugjfdxzl0xpxvjjvr --home=$HOME_DIR --from=acc1 --yes
'


Expand Down

0 comments on commit 8d1a5f4

Please sign in to comment.