Improve the Gov Module Mechanism by BLV Labs #534

TuSoict · 2024-11-25T14:33:09Z

Spec or proposal link: https://commonwealth.im/terra-luna-classic-lunc/discussion/24630-proposal-to-improve-the-gov-module-mechanism-by-blv-labs

sidebar_position: 1

`x/gov`

Custom Governace Module Updates

Concepts

Disclaimer: This is work in progress. Mechanisms are susceptible to change.

The governance process is divided in a few steps that are outlined below:

Proposal submission: Proposal is submitted to the blockchain with a
deposit.
Vote: When the deposit for a proposal reaches a minimum threshold equivalent to
500 USD (MinUusdDeposit), proposal is confirmed and vote opens.
Execution After a period of time, the votes are tallied and depending
on the result, the messages in the proposal will be executed.

Proposal submission

Right to submit a proposal

Every account can submit proposals by sending a MsgSubmitProposal transaction.
Once a proposal is submitted, it is identified by its unique proposalID.

Proposal Messages

A proposal includes an array of sdk.Msgs which are executed automatically if the
proposal passes. The messages are executed by the governance ModuleAccount itself. Modules
such as x/upgrade, that want to allow certain messages to be executed by governance
only should add a whitelist within the respective msg server, granting the governance
module the right to execute the message once a quorum has been reached. The governance
module uses the MsgServiceRouter to check that these messages are correctly constructed
and have a respective path to execute on but do not perform a full validity check.

Deposit

To prevent spam, proposals must be submitted with a deposit in the coins defined by the equation luncMinDepositAmountBasedOnUusd = MinUusdDeposit / real-time price of LUNC at the time of proposal submission.

github.com/classic-terra/core/v3/custom/gov/keeper/proposal.go#L136-L149

The value of luncMinDepositAmountBasedOnUusd will be stored in KVStores, using a key defined as UUSDMinKeyPrefix|proposalID, where the proposal ID is appended to the prefix, represented as a single byte.

github.com/classic-terra/core/v3/custom/gov/types/keys.go#L20-L22

When a proposal is submitted, it has to be accompanied with a deposit that must be
strictly positive, but can be inferior to luncMinDepositAmountBasedOnUusd. The submitter doesn't need
to pay for the entire deposit on their own. The newly created proposal is stored in
an inactive proposal queue and stays there until its deposit passes the luncMinDepositAmountBasedOnUusd.
Other token holders can increase the proposal's deposit by sending a Deposit
transaction. If a proposal doesn't pass the luncMinDepositAmountBasedOnUusd before the deposit end time
(the time when deposits are no longer accepted), the proposal will be destroyed: the
proposal will be removed from state and the deposit will be burned (see x/gov EndBlocker).
When a proposal deposit passes the luncMinDepositAmountBasedOnUusd threshold (even during the proposal
submission) before the deposit end time, the proposal will be moved into the
active proposal queue and the voting period will begin.

The deposit is kept in escrow and held by the governance ModuleAccount until the
proposal is finalized (passed or rejected).

Deposit refund and burn

When a proposal is finalized, the coins from the deposit are either refunded or burned
according to the final tally of the proposal:

If the proposal is approved or rejected but not vetoed, each deposit will be
automatically refunded to its respective depositor (transferred from the governance
ModuleAccount).
When the proposal is vetoed with greater than 1/3, deposits will be burned from the
governance ModuleAccount and the proposal information along with its deposit
information will be removed from state.
All refunded or burned deposits are removed from the state. Events are issued when
burning or refunding a deposit.

Vote

Voting period

Once a proposal reaches luncMinDepositAmountBasedOnUusd, it immediately enters Voting period. We
define Voting period as the interval between the moment the vote opens and
the moment the vote closes. Voting period should always be shorter than
Unbonding period to prevent double voting. The initial value of
Voting period is 2 weeks.

Stores

:::note
Stores are KVStores in the multi-store. The key to find the store is the first parameter in the list
:::
We will use one KVStore Governance to store five mappings:

A mapping from proposalID|'proposal' to Proposal.
A mapping from proposalID|'addresses'|address to Vote. This mapping allows
us to query all addresses that voted on the proposal along with their vote by
doing a range query on proposalID:addresses.
A mapping from ParamsKey|'Params' to Params. This map allows to query all
x/gov params.
A mapping from VotingPeriodProposalKeyPrefix|proposalID to a single byte. This allows
us to know if a proposal is in the voting period or not with very low gas cost.
A mapping from UUSDMinKeyPrefix|proposalID to a single byte. This allows us to determine the minimum amount of LUNC that a specific proposal must deposit to pass the deposit phase.

For pseudocode purposes, here are the two function we will use to read or write in stores:

load(StoreKey, Key): Retrieve item stored at key Key in store found at key StoreKey in the multistore
store(StoreKey, Key, value): Write value Value at key Key in store found at key StoreKey in the multistore

Parameters

The governance module contains the following parameters:

Key	Type	Example
min_deposit	array (coins)	[{"denom":"uatom","amount":"10000000"}]
max_deposit_period	string (time ns)	"172800000000000" (17280s)
voting_period	string (time ns)	"172800000000000" (17280s)
quorum	string (dec)	"0.334000000000000000"
threshold	string (dec)	"0.500000000000000000"
veto	string (dec)	"0.334000000000000000"
burn_proposal_deposit_prevote	bool	false
burn_vote_quorum	bool	false
burn_vote_veto	bool	true
min_uusd_deposit	coins	{"denom":"uusd","amount":"500000"}
Currently, the default value of `min_uusd_deposit` is set to `500` usd, but this value can be
updated by the community in the future.

Client

CLI

A user can query and interact with the gov module using the CLI.
We have added two new commands

MinimalDeposit

The MinimalDeposit command enables users to query the minimum LUNC deposit required for a specific proposal, calculated based on the UUSD value.

terrad q gov min-deposit [proposal-id]

Example:

terrad q gov min-deposit 1 cosmos1..

CustomParams

The CustomParams command allows users to query the custom parameters of the module.

terrad q gov custom-params

Example:

terrad q gov custom-params

Future Improvements

We have successfully upgraded the chain by increasing the consensus version to 5. Moving forward,
should the community require updates related to these matters, the BLV Team will be available to
assist with the implementation process.

…lvlabs/dev

in the SubmitProposal function: - Get LUNC price based on UUSD - Calculate the amount of LUNC to send for the proposal during that time - Store the LUNC amount

…odule

…/gov-improve # Conflicts: # custom/gov/keeper/params.go # custom/gov/keeper/proposal.go # custom/gov/types/v2lunc1/query.pb.go

…/gov-improve # Conflicts: # custom/gov/keeper/params.go # custom/gov/types/v2lunc1/query.pb.go

add get min-deposit if get min deposit not exists

…in init_test.go

add logic get uusd

mergify · 2024-11-25T14:33:44Z

⚠️ The sha of the head commit of this PR conflicts with #529. Mergify cannot evaluate rules on this PR. ⚠️

…-v8.4

custom/gov/keeper/test_utils.go

+
+	db := dbm.NewMemDB()
+	ms := store.NewCommitMultiStore(db)
+	ctx := sdk.NewContext(ms, tmproto.Header{Time: time.Now().UTC()}, false, log.NewNopLogger())


StrathCole

I did not conduct a deep review or approval-review. This is just to show up some blocking things to merge this into the branch for testnet deployment.

StrathCole · 2024-11-25T15:36:01Z

app/app.go

@@ -94,6 +95,7 @@ var (
 		v8_1.Upgrade,
 		v8_2.Upgrade,
 		v8_3.Upgrade,
+		v8_4.Upgrade,


Need to change to v10_1 as the current prepared release will use v10

StrathCole · 2024-11-28T15:32:08Z

cmd/terrad/testnet.go

@@ -309,7 +309,7 @@ func initGenFiles(
 	appGenState[banktypes.ModuleName] = clientCtx.Codec.MustMarshalJSON(&bankGenState)

 	// set gov in the genesis state
-	var govGenState govv1.GenesisState
+	var govGenState govv2lunc1.GenesisState


please avoid namings like "lunc" in types, if you want to use something non-generic, you might use "terra" or similar

StrathCole · 2024-11-28T15:33:06Z

custom/auth/ante/min_initial_deposit.go

-		return fmt.Errorf("not enough initial deposit provided. Expected %q; got %q", requiredDepositCoins, initialDepositCoins)
+	// set offset price change 3%
+	offsetPrice := sdk.NewDecWithPrec(97, 2)
+	minLuncAmount, err := govKeeper.GetMinimumDepositBaseUusd(ctx)


Please to not use "Lunc" in variables. The denom would be "minUlunaAmount" if you want to include the denom in the variable name. Lunc would not be the microunit.

StrathCole · 2024-11-28T15:34:53Z

custom/gov/keeper/grpc_query.go

+}
+
+// ProposalMinimalLUNCByUusd returns min Usd amount proposal needs to deposit
+func (q queryServer) ProposalMinimalLUNCByUusd(ctx context.Context, req *v2lunc1.QueryProposalRequest) (*v2lunc1.QueryMinimalDepositProposalResponse, error) {


The naming is misleading. It's not uusd that is configured but US Dollar. uusd is the denom for "USTC" on chain.

StrathCole · 2024-11-28T15:35:20Z

custom/gov/keeper/keeper.go

+}
+
+// GetDepositLimitBaseUusd: calculate the minimum LUNC amount to deposit base on Uusd for the proposal
+func (keeper Keeper) GetMinimumDepositBaseUusd(ctx sdk.Context) (math.Int, error) {


Same as above. Uusd is misleading.

StrathCole · 2024-11-28T15:39:07Z

custom/gov/types/v2lunc1/codec.go

+// governance module.
+func RegisterLegacyAminoCodec(cdc *codec.LegacyAmino) {
+	legacy.RegisterAminoMsg(cdc, &govv1.MsgSubmitProposal{}, "cosmos-sdk/v1/MsgSubmitProposal")
+	legacy.RegisterAminoMsg(cdc, &govv1.MsgDeposit{}, "cosmos-sdk/v1/MsgDeposit")


This will break classic legacy handling.

TuSoict and others added 30 commits September 29, 2024 20:45

[tutm][Proposal1][initialize]: added note props#1 file

cff38ea

add new param, custom module gov

a92ee1b

add proto

ee4aa1a

Merge commit 'ee4aa1a1b867660050d89d924802aeff99312988' into origin/b…

5af0ad2

…lvlabs/dev

generated pb.go files

02fc71c

added value in 500$ for param: minUusdDeposit

062774b

added TotalDepositKey func

03990d2

Implemented a logic:

4e366a6

in the SubmitProposal function: - Get LUNC price based on UUSD - Calculate the amount of LUNC to send for the proposal during that time - Store the LUNC amount

Updated the converting logic in SubmitProposal Func

9b22f54

marshall amount before store in SetPriceLuncBaseUusd func

22141bd

Handle the CheckLimitlDeposit rule in AddDeposit func:

6d7fa29

Updated the HandleCheckMinInitialDeposit logic in ante of auth module

b80170f

Overided keeper instance in keeper.go (gov module)

76927b6

chang proto

2badfc1

Overided keeper instance in keeper.go (gov module)

e26da00

add get query cmd

f63eefb

move gov types to v2lunc1

b422289

update types the HandleCheckMinInitialDeposit logic in ante of auth m…

5e4b632

…odule

move gov types to v2lunc1

562e610

Merge commit 'b422289350edcdd7fcb55e6cb55badba6de5f74e' into blv-labs…

7df5045

…/gov-improve # Conflicts: # custom/gov/keeper/params.go # custom/gov/keeper/proposal.go # custom/gov/types/v2lunc1/query.pb.go

Merge commit '562e6101037a665964ae29f5b5e80e0a50ddf568' into blv-labs…

d1213e8

…/gov-improve # Conflicts: # custom/gov/keeper/params.go # custom/gov/types/v2lunc1/query.pb.go

Updated a logic in genesis module

435086a

Fixed types in MinInitialDeposit.go

c7429a4

add keys_test.go (unitest for keys.go)

869d296

Completed migrate from version 4 to 5.

eeef11a

added missing file

5bf6106

Merge branch 'blv-labs/gov-improve' into blv-labs/gov-unitest

a4cc750

Update codec & fix config test

fb0f953

Done min_initial_deposit_test.go

a749a91

Done Genesis_test.go

f8a724e

TuSoict and others added 22 commits October 28, 2024 06:44

Review, clean and fix some bugs

eb941ca

revert register distribution codec

9e52573

add get min-deposit if get min deposit not exists

update scripts, logic get min deposit

6e0cf5e

added script for intergration testing

a5ae5fa

review and clean code

68f6d12

added README.md for custom gov module

36a1f6e

revert register code from gov in others module

3914bc8

Review and clean code (if needed)

6035640

fixed checking rule: MinInitialDeposit in ante of auth module

bec6d63

removed unused import in proto files

e957bfa

Fixed error (unknown field "min_uusd_deposit" in v1.Params) e2e test …

a7ad120

…in init_test.go

fixed bugs when build & Test / liveness-test in testnet.go

6e3a28c

fixed golangci-lint-Related Bugs

30c7ccc

removed .history files

0832c67

add logic get uusd

4cd9346

fix lint

ae8d370

Merge pull request #2 from BLV-Labs/fix/get-uusd-price

2f33b29

add logic get uusd

fix generate address by order

d780c04

Deleted useless file to clean code

4c44c75

added offset buffet to reduce limit initial deposit when creating prop

7955ba0

Updated unitest

2f1168f

update uusd amount

69c5019

Merge branch 'blv/gov' into blv-labs/optimize-calculation-deposit-gov…

71143d8

…-v8.4

mergify bot mentioned this pull request Nov 25, 2024

Improve the Gov Module Mechanism by BLV Labs #529

Open

github-advanced-security bot found potential problems Nov 25, 2024

View reviewed changes

StrathCole reviewed Nov 28, 2024

View reviewed changes

duonghb53 force-pushed the blv-labs/optimize-calculation-deposit-gov-v8.4 branch from beaf7dc to d26e250 Compare November 29, 2024 02:17

resolve comment

43ef592

duonghb53 force-pushed the blv-labs/optimize-calculation-deposit-gov-v8.4 branch from d26e250 to 43ef592 Compare November 29, 2024 03:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the Gov Module Mechanism by BLV Labs #534

Improve the Gov Module Mechanism by BLV Labs #534

TuSoict commented Nov 25, 2024

mergify bot commented Nov 25, 2024

StrathCole left a comment

StrathCole Nov 25, 2024

StrathCole Nov 28, 2024

StrathCole Nov 28, 2024

StrathCole Nov 28, 2024

StrathCole Nov 28, 2024

StrathCole Nov 28, 2024

Improve the Gov Module Mechanism by BLV Labs #534

Are you sure you want to change the base?

Improve the Gov Module Mechanism by BLV Labs #534

Conversation

TuSoict commented Nov 25, 2024

sidebar_position: 1

x/gov

Custom Governace Module Updates

Concepts

Proposal submission

Right to submit a proposal

Proposal Messages

Deposit

Deposit refund and burn

Vote

Voting period

Stores

Parameters

Client

CLI

MinimalDeposit

CustomParams

Future Improvements

mergify bot commented Nov 25, 2024

StrathCole left a comment

Choose a reason for hiding this comment

StrathCole Nov 25, 2024

Choose a reason for hiding this comment

StrathCole Nov 28, 2024

Choose a reason for hiding this comment

StrathCole Nov 28, 2024

Choose a reason for hiding this comment

StrathCole Nov 28, 2024

Choose a reason for hiding this comment

StrathCole Nov 28, 2024

Choose a reason for hiding this comment

StrathCole Nov 28, 2024

Choose a reason for hiding this comment

`x/gov`