2018-10-05 03:41:38 -07:00
|
|
|
package types
|
|
|
|
|
2019-06-04 15:06:58 -07:00
|
|
|
import (
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
|
|
"github.com/cosmos/cosmos-sdk/x/staking"
|
2019-06-05 10:42:25 -07:00
|
|
|
"github.com/cosmos/cosmos-sdk/x/staking/exported"
|
2019-06-04 15:06:58 -07:00
|
|
|
)
|
2018-10-05 03:41:38 -07:00
|
|
|
|
2019-06-04 15:06:58 -07:00
|
|
|
// StakingKeeper expected staking keeper
|
2019-01-11 12:08:01 -08: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-06-05 10:42:25 -07:00
|
|
|
func(index int64, validator exported.ValidatorI) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
|
|
|
|
// iterate through bonded validators by operator address, execute func for each validator
|
|
|
|
IterateBondedValidatorsByPower(sdk.Context,
|
2019-06-05 10:42:25 -07:00
|
|
|
func(index int64, validator exported.ValidatorI) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
|
|
|
|
// iterate through the consensus validator set of the last block by operator address, execute func for each validator
|
|
|
|
IterateLastValidators(sdk.Context,
|
2019-06-05 10:42:25 -07:00
|
|
|
func(index int64, validator exported.ValidatorI) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
|
2019-06-05 10:42:25 -07:00
|
|
|
Validator(sdk.Context, sdk.ValAddress) exported.ValidatorI // get a particular validator by operator address
|
|
|
|
ValidatorByConsAddr(sdk.Context, sdk.ConsAddress) exported.ValidatorI // get a particular validator by consensus address
|
2019-06-04 15:06:58 -07:00
|
|
|
TotalBondedTokens(sdk.Context) sdk.Int // total bonded tokens within the validator set
|
|
|
|
TotalTokens(sdk.Context) sdk.Int // total token supply
|
|
|
|
|
|
|
|
// 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-06-05 10:42:25 -07:00
|
|
|
Delegation(sdk.Context, sdk.AccAddress, sdk.ValAddress) exported.DelegationI
|
2019-06-04 15:06:58 -07:00
|
|
|
|
|
|
|
// MaxValidators returns the maximum amount of bonded validators
|
|
|
|
MaxValidators(sdk.Context) uint16
|
|
|
|
|
2018-10-05 03:41:38 -07:00
|
|
|
IterateDelegations(ctx sdk.Context, delegator sdk.AccAddress,
|
2019-06-05 10:42:25 -07:00
|
|
|
fn func(index int64, delegation exported.DelegationI) (stop bool))
|
2019-06-04 15:06:58 -07:00
|
|
|
|
2018-10-23 11:48:50 -07:00
|
|
|
GetLastTotalPower(ctx sdk.Context) sdk.Int
|
2019-02-08 15:57:33 -08:00
|
|
|
GetLastValidatorPower(ctx sdk.Context, valAddr sdk.ValAddress) int64
|
2019-02-13 15:01:50 -08:00
|
|
|
|
2019-06-04 15:06:58 -07:00
|
|
|
GetAllSDKDelegations(ctx sdk.Context) []staking.Delegation
|
|
|
|
}
|
|
|
|
|
|
|
|
// StakingHooks event hooks for staking validator object
|
|
|
|
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
|
|
|
|
|
|
|
|
BeforeDelegationCreated(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) // Must be called when a delegation is created
|
|
|
|
BeforeDelegationSharesModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress) // Must be called when a delegation's shares are modified
|
|
|
|
AfterDelegationModified(ctx sdk.Context, delAddr sdk.AccAddress, valAddr sdk.ValAddress)
|
|
|
|
BeforeValidatorSlashed(ctx sdk.Context, valAddr sdk.ValAddress, fraction sdk.Dec)
|
2018-10-05 03:41:38 -07:00
|
|
|
}
|
|
|
|
|
|
|
|
// expected coin keeper
|
|
|
|
type BankKeeper interface {
|
2019-04-09 05:55:01 -07:00
|
|
|
AddCoins(ctx sdk.Context, addr sdk.AccAddress, amt sdk.Coins) (sdk.Coins, sdk.Error)
|
2018-10-05 03:41:38 -07:00
|
|
|
}
|
|
|
|
|
2019-01-16 13:38:05 -08:00
|
|
|
// expected fee collection keeper
|
2018-10-05 03:41:38 -07:00
|
|
|
type FeeCollectionKeeper interface {
|
|
|
|
GetCollectedFees(ctx sdk.Context) sdk.Coins
|
|
|
|
ClearCollectedFees(ctx sdk.Context)
|
|
|
|
}
|