Skip to content

Commit

Permalink
Merge branch 'master' into feemarket-step-1
Browse files Browse the repository at this point in the history
  • Loading branch information
@amaury1093
amaury1093 committed Mar 29, 2022
2 parents 3fa9280 + 4e92b62 commit 3b76647
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 491 deletions.
1 change: 1 addition & 0 deletions x/bank/spec/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ The available permissions are:
* [ViewKeeper](02_keepers.md#viewkeeper)
3. **[Messages](03_messages.md)**
* [MsgSend](03_messages.md#msgsend)
* [MsgMultiSend](03_messages.md#msgmultisend)
4. **[Events](04_events.md)**
* [Handlers](04_events.md#handlers)
5. **[Parameters](05_params.md)**
Expand Down
186 changes: 1 addition & 185 deletions x/group/keeper/invariants.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,11 @@ import (
"github.com/cosmos/cosmos-sdk/x/group/internal/orm"
)

const (
votesInvariant = "Tally-Votes"
weightInvariant = "Group-TotalWeight"
votesSumInvariant = "Tally-Votes-Sum"
)
const weightInvariant = "Group-TotalWeight"

// RegisterInvariants registers all group invariants
func RegisterInvariants(ir sdk.InvariantRegistry, keeper Keeper) {
ir.RegisterRoute(group.ModuleName, weightInvariant, GroupTotalWeightInvariant(keeper))
ir.RegisterRoute(group.ModuleName, votesSumInvariant, TallyVotesSumInvariant(keeper))
}

// GroupTotalWeightInvariant checks that group's TotalWeight must be equal to the sum of its members.
Expand All @@ -32,15 +27,6 @@ func GroupTotalWeightInvariant(keeper Keeper) sdk.Invariant {
}
}

// TallyVotesSumInvariant checks that proposal FinalTallyResult must correspond to the vote option,
// for proposals with PROPOSAL_STATUS_CLOSED status.
func TallyVotesSumInvariant(keeper Keeper) sdk.Invariant {
return func(ctx sdk.Context) (string, bool) {
msg, broken := TallyVotesSumInvariantHelper(ctx, keeper.key, keeper.proposalTable, keeper.groupMemberTable, keeper.voteByProposalIndex, keeper.groupPolicyTable)
return sdk.FormatInvariant(group.ModuleName, votesSumInvariant, msg), broken
}
}

func GroupTotalWeightInvariantHelper(ctx sdk.Context, key storetypes.StoreKey, groupTable orm.AutoUInt64Table, groupMemberByGroupIndex orm.Index) (string, bool) {

var msg string
Expand Down Expand Up @@ -113,173 +99,3 @@ func GroupTotalWeightInvariantHelper(ctx sdk.Context, key storetypes.StoreKey, g
}
return msg, broken
}

func TallyVotesSumInvariantHelper(ctx sdk.Context, key storetypes.StoreKey, proposalTable orm.AutoUInt64Table, groupMemberTable orm.PrimaryKeyTable, voteByProposalIndex orm.Index, groupPolicyTable orm.PrimaryKeyTable) (string, bool) {
var msg string
var broken bool

proposalIt, err := proposalTable.PrefixScan(ctx.KVStore(key), 1, math.MaxUint64)
if err != nil {
msg += fmt.Sprintf("PrefixScan failure on proposal table\n%v\n", err)
return msg, broken
}
defer proposalIt.Close()

for {
var proposal group.Proposal
_, err = proposalIt.LoadNext(&proposal)
if errors.ErrORMIteratorDone.Is(err) {
break
}
if err != nil {
msg += fmt.Sprintf("LoadNext failure on proposal table iterator\n%v\n", err)
return msg, broken
}

// Only look at proposals that are closed, i.e. for which FinalTallyResult has been computed
if proposal.Status != group.PROPOSAL_STATUS_CLOSED {
continue
}

totalVotingWeight, err := groupmath.NewNonNegativeDecFromString("0")
if err != nil {
msg += fmt.Sprintf("error while parsing positive dec zero for total voting weight\n%v\n", err)
return msg, broken
}
yesVoteWeight, err := groupmath.NewNonNegativeDecFromString("0")
if err != nil {
msg += fmt.Sprintf("error while parsing positive dec zero for yes voting weight\n%v\n", err)
return msg, broken
}
noVoteWeight, err := groupmath.NewNonNegativeDecFromString("0")
if err != nil {
msg += fmt.Sprintf("error while parsing positive dec zero for no voting weight\n%v\n", err)
return msg, broken
}
abstainVoteWeight, err := groupmath.NewNonNegativeDecFromString("0")
if err != nil {
msg += fmt.Sprintf("error while parsing positive dec zero for abstain voting weight\n%v\n", err)
return msg, broken
}
vetoVoteWeight, err := groupmath.NewNonNegativeDecFromString("0")
if err != nil {
msg += fmt.Sprintf("error while parsing positive dec zero for veto voting weight\n%v\n", err)
return msg, broken
}

var groupPolicy group.GroupPolicyInfo
err = groupPolicyTable.GetOne(ctx.KVStore(key), orm.PrimaryKey(&group.GroupPolicyInfo{Address: proposal.Address}), &groupPolicy)
if err != nil {
msg += fmt.Sprintf("group policy not found for address: %s\n%v\n", proposal.Address, err)
return msg, broken
}

if proposal.GroupPolicyVersion != groupPolicy.Version {
msg += fmt.Sprintf("group policy with address %s was modified\n", groupPolicy.Address)
return msg, broken
}

voteIt, err := voteByProposalIndex.Get(ctx.KVStore(key), proposal.Id)
if err != nil {
msg += fmt.Sprintf("error while returning vote iterator for proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}
defer voteIt.Close()

for {
var vote group.Vote
_, err := voteIt.LoadNext(&vote)
if errors.ErrORMIteratorDone.Is(err) {
break
}
if err != nil {
msg += fmt.Sprintf("LoadNext failure on voteByProposalIndex index iterator\n%v\n", err)
return msg, broken
}

var groupMem group.GroupMember
err = groupMemberTable.GetOne(ctx.KVStore(key), orm.PrimaryKey(&group.GroupMember{GroupId: groupPolicy.GroupId, Member: &group.Member{Address: vote.Voter}}), &groupMem)
if err != nil {
msg += fmt.Sprintf("group member not found with group ID %d and group member %s\n%v\n", groupPolicy.GroupId, vote.Voter, err)
return msg, broken
}

curMemVotingWeight, err := groupmath.NewNonNegativeDecFromString(groupMem.Member.Weight)
if err != nil {
msg += fmt.Sprintf("error while parsing non-negative decimal for group member %s\n%v\n", groupMem.Member.Address, err)
return msg, broken
}
totalVotingWeight, err = groupmath.Add(totalVotingWeight, curMemVotingWeight)
if err != nil {
msg += fmt.Sprintf("decimal addition error while adding current member voting weight to total voting weight\n%v\n", err)
return msg, broken
}

switch vote.Option {
case group.VOTE_OPTION_YES:
yesVoteWeight, err = groupmath.Add(yesVoteWeight, curMemVotingWeight)
if err != nil {
msg += fmt.Sprintf("decimal addition error\n%v\n", err)
return msg, broken
}
case group.VOTE_OPTION_NO:
noVoteWeight, err = groupmath.Add(noVoteWeight, curMemVotingWeight)
if err != nil {
msg += fmt.Sprintf("decimal addition error\n%v\n", err)
return msg, broken
}
case group.VOTE_OPTION_ABSTAIN:
abstainVoteWeight, err = groupmath.Add(abstainVoteWeight, curMemVotingWeight)
if err != nil {
msg += fmt.Sprintf("decimal addition error\n%v\n", err)
return msg, broken
}
case group.VOTE_OPTION_NO_WITH_VETO:
vetoVoteWeight, err = groupmath.Add(vetoVoteWeight, curMemVotingWeight)
if err != nil {
msg += fmt.Sprintf("decimal addition error\n%v\n", err)
return msg, broken
}
}
}

totalProposalVotes, err := proposal.FinalTallyResult.TotalCounts()
if err != nil {
msg += fmt.Sprintf("error while getting total weighted votes of proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}
proposalYesCount, err := proposal.FinalTallyResult.GetYesCount()
if err != nil {
msg += fmt.Sprintf("error while getting the weighted sum of yes votes for proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}
proposalNoCount, err := proposal.FinalTallyResult.GetNoCount()
if err != nil {
msg += fmt.Sprintf("error while getting the weighted sum of no votes for proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}
proposalAbstainCount, err := proposal.FinalTallyResult.GetAbstainCount()
if err != nil {
msg += fmt.Sprintf("error while getting the weighted sum of abstain votes for proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}
proposalVetoCount, err := proposal.FinalTallyResult.GetNoWithVetoCount()
if err != nil {
msg += fmt.Sprintf("error while getting the weighted sum of veto votes for proposal with ID %d\n%v\n", proposal.Id, err)
return msg, broken
}

if totalProposalVotes.Cmp(totalVotingWeight) != 0 {
broken = true
msg += fmt.Sprintf("proposal FinalTallyResult must correspond to the sum of votes weights\nProposal with ID %d has total proposal votes %s, but got sum of votes weights %s\n", proposal.Id, totalProposalVotes.String(), totalVotingWeight.String())
break
}

if (yesVoteWeight.Cmp(proposalYesCount) != 0) || (noVoteWeight.Cmp(proposalNoCount) != 0) || (abstainVoteWeight.Cmp(proposalAbstainCount) != 0) || (vetoVoteWeight.Cmp(proposalVetoCount) != 0) {
broken = true
msg += fmt.Sprintf("proposal FinalTallyResult must correspond to the sum of all votes\nProposal with ID %d FinalTallyResult must correspond to the sum of all votes\n", proposal.Id)
break
}
}
return msg, broken
}

0 comments on commit 3b76647

Please sign in to comment.