Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bekauz committed Nov 17, 2023
1 parent 6cc08c6 commit 6f46e8a
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions contracts/proposal/dao-proposal-single/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,49 @@ handling a hook.
The proposals may be configured to allow revoting.
In such cases, users are able to change their vote as long as the proposal is still open.
Revoting for the currently cast option will return an error.

## Veto

Proposals may be configured with an optional `Timelock` - a configuration describing
the veto flow.

Timelock period enables an oversight committee to hold the main DAO accountable
by vetoing proposals during (and potentially before entering into) the timelock
period.

No actions from DAO members are allowed during the timelock period.

After the timelock expires, the proposal can be executed normally.

Timelock contains the following fields:

### `delay`

Delay (`cw_utils::Duration`) describes the duration of timelock in blocks
or seconds.

It comes into effect when a proposal is passed. The delay duration is then
added to the current block time/height to get `Expiration` to be used for
the new proposal state of `Timelocked { expiration: Expiration}`.

If the vetoer address is another DAO, this duration should be carefully
considered because of the DAO voting period.

### `vetoer`

Vetoer (`String`) is the address allowed to veto the proposals that are in
`Timelocked` state.

Vetoer address can be updated via a regular proposal config update.

### `early_execute`

Early execute (`bool`) is a flag used to indicate whether the vetoer can
execute the proposals before the timelock period is expired. The proposals
still need to be passed and in the `Timelock` state in order for this to
be possible.

### `veto_before_passed`

Veto before passed (`bool`) is a flag used to indicate whether the vetoer
can veto a proposal before it passes.

0 comments on commit 6f46e8a

Please sign in to comment.