Skip to content

Commit

Permalink
docs: update links in x/foundation README.md (Finschia#1120)
Browse files Browse the repository at this point in the history
* Update README.md

* Update CHANGELOG.md
  • Loading branch information
0Tech authored and jaeseung-bae committed May 7, 2024
1 parent 75b473f commit c882e72
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Improvements
* (types) [\#1314](https://github.com/Finschia/finschia-sdk/pull/1314) replace IsEqual with Equal
* (docs) [\#1120](https://github.com/Finschia/finschia-sdk/pull/1120) Update links in x/foundation README.md

### Bug Fixes
* (x/auth) [#1281](https://github.com/Finschia/finschia-sdk/pull/1281) `ModuleAccount.Validate` now reports a nil `.BaseAccount` instead of panicking. (backport #1274)
Expand Down Expand Up @@ -74,4 +75,4 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Document Updates
* (x/token,collection) [#1201](https://github.com/Finschia/finschia-sdk/pull/1201) Deprecate legacy features on x/token,collection
* (docs) [\#1059](https://github.com/Finschia/finschia-sdk/pull/1059) create ERRORS.md for x/module
* (docs) [\#1059](https://github.com/Finschia/finschia-sdk/pull/1059) create ERRORS.md for x/module
13 changes: 7 additions & 6 deletions x/foundation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,6 @@ threshold and percentage. Any chain developer can extend upon these two, by
creating custom decision policies, as long as they adhere to the
`DecisionPolicy` interface:

+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/x/foundation/foundation.go#L90-L103
+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/x/foundation/foundation.go#L90-L103

### Threshold decision policy
Expand All @@ -93,6 +92,8 @@ A threshold decision policy defines a threshold of yes votes (based on a tally
of voter weights) that must be achieved in order for a proposal to pass. For
this decision policy, abstain and veto are simply treated as no's.

+++ https://github.com/Finschia/finschia-sdk/blob/ba75f8e7845a740afdce6e5f1c91f1a97433b7e2/proto/lbm/foundation/v1/foundation.proto#L63-L77

### Percentage decision policy

A percentage decision policy is similar to a threshold decision policy, except
Expand All @@ -101,13 +102,17 @@ It's more suited for a foundation where the membership can be updated, as the
percentage threshold stays the same, and doesn't depend on how the number of
members get updated.

+++ https://github.com/Finschia/finschia-sdk/blob/ba75f8e7845a740afdce6e5f1c91f1a97433b7e2/proto/lbm/foundation/v1/foundation.proto#L79-L93

### Outsourcing decision policy

A outsourcing decision policy is a policy set after `x/foundation` decides to
outsource its proposal relevant features to other modules (e.g. `x/group`).
It means one can expect that any states relevant to the feature must be removed
in the update to this policy.

+++ https://github.com/Finschia/finschia-sdk/blob/ba75f8e7845a740afdce6e5f1c91f1a97433b7e2/proto/lbm/foundation/v1/foundation.proto#L115-L121

## Proposal

Any foundation member(s) can submit a proposal for the foundation policy
Expand Down Expand Up @@ -243,8 +248,6 @@ the [Msg/WithdrawFromTreasury](#msgwithdrawfromtreasury).

+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/foundation/v1/authz.proto#L9-L13

+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/x/foundation/authz.pb.go#L27-L30

### CreateValidatorAuthorization

`CreateValidatorAuthorization` implements the `Authorization` interface for the
Expand All @@ -257,8 +260,6 @@ url of `Msg/CreateValidator`), or the chain cannot be started.

+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/proto/lbm/stakingplus/v1/authz.proto#L9-L15

+++ https://github.com/Finschia/finschia-sdk/blob/392277a33519d289154e8da27f05f9a6788ab076/x/stakingplus/authz.pb.go#L27-L31

## Foundation Treasury

`x/foundation` intercepts the rewards prior to its distribution
Expand Down Expand Up @@ -451,7 +452,7 @@ The authority of the following modules are candidates of censorship authority:

One may specify `CENSORSHIP_AUTHORITY_UNSPECIFIED` to remove the censorship.

+++ https://github.com/Finschia/finschia-sdk/blob/d9428ec5d825dfd9964f510e32bd03a01adade8c/proto/lbm/foundation/v1/tx.proto#L25-L34
+++ https://github.com/Finschia/finschia-sdk/blob/d9428ec5d825dfd9964f510e32bd03a01adade8c/proto/lbm/foundation/v1/foundation.proto#L26-L35

The message handling should fail if:

Expand Down

0 comments on commit c882e72

Please sign in to comment.