Skip to content

Commit

Permalink
Fix syntax / typos
Browse files Browse the repository at this point in the history
  • Loading branch information
maurolacy committed Jan 7, 2021
1 parent dd01d05 commit 9f17171
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
6 changes: 3 additions & 3 deletions contracts/cw3-fixed-multisig/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is a simple implementation of the [cw3 spec](../../packages/cw3/README.md).
It is a multisig with a fixed set of addresses created upon initialization.
Each address may have the same weight (K of N) or some may have extra voting
Each address may have the same weight (K of N), or some may have extra voting
power. This works much like the native Cosmos SDK multisig, except that rather
than aggregating the signatures off chain and submitting the final result,
we aggregate the approvals on-chain.
Expand Down Expand Up @@ -39,7 +39,7 @@ Once a proposal is "Passed", anyone may submit an "Execute" message. This will
trigger the proposal to send all stored messages from the proposal and update
it's state to "Executed", so it cannot run again. (Note if the execution fails
for any reason - out of gas, insufficient funds, etc - the state update will
be reverted and it will remain "Passed" so you can try again).
be reverted, and it will remain "Passed", so you can try again).

Once a proposal has expired without passing, anyone can submit a "Close"
message to mark it closed. This has no effect beyond cleaning up the UI/database.
Expand All @@ -62,4 +62,4 @@ sha256sum cw3_fixed_multisig.wasm
```

Or for a production-ready (optimized) build, run a build command in the
the repository root: https://github.com/CosmWasm/cosmwasm-plus#compiling.
repository root: https://github.com/CosmWasm/cosmwasm-plus#compiling.
22 changes: 11 additions & 11 deletions contracts/cw3-flex-multisig/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# CW3 Flexible Multisig

This builds on [cw3-fixed-multisig](../cw3-fixed-multisig) with a more
This builds on [cw3-fixed-multisig](../cw3-fixed-multisig) with a more
powerful implementation of the [cw3 spec](../../packages/cw3/README.md).
It is a multisig contract that is backed by a
It is a multisig contract that is backed by a
[cw4 (group)](../../packages/cw4/README.md) contract, which independently
maintains the voter set.

This provides 2 main advantages:

* You can create two different multisigs with different voting thresholds
backed by the same group. Thus, you can have a 50% vote and a 67% vote
backed by the same group. Thus, you can have a 50% vote, and a 67% vote
that always use the same voter set, but can take other actions.
* TODO: It allows dynamic multisig groups. Since the group can change,
we can set one of the multisigs as the admin of the group contract,
and the


Besides the dynamic voting set, the main difference with the native
Cosmos SDK multisig, is that it aggregates the signatures on chain with
In addition to the dynamic voting set, the main difference with the native
Cosmos SDK multisig, is that it aggregates the signatures on chain, with
visible proposals (like `x/gov` in the Cosmos SDK), rather than requiring
signers to share signatures off chain.

Expand All @@ -26,10 +26,10 @@ signers to share signatures off chain.
The first step to create such a multisig is to instantiate a cw4 contract
with the desired member set. For now, this only is supported by
[cw4-group](../cw4-group), but we will add a token-weighted group contract
(TODO).
(TODO).

If you create a `cw4-group` contract and want a multisig to be able
to modify it's own group, do the following in multiple transactions:
to modify its own group, do the following in multiple transactions:

* init cw4-group, with your personal key as admin
* init a multisig pointing to the group
Expand All @@ -41,7 +41,7 @@ and depends on an external driver (hard to impossible to script such a
self-deploying contract on-chain). (TODO: document better).

When creating the multisig, you must set the required weight to pass a vote
as well as the max/default voting period. (TODO: allow more threshold types)
as well as the max/default voting period. (TODO: allow more threshold types)

## Handle Process

Expand All @@ -59,7 +59,7 @@ Once a proposal is "Passed", anyone may submit an "Execute" message. This will
trigger the proposal to send all stored messages from the proposal and update
it's state to "Executed", so it cannot run again. (Note if the execution fails
for any reason - out of gas, insufficient funds, etc - the state update will
be reverted and it will remain "Passed" so you can try again).
be reverted, and it will remain "Passed", so you can try again).

Once a proposal has expired without passing, anyone can submit a "Close"
message to mark it closed. This has no effect beyond cleaning up the UI/database.
Expand All @@ -72,7 +72,7 @@ open, this will calculate incorrect values (future PR).

You will need Rust 1.44.1+ with `wasm32-unknown-unknown` target installed.

You can run unit tests on this via:
You can run unit tests on this via:

`cargo test`

Expand All @@ -85,5 +85,5 @@ ls -l cw3_fixed_multisig.wasm
sha256sum cw3_fixed_multisig.wasm
```

Or for a production-ready (optimized) build, run a build command in the
Or for a production-ready (optimized) build, run a build command in
the repository root: https://github.com/CosmWasm/cosmwasm-plus#compiling.
12 changes: 6 additions & 6 deletions contracts/cw4-group/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# CW4 Group

This is a basic implementation of the [cw4 spec](../../packages/cw4/README.md).
It fufills all elements of the spec, including the raw query lookups,
and it designed to be used as a backing storage for
It fulfills all elements of the spec, including the raw query lookups,
and it designed to be used as a backing storage for
[cw3 compliant contracts](../../packages/cw3/README.md).

It stores a set of members along with an admin, and allows the admin to
update the state. Raw queries (intended for cross-contract queries)
update the state. Raw queries (intended for cross-contract queries)
can check a given member address and the total weight. Smart queries (designed
for client API) can do the same, and also query the admin address as well as
paginate over all members.
Expand Down Expand Up @@ -34,18 +34,18 @@ and stored under their `CanonicalAddr`, in a format defined in

Note that 0 *is an allowed weight*. This doesn't give any voting rights, but
it does define this address is part of the group. This could be used in
eg. a KYC whitelist to say they are allowed, but cannot participate in
e.g. a KYC whitelist to say they are allowed, but cannot participate in
decision-making.

## Messages

Basic update messages, queries, and hooks are defined by the
Basic update messages, queries, and hooks are defined by the
[cw4 spec](../../packages/cw4/README.md). Please refer to it for more info.

`cw4-group` adds one message to control the group membership:

`UpdateMembers{add, remove}` - takes a membership diff and adds/updates the
members, as well as removing any provided addresses. If an address is on both
lists, it will be removed. If it appears multiple times in `add`, only the
last occurance will be used.
last occurrence will be used.

6 changes: 3 additions & 3 deletions contracts/cw4-stake/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# CW4 Stake

This is a second implementation of the [cw4 spec](../../packages/cw4/README.md).
It fufills all elements of the spec, including the raw query lookups,
and it is designed to be used as a backing storage for
It fulfills all elements of the spec, including the raw query lookups,
and is designed to be used as a backing storage for
[cw3 compliant contracts](../../packages/cw3/README.md).

It provides a similar API to [`cw4-group`] (which handles elected membership),
but rather than appointing members (by admin or multisig), their
membership and weight is based on the number of tokens they have staked.
membership and weight are based on the number of tokens they have staked.
This is similar to many DAOs.

Only one denom can be bonded with both `min_bond` as the minimum amount
Expand Down

0 comments on commit 9f17171

Please sign in to comment.