2019-07-19 06:43:38 -07:00
|
|
|
// noalias
|
|
|
|
|
// DONTCOVER
|
|
|
|
|
package types
|
2019-05-16 08:25:32 -07:00
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
2019-07-29 08:27:01 -07:00
|
|
|
authexported "github.com/cosmos/cosmos-sdk/x/auth/exported"
|
2019-07-19 06:43:38 -07:00
|
|
|
"github.com/cosmos/cosmos-sdk/x/params"
|
2019-07-29 08:27:01 -07:00
|
|
|
stakingexported "github.com/cosmos/cosmos-sdk/x/staking/exported"
|
2019-05-16 08:25:32 -07:00
|
|
|
)
|
|
|
|
|
|
2019-06-04 15:06:58 -07:00
|
|
|
// AccountKeeper expected account keeper
|
|
|
|
|
type AccountKeeper interface {
|
2019-10-23 02:14:45 -07:00
|
|
|
GetAccount(ctx sdk.Context, addr sdk.AccAddress) authexported.Account
|
2019-07-29 08:27:01 -07:00
|
|
|
IterateAccounts(ctx sdk.Context, process func(authexported.Account) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
}
|
|
|
|
|
|
2020-01-30 13:31:16 -08:00
|
|
|
// BankKeeper defines the expected interface needed to retrieve account balances.
|
|
|
|
|
type BankKeeper interface {
|
|
|
|
|
GetAllBalances(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
|
|
|
|
|
GetBalance(ctx sdk.Context, addr sdk.AccAddress, denom string) sdk.Coin
|
|
|
|
|
SetBalances(ctx sdk.Context, addr sdk.AccAddress, balances sdk.Coins) error
|
|
|
|
|
LockedCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
|
|
|
|
|
SpendableCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
|
|
|
|
|
}
|
|
|
|
|
|
2019-07-19 06:43:38 -07:00
|
|
|
// ParamSubspace defines the expected Subspace interfacace
|
|
|
|
|
type ParamSubspace interface {
|
|
|
|
|
WithKeyTable(table params.KeyTable) params.Subspace
|
|
|
|
|
Get(ctx sdk.Context, key []byte, ptr interface{})
|
|
|
|
|
GetParamSet(ctx sdk.Context, ps params.ParamSet)
|
|
|
|
|
SetParamSet(ctx sdk.Context, ps params.ParamSet)
|
|
|
|
|
}
|
|
|
|
|
|
2019-06-04 15:06:58 -07:00
|
|
|
// StakingKeeper expected staking keeper
|
2019-05-16 08:25:32 -07:00
|
|
|
type StakingKeeper interface {
|
2019-06-04 15:06:58 -07:00
|
|
|
// iterate through validators by operator address, execute func for each validator
|
|
|
|
|
IterateValidators(sdk.Context,
|
2019-07-29 08:27:01 -07:00
|
|
|
func(index int64, validator stakingexported.ValidatorI) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
|
2019-07-29 08:27:01 -07:00
|
|
|
Validator(sdk.Context, sdk.ValAddress) stakingexported.ValidatorI // get a particular validator by operator address
|
|
|
|
|
ValidatorByConsAddr(sdk.Context, sdk.ConsAddress) stakingexported.ValidatorI // get a particular validator by consensus address
|
2019-06-04 15:06:58 -07:00
|
|
|
|
|
|
|
|
// slash the validator and delegators of the validator, specifying offence height, offence power, and slash fraction
|
|
|
|
|
Slash(sdk.Context, sdk.ConsAddress, int64, int64, sdk.Dec)
|
|
|
|
|
Jail(sdk.Context, sdk.ConsAddress) // jail a validator
|
|
|
|
|
Unjail(sdk.Context, sdk.ConsAddress) // unjail a validator
|
|
|
|
|
|
|
|
|
|
// Delegation allows for getting a particular delegation for a given validator
|
|
|
|
|
// and delegator outside the scope of the staking module.
|
2019-07-29 08:27:01 -07:00
|
|
|
Delegation(sdk.Context, sdk.AccAddress, sdk.ValAddress) stakingexported.DelegationI
|
2019-06-04 15:06:58 -07:00
|
|
|
|
|
|
|
|
// MaxValidators returns the maximum amount of bonded validators
|
2020-02-06 11:21:02 -08:00
|
|
|
MaxValidators(sdk.Context) uint32
|
2019-05-16 08:25:32 -07:00
|
|
|
}
|
|
|
|
|
|
2019-07-19 06:43:38 -07:00
|
|
|
// StakingHooks event hooks for staking validator object (noalias)
|
2019-06-04 15:06:58 -07:00
|
|
|
type StakingHooks interface {
|
|
|
|
|
AfterValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress) // Must be called when a validator is created
|
|
|
|
|
AfterValidatorRemoved(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress) // Must be called when a validator is deleted
|
|
|
|
|
|
|
|
|
|
AfterValidatorBonded(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress) // Must be called when a validator is bonded
|
2019-05-16 08:25:32 -07:00
|
|
|
}
|
