Skip to content

Commit 738608d

Browse files
committed
Update contract READMEs
1 parent c5f4a0d commit 738608d

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

contracts/cw20-base/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Basically, you just need to write your handle function and import
4141
`cw20_base::contract::handle_transfer`, etc and dispatch to them.
4242
This allows you to use custom `HandleMsg` and `QueryMsg` with your additional
4343
calls, but then use the underlying implementation for the standard cw20
44-
messages you want to support. The same with `QueryMsg`. You *could* reuse `init`
44+
messages you want to support. The same with `QueryMsg`. You *could* reuse `instantiate`
4545
as it, but it is likely you will want to change it. And it is rather simple.
4646

4747
Look at [`cw20-staking`](../cw20-staking/README.md) for an example of how to "inherit"

contracts/cw3-fixed-multisig/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CW3 Fixed Multisig
22

33
This is a simple implementation of the [cw3 spec](../../packages/cw3/README.md).
4-
It is a multisig with a fixed set of addresses created upon initialization.
4+
It is a multisig with a fixed set of addresses created upon instatiation.
55
Each address may have the same weight (K of N), or some may have extra voting
66
power. This works much like the native Cosmos SDK multisig, except that rather
77
than aggregating the signatures off chain and submitting the final result,
@@ -13,7 +13,7 @@ as updating the multisig set, different voting rules for the same group
1313
with different permissions, and even allow token-weighted voting. All through
1414
the same client interface.
1515

16-
## Init
16+
## Instantiation
1717

1818
To create the multisig, you must pass in a set of `HumanAddr` with a weight
1919
for each one, as well as a required weight to pass a proposal. To create
@@ -23,7 +23,7 @@ Note that 0 *is an allowed weight*. This doesn't give any voting rights, but
2323
it does allow that key to submit proposals that can later be approved by the
2424
voters. Any address not in the voter set cannot submit a proposal.
2525

26-
## Handle Process
26+
## Execution Process
2727

2828
First, a registered voter must submit a proposal. This also includes the
2929
first "Yes" vote on the proposal by the proposer. The proposer can set

contracts/cw3-flex-multisig/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Cosmos SDK multisig, is that it aggregates the signatures on chain, with
2121
visible proposals (like `x/gov` in the Cosmos SDK), rather than requiring
2222
signers to share signatures off chain.
2323

24-
## Init
24+
## Instantiation
2525

2626
The first step to create such a multisig is to instantiate a cw4 contract
2727
with the desired member set. For now, this only is supported by
@@ -31,8 +31,8 @@ with the desired member set. For now, this only is supported by
3131
If you create a `cw4-group` contract and want a multisig to be able
3232
to modify its own group, do the following in multiple transactions:
3333

34-
* init cw4-group, with your personal key as admin
35-
* init a multisig pointing to the group
34+
* instantiate cw4-group, with your personal key as admin
35+
* instantiate a multisig pointing to the group
3636
* `AddHook{multisig}` on the group contract
3737
* `UpdateAdmin{multisig}` on the group contract
3838

@@ -43,7 +43,7 @@ self-deploying contract on-chain). (TODO: document better).
4343
When creating the multisig, you must set the required weight to pass a vote
4444
as well as the max/default voting period. (TODO: allow more threshold types)
4545

46-
## Handle Process
46+
## Execution Process
4747

4848
First, a registered voter must submit a proposal. This also includes the
4949
first "Yes" vote on the proposal by the proposer. The proposer can set

contracts/cw4-stake/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ be used for voting, nor claimed by the original owner. Only after the period
2121
can you get your tokens back. This liquidity loss is the "skin in the game"
2222
provided by staking to this contract.
2323

24-
## Init
24+
## Instantiation
2525

2626
**TODO**
2727

2828
To create it, you must pass in a list of members, as well as an optional
2929
`admin`, if you wish it to be mutable.
3030

3131
```rust
32-
pub struct InitMsg {
32+
pub struct InstantiateMsg {
3333
/// denom of the token to stake
3434
pub stake: String,
3535
pub tokens_per_weight: u64,

contracts/cw721-base/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Implements:
1616
The `HandleMsg` and `QueryMsg` implementations follow the [CW721 spec](../../packages/cw721/README.md) and are described there.
1717
Beyond that, we make a few additions:
1818

19-
* `InitMsg` takes name and symbol (for metadata), as well as a **Minter** address. This is a special address that has full
19+
* `InstantiateMsg` takes name and symbol (for metadata), as well as a **Minter** address. This is a special address that has full
2020
power to mint new NFTs (but not modify existing ones)
2121
* `HandleMsg::Mint{token_id, owner, name, description, image}` - creates a new token with given owner and metadata. It can only be called by
22-
the Minter set in `init`.
22+
the Minter set in `instantiate`.
2323
* `QueryMsg::Minter{}` - returns the minter address for this contract.
2424

2525
It requires all tokens to have defined metadata in the standard format (with no extensions). For generic NFTs this may
@@ -60,7 +60,7 @@ Basically, you just need to write your handle function and import
6060
This allows you to use custom `HandleMsg` and `QueryMsg` with your additional
6161
calls, but then use the underlying implementation for the standard cw721
6262
messages you want to support. The same with `QueryMsg`. You will most
63-
likely want to write a custom, domain-specific `init`.
63+
likely want to write a custom, domain-specific `instantiate`.
6464

6565
**TODO: add example when written**
6666

0 commit comments

Comments
 (0)