Skip to content

Commit

Permalink
Mind consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
0Tech committed Oct 21, 2022
1 parent 6c6a991 commit 041cb16
Showing 1 changed file with 22 additions and 23 deletions.
45 changes: 22 additions & 23 deletions x/foundation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@ back these foundation-specific functionalities.

## Authority

A foundation authority is a module account associated with the foundation and a
decision policy. It is an "administrator" which has the ability to add, remove
and update members in the foundation.
`x/foundation`'s authority is a module account associated with the foundation
and a decision policy. It is an "administrator" which has the ability to add,
remove and update members in the foundation.
`x/foundation` has several messages which cannot be triggered but by the
authority. It includes membership management messages, and other messages which
controls the assets of the foundation.
Expand Down Expand Up @@ -125,7 +125,7 @@ is submitted, and the end is defined by the decision policy.
### Withdrawing Proposals

Proposals can be withdrawn any time before the voting period end, either by the
authority or by one of the proposers. Once withdrawn, it is marked as
module's authority or by one of the proposers. Once withdrawn, it is marked as
`PROPOSAL_STATUS_WITHDRAWN`, and no more voting or execution is allowed on it.

### Aborted Proposals
Expand Down Expand Up @@ -346,7 +346,7 @@ The `MsgUpdateParams` can be used to update the parameters of `foundation`.

It's expected to fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* the parameters introduces any new foundation-specific features.

## Msg/UpdateDecisionPolicy
Expand All @@ -357,7 +357,7 @@ The `MsgUpdateDecisionPolicy` can be used to update the decision policy.

It's expected to fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* the new decision policy's `Validate()` method doesn't pass.

## Msg/UpdateMembers
Expand All @@ -371,7 +371,7 @@ its `remove` flag to true.

It's expected to fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* if the decision policy's `Validate()` method fails against the updated
membership.

Expand Down Expand Up @@ -406,15 +406,14 @@ It's expected to fail if:
## Msg/WithdrawProposal

A proposal can be withdrawn using `MsgWithdrawProposal` which has an `address`
(can be either a proposer or the authority) and a `proposal_id` (which has to
be withdrawn).
(can be either a proposer or the module's authority) and a `proposal_id` (which
has to be withdrawn).

+++ https://github.com/line/lbm-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/tx.proto#L159-L166

It's expected to fail if:

* the address is neither the x/foundation's authority nor a proposer of the
proposal.
* the address is neither the module's authority nor a proposer of the proposal.
* the proposal is already closed or aborted.

## Msg/Vote
Expand Down Expand Up @@ -453,7 +452,7 @@ new grant with the same `(grantee, Authorization)` tuple should be created.

The message handling should fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* provided `Authorization` is not implemented.
* `Authorization.MsgTypeURL()` is not defined in the router (there is no
defined handler in the app router to handle that Msg types).
Expand All @@ -468,7 +467,7 @@ A grant can be removed with the `MsgRevoke` message.

The message handling should fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* provided `MsgTypeUrl` is empty.

## Msg/FundTreasury
Expand All @@ -486,7 +485,7 @@ The foundation can withdraw coins from the treasury with

The message handling should fail if:

* the authority is not the x/foundation's authority.
* the authority is not the module's authority.
* the address which receives the coins has no authorization of
`ReceiveFromTreasuryAuthorization`.

Expand Down Expand Up @@ -940,9 +939,9 @@ The `tx` commands allow users to interact with the `foundation` module.
simd tx foundation --help
```

**Note:** Some commands must be signed by the foundation's authority, which
means you cannot broadcast the message directly. The use of those commands is
to make it easier to generate the messages by end users.
**Note:** Some commands must be signed by the module's authority, which means
you cannot broadcast the message directly. The use of those commands is to make
it easier to generate the messages by end users.

#### update-params

Expand All @@ -965,7 +964,7 @@ simd tx foundation update-params link1... \
}'
```

**Note:** The signer is the x/foundation's authority.
**Note:** The signer is the module's authority.

#### update-members

Expand All @@ -991,7 +990,7 @@ simd tx foundation update-members link1... \
]'
```

**Note:** The signer is the x/foundation's authority.
**Note:** The signer is the module's authority.

#### update-decision-policy

Expand All @@ -1016,7 +1015,7 @@ simd tx foundation update-decision-policy link1... \
}'
```

**Note:** The signer is the foundation's authority.
**Note:** The signer is the module's authority.

#### submit-proposal

Expand Down Expand Up @@ -1123,7 +1122,7 @@ simd tx foundation grant link1.. link1... \
}'
```

**Note:** The signer is the foundation's authority.
**Note:** The signer is the module's authority.

#### revoke

Expand All @@ -1139,7 +1138,7 @@ Example:
simd tx foundation revoke link1.. link1... /lbm.foundation.v1.MsgWithdrawFromTreasury
```

**Note:** The signer is the foundation's authority.
**Note:** The signer is the module's authority.

#### fund-treasury

Expand Down Expand Up @@ -1170,7 +1169,7 @@ Example:
simd tx foundation withdraw-from-treasury link1.. link1... 1000stake
```

**Note:** The signer is the foundation's authority.
**Note:** The signer is the module's authority.

## gRPC

Expand Down

0 comments on commit 041cb16

Please sign in to comment.