f5b11bc328
<!-- The default pull request template is for types feat, fix, or refactor. For other templates, add one of the following parameters to the url: - template=docs.md - template=other.md --> ## Description - Adds error handling for staking hooks <!-- Add a description of the changes that this PR introduces and the files that are the most critical to review. --> --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [x] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [x] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
122 lines
3.7 KiB
Go
122 lines
3.7 KiB
Go
package keeper
|
|
|
|
import (
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
"github.com/cosmos/cosmos-sdk/x/distribution/types"
|
|
stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
|
|
)
|
|
|
|
// Wrapper struct
|
|
type Hooks struct {
|
|
k Keeper
|
|
}
|
|
|
|
var _ stakingtypes.StakingHooks = Hooks{}
|
|
|
|
// Create new distribution hooks
|
|
func (k Keeper) Hooks() Hooks { return Hooks{k} }
|
|
|
|
// initialize validator distribution record
|
|
func (h Hooks) AfterValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress) error {
|
|
val := h.k.stakingKeeper.Validator(ctx, valAddr)
|
|
h.k.initializeValidator(ctx, val)
|
|
return nil
|
|
}
|
|
|
|
// AfterValidatorRemoved performs clean up after a validator is removed
|
|
func (h Hooks) AfterValidatorRemoved(ctx sdk.Context, _ sdk.ConsAddress, valAddr sdk.ValAddress) error {
|
|
// fetch outstanding
|
|
outstanding := h.k.GetValidatorOutstandingRewardsCoins(ctx, valAddr)
|
|
|
|
// force-withdraw commission
|
|
commission := h.k.GetValidatorAccumulatedCommission(ctx, valAddr).Commission
|
|
if !commission.IsZero() {
|
|
// subtract from outstanding
|
|
outstanding = outstanding.Sub(commission)
|
|
|
|
// split into integral & remainder
|
|
coins, remainder := commission.TruncateDecimal()
|
|
|
|
// remainder to community pool
|
|
feePool := h.k.GetFeePool(ctx)
|
|
feePool.CommunityPool = feePool.CommunityPool.Add(remainder...)
|
|
h.k.SetFeePool(ctx, feePool)
|
|
|
|
// add to validator account
|
|
if !coins.IsZero() {
|
|
accAddr := sdk.AccAddress(valAddr)
|
|
withdrawAddr := h.k.GetDelegatorWithdrawAddr(ctx, accAddr)
|
|
|
|
if err := h.k.bankKeeper.SendCoinsFromModuleToAccount(ctx, types.ModuleName, withdrawAddr, coins); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
}
|
|
|
|
// Add outstanding to community pool
|
|
// The validator is removed only after it has no more delegations.
|
|
// This operation sends only the remaining dust to the community pool.
|
|
feePool := h.k.GetFeePool(ctx)
|
|
feePool.CommunityPool = feePool.CommunityPool.Add(outstanding...)
|
|
h.k.SetFeePool(ctx, feePool)
|
|
|
|
// delete outstanding
|
|
h.k.DeleteValidatorOutstandingRewards(ctx, valAddr)
|
|
|
|
// remove commission record
|
|
h.k.DeleteValidatorAccumulatedCommission(ctx, valAddr)
|
|
|
|
// clear slashes
|
|
h.k.DeleteValidatorSlashEvents(ctx, valAddr)
|
|
|
|
// clear historical rewards
|
|
h.k.DeleteValidatorHistoricalRewards(ctx, valAddr)
|
|
|
|
// clear current rewards
|
|
h.k.DeleteValidatorCurrentRewards(ctx, valAddr)
|
|
|
|
return nil
|
|
}
|
|
|
|
// increment period
|
|
func (h Hooks) BeforeDelegationCreated(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
|
val := h.k.stakingKeeper.Validator(ctx, valAddr)
|
|
_ = h.k.IncrementValidatorPeriod(ctx, val)
|
|
return nil
|
|
}
|
|
|
|
// withdraw delegation rewards (which also increments period)
|
|
func (h Hooks) BeforeDelegationSharesModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
|
val := h.k.stakingKeeper.Validator(ctx, valAddr)
|
|
del := h.k.stakingKeeper.Delegation(ctx, delAddr, valAddr)
|
|
|
|
if _, err := h.k.withdrawDelegationRewards(ctx, val, del); err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// create new delegation period record
|
|
func (h Hooks) AfterDelegationModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) error {
|
|
h.k.initializeDelegation(ctx, valAddr, delAddr)
|
|
return nil
|
|
}
|
|
|
|
// record the slash event
|
|
func (h Hooks) BeforeValidatorSlashed(ctx sdk.Context, valAddr sdk.ValAddress, fraction sdk.Dec) error {
|
|
h.k.updateValidatorSlashFraction(ctx, valAddr, fraction)
|
|
return nil
|
|
}
|
|
|
|
func (h Hooks) BeforeValidatorModified(_ sdk.Context, _ sdk.ValAddress) error { return nil }
|
|
func (h Hooks) AfterValidatorBonded(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress) error {
|
|
return nil
|
|
}
|
|
func (h Hooks) AfterValidatorBeginUnbonding(_ sdk.Context, _ sdk.ConsAddress, _ sdk.ValAddress) error {
|
|
return nil
|
|
}
|
|
func (h Hooks) BeforeDelegationRemoved(_ sdk.Context, _ sdk.AccAddress, _ sdk.ValAddress) error {
|
|
return nil
|
|
}
|