slashing

package
v0.16.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 28, 2021 License: Apache-2.0 Imports: 28 Imported by: 0

Documentation

Overview

nolint

Index

Constants

View Source 
const (
	DefaultParamspace = "slashing"
	BlocksPerMinute   = 12                        // 5 seconds a block
	BlocksPerDay      = BlocksPerMinute * 60 * 24 // 17280
)

Default parameter namespace

View Source 
const MetricsSubsystem = "module_slashing"
View Source 
const MsgRoute = "slashing"

name to identify transaction types

Variables

View Source 
var (
	ValidatorSigningInfoKey         = []byte{0x01} // Prefix for signing info
	ValidatorMissedBlockBitArrayKey = []byte{0x02} // Prefix for missed block bit array
	ValidatorSlashingPeriodKey      = []byte{0x03} // Prefix for slashing period
	AddrPubkeyRelationKey           = []byte{0x04} // Prefix for address-pubkey relation
)

key prefix bytes

View Source 
var (
	KeyMaxEvidenceAge          = []byte("MaxEvidenceAge")
	KeySignedBlocksWindow      = []byte("SignedBlocksWindow")
	KeyMinSignedPerWindow      = []byte("MinSignedPerWindow")
	KeyDoubleSignJailDuration  = []byte("DoubleSignJailDuration")
	KeyDowntimeJailDuration    = []byte("DowntimeJailDuration")
	KeyCensorshipJailDuration  = []byte("CensorshipJailDuration")
	KeySlashFractionDoubleSign = []byte("SlashFractionDoubleSign")
	KeySlashFractionDowntime   = []byte("SlashFractionDowntime")
	KeySlashFractionCensorship = []byte("SlashFractionCensorship")
)

Parameter store key

Functions

func AllInvariants added in v0.11.0 

func AllInvariants() sdk.Invariant

TODO Any invariants to check here? AllInvariants tests all slashing invariants

func BeginBlocker 

func BeginBlocker(ctx sdk.Context, req abci.RequestBeginBlock, sk Keeper) (tags sdk.Tags)

slashing begin block functionality

func EndBlocker added in v0.11.0 

func EndBlocker(ctx sdk.Context, req abci.RequestEndBlock, sk Keeper) (tags sdk.Tags)

slashing end block functionality

func ErrBadValidatorAddr 

func ErrBadValidatorAddr(codespace sdk.CodespaceType) sdk.Error

func ErrMissingSelfDelegation 

func ErrMissingSelfDelegation(codespace sdk.CodespaceType) sdk.Error

func ErrNoValidatorForAddress 

func ErrNoValidatorForAddress(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorJailed 

func ErrValidatorJailed(codespace sdk.CodespaceType) sdk.Error

func ErrValidatorNotJailed 

func ErrValidatorNotJailed(codespace sdk.CodespaceType) sdk.Error

func GetValidatorMissedBlockBitArrayKey 

func GetValidatorMissedBlockBitArrayKey(v sdk.ConsAddress, i int64) []byte

stored by *Tendermint* address (not operator address)

func GetValidatorMissedBlockBitArrayPrefixKey 

func GetValidatorMissedBlockBitArrayPrefixKey(v sdk.ConsAddress) []byte

stored by *Tendermint* address (not operator address)

func GetValidatorSigningInfoAddress 

func GetValidatorSigningInfoAddress(key []byte) (v sdk.ConsAddress)

extract the address from a validator signing info key

func GetValidatorSigningInfoKey 

func GetValidatorSigningInfoKey(v sdk.ConsAddress) []byte

stored by *Tendermint* address (not operator address)

func GetValidatorSlashingPeriodKey 

func GetValidatorSlashingPeriodKey(v sdk.ConsAddress, startHeight int64) []byte

stored by *Tendermint* address (not operator address) followed by start height

func GetValidatorSlashingPeriodPrefix 

func GetValidatorSlashingPeriodPrefix(v sdk.ConsAddress) []byte

stored by *Tendermint* address (not operator address)

func InitGenesis 

func InitGenesis(ctx sdk.Context, keeper Keeper, data GenesisState, sdata types.GenesisState)

InitGenesis initialize default parameters and the keeper's address to pubkey map

func NewHandler 

func NewHandler(k Keeper) sdk.Handler

func NewTestMsgCreateValidator 

func NewTestMsgCreateValidator(address sdk.ValAddress, pubKey crypto.PubKey, amt sdk.Int) stake.MsgCreateValidator

func ParamTypeTable 

func ParamTypeTable() params.TypeTable

ParamTypeTable for slashing module

func RegisterCodec 

func RegisterCodec(cdc *codec.Codec)

Register concrete types on codec codec

func ValidateGenesis added in v0.10.0 

func ValidateGenesis(data GenesisState) error

Types

type CodeType 

type CodeType = sdk.CodeType

Local code type 

const (
	// Default slashing codespace
	DefaultCodespace sdk.CodespaceType = "slash"

	CodeInvalidValidator      CodeType = 101
	CodeValidatorJailed       CodeType = 102
	CodeValidatorNotJailed    CodeType = 103
	CodeMissingSelfDelegation CodeType = 104
)

type GenesisState 

type GenesisState struct {
	Params          Params                          `json:"params"`
	SigningInfos    map[string]ValidatorSigningInfo `json:"signing_infos"`
	MissedBlocks    map[string][]MissedBlock        `json:"missed_blocks"`
	SlashingPeriods []ValidatorSlashingPeriod       `json:"slashing_periods"`
}

GenesisState - all slashing state that must be provided at genesis

func DefaultGenesisState 

func DefaultGenesisState() GenesisState

HubDefaultGenesisState - default GenesisState used by Cosmos Hub

func ExportGenesis 

func ExportGenesis(ctx sdk.Context, keeper Keeper) (data GenesisState)

ExportGenesis writes the current store values to a genesis file, which can be imported again with InitGenesis

type Hooks 

type Hooks struct {
	// contains filtered or unexported fields
}

Wrapper struct

func (Hooks) OnDelegationCreated 

func (h Hooks) OnDelegationCreated(_ sdk.Context, _ sdk.AccAddress, _ sdk.ValAddress)

func (Hooks) OnDelegationRemoved 

func (h Hooks) OnDelegationRemoved(_ sdk.Context, _ sdk.AccAddress, _ sdk.ValAddress)

func (Hooks) OnDelegationSharesModified 

func (h Hooks) OnDelegationSharesModified(_ sdk.Context, _ sdk.AccAddress, _ sdk.ValAddress)

func (Hooks) OnValidatorBeginUnbonding 

func (h Hooks) OnValidatorBeginUnbonding(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress)

Implements sdk.ValidatorHooks

func (Hooks) OnValidatorBonded 

func (h Hooks) OnValidatorBonded(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress)

Implements sdk.ValidatorHooks

func (Hooks) OnValidatorCreated 

func (h Hooks) OnValidatorCreated(ctx sdk.Context, valAddr sdk.ValAddress)

Implements sdk.ValidatorHooks

func (Hooks) OnValidatorModified 

func (h Hooks) OnValidatorModified(_ sdk.Context, _ sdk.ValAddress)

func (Hooks) OnValidatorPowerDidChange 

func (h Hooks) OnValidatorPowerDidChange(ctx sdk.Context, consAddr sdk.ConsAddress, valAddr sdk.ValAddress)

nolint - unused hooks

func (Hooks) OnValidatorRemoved 

func (h Hooks) OnValidatorRemoved(ctx sdk.Context, consAddr sdk.ConsAddress, _ sdk.ValAddress)

Implements sdk.ValidatorHooks

type Keeper 

type Keeper struct {
	// contains filtered or unexported fields
}

Keeper of the slashing store

func NewKeeper 

func NewKeeper(cdc *codec.Codec, key sdk.StoreKey, vs sdk.ValidatorSet, paramspace params.Subspace, codespace sdk.CodespaceType, metrics *Metrics) Keeper

NewKeeper creates a slashing keeper

func (Keeper) CensorshipJailDuration added in v0.12.2 

func (k Keeper) CensorshipJailDuration(ctx sdk.Context) (res time.Duration)

Censorship jail duration

func (Keeper) DeleteValidatorSlashingPeriods added in v0.9.0 

func (k Keeper) DeleteValidatorSlashingPeriods(ctx sdk.Context)

Delete all slashing periods in the store.

func (Keeper) DoubleSignJailDuration added in v0.12.2 

func (k Keeper) DoubleSignJailDuration(ctx sdk.Context) (res time.Duration)

Double-sign jail duration

func (Keeper) DowntimeJailDuration added in v0.12.2 

func (k Keeper) DowntimeJailDuration(ctx sdk.Context) (res time.Duration)

Downtime jail duration

func (Keeper) GetParamSet added in v0.10.0 

func (k Keeper) GetParamSet(ctx sdk.Context) Params

get inflation params from the global param store

func (Keeper) Hooks 

func (k Keeper) Hooks() Hooks

Return the wrapper struct

func (Keeper) IterateValidatorSigningInfos added in v0.9.0 

func (k Keeper) IterateValidatorSigningInfos(ctx sdk.Context, handler func(address sdk.ConsAddress, info ValidatorSigningInfo) (stop bool))

Stored by *validator* address (not operator address)

func (Keeper) MaxEvidenceAge 

func (k Keeper) MaxEvidenceAge(ctx sdk.Context) (res int64)

MaxEvidenceAge - Max age for evidence

func (Keeper) MinSignedPerWindow 

func (k Keeper) MinSignedPerWindow(ctx sdk.Context) int64

Downtime slashing thershold - default 50% of the SignedBlocksWindow

func (Keeper) SetParamSet added in v0.10.0 

func (k Keeper) SetParamSet(ctx sdk.Context, params Params)

set inflation params from the global param store

func (Keeper) SetValidatorSigningInfo added in v0.9.0 

func (k Keeper) SetValidatorSigningInfo(ctx sdk.Context, address sdk.ConsAddress, info ValidatorSigningInfo)

Stored by *validator* address (not operator address)

func (Keeper) SetValidatorSlashingPeriod added in v0.10.0 

func (k Keeper) SetValidatorSlashingPeriod(ctx sdk.Context, slashingPeriod ValidatorSlashingPeriod)

Stored by validator Tendermint address (not operator address) This function sets a validator slashing period for a particular validator, start height, end height, and current slashed-so-far total, or updates an existing slashing period for the same validator and start height.

func (Keeper) SignedBlocksWindow 

func (k Keeper) SignedBlocksWindow(ctx sdk.Context) (res int64)

SignedBlocksWindow - sliding window for downtime slashing

func (Keeper) SlashFractionCensorship added in v0.11.0 

func (k Keeper) SlashFractionCensorship(ctx sdk.Context) (res sdk.Dec)

Slash fraction for Censorship

func (Keeper) SlashFractionDoubleSign 

func (k Keeper) SlashFractionDoubleSign(ctx sdk.Context) (res sdk.Dec)

Slash fraction for DoubleSign

func (Keeper) SlashFractionDowntime 

func (k Keeper) SlashFractionDowntime(ctx sdk.Context) (res sdk.Dec)

Slash fraction for Downtime

type Metrics added in v0.12.0 

type Metrics struct {
	MissedBlocks metrics.Gauge
}

func NopMetrics added in v0.12.0 

func NopMetrics() *Metrics

func PrometheusMetrics added in v0.12.0 

func PrometheusMetrics(config *cfg.InstrumentationConfig) *Metrics

PrometheusMetrics returns Metrics build using Prometheus client library.

type MissedBlock 

type MissedBlock struct {
	Index  int64 `json:"index"`
	Missed bool  `json:"missed"`
}

MissedBlock

type MsgUnjail 

type MsgUnjail struct {
	ValidatorAddr sdk.ValAddress `json:"address"` // address of the validator operator
}

MsgUnjail - struct for unjailing jailed validator

func NewMsgUnjail 

func NewMsgUnjail(validatorAddr sdk.ValAddress) MsgUnjail

func (MsgUnjail) GetSignBytes 

func (msg MsgUnjail) GetSignBytes() []byte

get the bytes for the message signer to sign on

func (MsgUnjail) GetSigners 

func (msg MsgUnjail) GetSigners() []sdk.AccAddress

func (MsgUnjail) Route 

func (msg MsgUnjail) Route() string

nolint

func (MsgUnjail) Type 

func (msg MsgUnjail) Type() string

func (MsgUnjail) ValidateBasic 

func (msg MsgUnjail) ValidateBasic() sdk.Error

quick validity check

type Params 

type Params struct {
	MaxEvidenceAge          int64         `json:"max_evidence_age"`
	SignedBlocksWindow      int64         `json:"signed_blocks_window"`
	MinSignedPerWindow      sdk.Dec       `json:"min_signed_per_window"`
	DoubleSignJailDuration  time.Duration `json:"double_sign_jail_duration"`
	DowntimeJailDuration    time.Duration `json:"downtime_jail_duration"`
	CensorshipJailDuration  time.Duration `json:"censorship_jail_duration"`
	SlashFractionDoubleSign sdk.Dec       `json:"slash_fraction_double_sign"`
	SlashFractionDowntime   sdk.Dec       `json:"slash_fraction_downtime"`
	SlashFractionCensorship sdk.Dec       `json:"slash_fraction_censorship"`
}

Params - used for initializing default parameter for slashing at genesis

func DefaultParams 

func DefaultParams() Params

Default parameters used by Iris Hub

func DefaultParamsForTestnet added in v0.10.0 

func DefaultParamsForTestnet() Params

func (*Params) GetParamSpace added in v0.10.0 

func (p *Params) GetParamSpace() string

func (*Params) KeyValuePairs 

func (p *Params) KeyValuePairs() params.KeyValuePairs

Implements params.ParamStruct

func (Params) String added in v0.14.0 

func (p Params) String() string

func (*Params) StringFromBytes added in v0.10.0 

func (p *Params) StringFromBytes(cdc *codec.Codec, key string, bytes []byte) (string, error)

func (*Params) Validate added in v0.10.0 

func (p *Params) Validate(key string, value string) (interface{}, sdk.Error)

type ValidatorSigningInfo 

type ValidatorSigningInfo struct {
	StartHeight         int64     `json:"start_height"`          // height at which validator was first a candidate OR was unjailed
	IndexOffset         int64     `json:"index_offset"`          // index offset into signed block bit array
	JailedUntil         time.Time `json:"jailed_until"`          // timestamp validator cannot be unjailed until
	MissedBlocksCounter int64     `json:"missed_blocks_counter"` // missed blocks counter (to avoid scanning the array every time)
}

Signing info for a validator

func NewValidatorSigningInfo 

func NewValidatorSigningInfo(startHeight int64, indexOffset int64, jailedUntil time.Time, missedBlocksCounter int64) ValidatorSigningInfo

Construct a new `ValidatorSigningInfo` struct

func (ValidatorSigningInfo) String added in v0.14.0 

func (i ValidatorSigningInfo) String() string

Return human readable signing info

type ValidatorSlashingPeriod 

type ValidatorSlashingPeriod struct {
	ValidatorAddr sdk.ConsAddress `json:"validator_addr"` // validator which this slashing period is for
	StartHeight   int64           `json:"start_height"`   // starting height of the slashing period
	EndHeight     int64           `json:"end_height"`     // ending height of the slashing period, or sentinel value of 0 for in-progress
	SlashedSoFar  sdk.Dec         `json:"slashed_so_far"` // fraction of validator stake slashed so far in this slashing period
}

Slashing period for a validator

func NewValidatorSlashingPeriod 

func NewValidatorSlashingPeriod(startHeight int64, endHeight int64, slashedSoFar sdk.Dec) ValidatorSlashingPeriod

Construct a new `ValidatorSlashingPeriod` struct

func (ValidatorSlashingPeriod) HumanReadableString 

func (p ValidatorSlashingPeriod) HumanReadableString() string

Return human readable slashing period

type ValidatorSlashingPeriodValue 

type ValidatorSlashingPeriodValue struct {
	EndHeight    int64   `json:"end_height"`
	SlashedSoFar sdk.Dec `json:"slashed_so_far"`
}

Value part of slashing period (validator address & start height are stored in the key)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.