feat!: PSS enable per-consumer chain commission #1657
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,7 +6,7 @@ import ( | |
| "cosmossdk.io/math" | ||
| abci "github.com/cometbft/cometbft/abci/types" | ||
| "github.com/cometbft/cometbft/libs/bytes" | ||
| distrtypes "github.com/cosmos/cosmos-sdk/x/distribution/types" | ||
| transfertypes "github.com/cosmos/ibc-go/v7/modules/apps/transfer/types" | ||
| clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types" | ||
| channeltypes "github.com/cosmos/ibc-go/v7/modules/core/04-channel/types" | ||
|
|
@@ -575,7 +575,7 @@ func (s *CCVTestSuite) TestIBCTransferMiddleware() { | |
| bankKeeper := s.providerApp.GetTestBankKeeper() | ||
| amount := sdk.NewInt(100) | ||
|
|
||
| data = transfertypes.NewFungibleTokenPacketData( // can be explicitly changed in setup | ||
| sdk.DefaultBondDenom, | ||
| amount.String(), | ||
| authtypes.NewModuleAddress(consumertypes.ConsumerToSendToProviderName).String(), | ||
|
|
@@ -734,11 +734,11 @@ func (s *CCVTestSuite) TestAllocateTokens() { | |
| perValExpReward := validatorsExpRewards.QuoDec(sdk.NewDec(int64(valNum))) | ||
|
|
||
| // verify the validator tokens allocation | ||
| // note that the validators have the same voting power to keep things simple | ||
| for _, val := range s.providerChain.Vals.Validators { | ||
| valRewards := distributionKeeper.GetValidatorOutstandingRewards(s.providerCtx(), sdk.ValAddress(val.Address)) | ||
| s.Require().Equal( | ||
| valRewards.Rewards, | ||
| lastValOutRewards[sdk.ValAddress(val.Address).String()].Add(perValExpReward...), | ||
| ) | ||
| } | ||
|
|
@@ -902,80 +902,129 @@ func (s *CCVTestSuite) prepareRewardDist() { | |
| } | ||
|
|
||
| func (s *CCVTestSuite) TestAllocateTokensToValidator() { | ||
| providerKeeper := s.providerApp.GetProviderKeeper() | ||
| distributionKeeper := s.providerApp.GetTestDistributionKeeper() | ||
| bankKeeper := s.providerApp.GetTestBankKeeper() | ||
|
|
||
| chainID := "consumer" | ||
| validators := []bytes.HexBytes{ | ||
| s.providerChain.Vals.Validators[0].Address, | ||
| s.providerChain.Vals.Validators[1].Address, | ||
| } | ||
| votes := []abci.VoteInfo{ | ||
| {Validator: abci.Validator{Address: validators[0], Power: 1}}, | ||
| {Validator: abci.Validator{Address: validators[1], Power: 1}}, | ||
| } | ||
|
|
||
| testCases := []struct { | ||
| name string | ||
| votes []abci.VoteInfo | ||
| tokens sdk.DecCoins | ||
| expAllocated sdk.DecCoins | ||
| }{ | ||
| { | ||
| name: "tokens are empty", | ||
| }, | ||
| { | ||
| name: "total voting power is zero", | ||
| tokens: sdk.DecCoins{sdk.NewDecCoin(sdk.DefaultBondDenom, math.NewInt(100_000))}, | ||
| expAllocated: nil, | ||
| }, | ||
| { | ||
| name: "expect all tokens to be allocated to a single validator", | ||
| votes: []abci.VoteInfo{votes[0]}, | ||
| tokens: sdk.DecCoins{sdk.NewDecCoin(sdk.DefaultBondDenom, math.NewInt(999))}, | ||
|
There was a problem hiding this comment. Why are the There was a problem hiding this comment. Because both |
||
| expAllocated: sdk.DecCoins{sdk.NewDecCoin(sdk.DefaultBondDenom, math.NewInt(999))}, | ||
| }, | ||
| { | ||
| name: "expect tokens to be allocated evenly between validators", | ||
| votes: []abci.VoteInfo{votes[0], votes[1]}, | ||
| tokens: sdk.DecCoins{sdk.NewDecCoinFromDec(sdk.DefaultBondDenom, math.LegacyNewDecFromIntWithPrec(math.NewInt(999), 3))}, | ||
| expAllocated: sdk.DecCoins{sdk.NewDecCoinFromDec(sdk.DefaultBondDenom, math.LegacyNewDecFromIntWithPrec(math.NewInt(999), 3))}, | ||
| }, | ||
| } | ||
|
|
||
| // opt the validators in to verify that they charge | ||
| // to their delegators the custom commission for the consumer chain | ||
| for _, v := range s.providerChain.Vals.Validators { | ||
| consAddr := sdk.ConsAddress(v.Address) | ||
| provAddr := providertypes.NewProviderConsAddress(consAddr) | ||
|
|
||
| val, found := s.providerApp.GetTestStakingKeeper().GetValidatorByConsAddr(s.providerCtx(), consAddr) | ||
| s.Require().True(found) | ||
|
|
||
| // check that no commission is set for the validator | ||
| s.Require().Equal(val.Commission.Rate, math.LegacyZeroDec()) | ||
|
|
||
| // set a custom commission of 100% | ||
| providerKeeper.SetConsumerCommissionRate( | ||
| s.providerCtx(), | ||
| chainID, | ||
| provAddr, | ||
| sdk.OneDec(), | ||
|
There was a problem hiding this comment. Would it make sense to test something besides 100% commission rate here? There was a problem hiding this comment. Good point. Addressed here. |
||
| ) | ||
|
|
||
| } | ||
|
|
||
| for _, tc := range testCases { | ||
| s.Run(tc.name, func() { | ||
| // TODO: opt validators in and verify | ||
| // that rewards are only allocated to them | ||
| ctx, _ := s.providerCtx().CacheContext() | ||
|
|
||
| // allocate tokens | ||
| res := providerKeeper.AllocateTokensToConsumerValidators( | ||
| ctx, | ||
| chainID, | ||
| tc.votes, | ||
| tc.tokens, | ||
| ) | ||
|
|
||
| // check that the expected result is returned | ||
| s.Require().Equal(tc.expAllocated, res) | ||
|
|
||
| if !tc.expAllocated.Empty() { | ||
| // rewards are expected to be allocated evenly between validators | ||
| rewardsPerVal := tc.expAllocated.QuoDec(sdk.NewDec(int64(len(tc.votes)))) | ||
|
|
||
| // check that the rewards are allocated to validators | ||
| for _, v := range tc.votes { | ||
| valAddr := sdk.ValAddress(v.Validator.Address) | ||
| rewards := s.providerApp.GetTestDistributionKeeper().GetValidatorOutstandingRewards( | ||
| ctx, | ||
| valAddr, | ||
| ) | ||
| s.Require().Equal(rewardsPerVal, rewards.Rewards) | ||
|
|
||
| // send tokens to the distribution module to allow the rewards withdrawing | ||
| valRewardsTrunc, _ := rewards.Rewards.TruncateDecimal() | ||
| err := bankKeeper.SendCoinsFromAccountToModule( | ||
| ctx, | ||
| s.providerChain.SenderAccount.GetAddress(), | ||
| distrtypes.ModuleName, | ||
| valRewardsTrunc) | ||
| s.Require().NoError(err) | ||
|
|
||
| // check that validators can withdraw their rewards | ||
| withdrawnCoins, err := distributionKeeper.WithdrawValidatorCommission( | ||
| ctx, | ||
| valAddr, | ||
| ) | ||
| s.Require().NoError(err) | ||
|
|
||
| // check that the withdrawn coins is equal to the entire reward amount | ||
| s.Require().Equal(withdrawnCoins, valRewardsTrunc) | ||
| } | ||
| } else { | ||
| for _, v := range tc.votes { | ||
| valAddr := sdk.ValAddress(v.Validator.Address) | ||
| rewards := s.providerApp.GetTestDistributionKeeper().GetValidatorOutstandingRewards( | ||
| ctx, | ||
| valAddr, | ||
| ) | ||
| s.Require().Zero(rewards.Rewards) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not have
expAllocated: nilsimilar to the next test case?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Omitted fields in structs are zero-valued, so
expAllocatedis set tonil.