Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
0Tech committed Jan 24, 2024
1 parent 2163896 commit 3c9aed8
Showing 1 changed file with 47 additions and 6 deletions.
53 changes: 47 additions & 6 deletions x/foundation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ back these foundation-specific functionalities.
## Contents

* [Concepts](#concepts)
* [Parameters](#parameters)
* [State](#state)
* [Msg Service](#msg-service)
* [Msg/UpdateParams](#msgupdateparams)
* [Msg/UpdateDecisionPolicy](#msgupdatedecisionpolicy)
* [Msg/UpdateMembers](#msgupdatemembers)
* [Msg/LeaveFoundation](#msgleavefoundation)
Expand All @@ -33,6 +33,7 @@ back these foundation-specific functionalities.
* [Msg/FundTreasury](#msgfundtreasury)
* [Msg/WithdrawFromTreasury](#msgwithdrawfromtreasury)
* [Events](#events)
* [EventUpdateFoundationParams](#eventupdatefoundationparams)
* [EventUpdateDecisionPolicy](#eventupdatedecisionpolicy)
* [EventUpdateMembers](#eventupdatedmembers)
* [EventLeaveFoundation](#eventleavefoundation)
Expand Down Expand Up @@ -269,15 +270,16 @@ The foundation can withdraw coins from the treasury. The recipient must have
the corresponding authorization (`ReceiveFromTreasuryAuthorization`) prior to
sending the message `Msg/WithdrawFromTreasury`.

# Parameters

## FoundationTax
# State

The value of `FoundationTax` is the foundation tax rate.
## Params

* FoundationTax: `sdk.Dec`
### FoundationTax

# State
* Params: `0x00 -> PropocolBuffer(Params)`.

The value of `FoundationTax` is the foundation tax rate.

## FoundationInfo

Expand Down Expand Up @@ -346,6 +348,17 @@ Authorization) tuple.

# Msg Service

## Msg/UpdateParams

The `MsgUpdateParams` can be used to update the parameters of `foundation`.

+++ https://github.com/Finschia/finschia-sdk/blob/f682f758268c19dd93958abbbaf697f51e6991b3/proto/lbm/foundation/v1/tx.proto#L62-L71

It's expected to fail if:

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

## Msg/UpdateDecisionPolicy

The `MsgUpdateDecisionPolicy` can be used to update the decision policy.
Expand Down Expand Up @@ -511,6 +524,15 @@ The message handling should fail if:

# Events

## EventUpdateFoundationParams

`EventUpdateFoundationParams` is an event emitted when the foundation
parameters have been updated.

| Attribute Key | Attribute Value |
|---------------|-----------------|
| params | {params} |

## EventUpdateDecisionPolicy

`EventUpdateDecisionPolicy` is an event emitted when the decision policy have
Expand Down Expand Up @@ -986,6 +1008,25 @@ simd tx foundation --help
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

The `update-params` command allows users to update the foundation's parameters.

```bash
simd tx foundation update-params [authority] [params-json] [flags]
```

Example:

```bash
simd tx foundation update-params link1... \
'{
"foundation_tax": "0.1"
}'
```

**Note:** The signer MUST be the module's authority.

#### update-members

The `update-members` command allows users to update the foundation's members.
Expand Down

0 comments on commit 3c9aed8

Please sign in to comment.