types

package
v0.45.16-ics-lsm Latest Latest
Warning

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

 Go to latest Published: Aug 18, 2023 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ModuleName is the name of the staking module
	ModuleName = "staking"

	// StoreKey is the string store representation
	StoreKey = ModuleName
)

Variables

View Source 
var (
	ValidatorsKey = []byte{0x21} // prefix for each key to a validator
	DelegationKey = []byte{0x31} // key for a delegation
	ParamsKey     = []byte{0x51} // prefix for parameters for module x/staking
)
View Source 
var (
	ErrInvalidLengthStaking        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowStaking          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroupStaking = fmt.Errorf("proto: unexpected end of group")
)
View Source 
var BondStatus_name = map[int32]string{
	0: "BOND_STATUS_UNSPECIFIED",
	1: "BOND_STATUS_UNBONDED",
	2: "BOND_STATUS_UNBONDING",
	3: "BOND_STATUS_BONDED",
}
View Source 
var BondStatus_value = map[string]int32{
	"BOND_STATUS_UNSPECIFIED": 0,
	"BOND_STATUS_UNBONDED":    1,
	"BOND_STATUS_UNBONDING":   2,
	"BOND_STATUS_BONDED":      3,
}

Functions

func GetDelegationKey 

func GetDelegationKey(delAddr sdk.AccAddress, valAddr sdk.ValAddress) []byte

GetDelegationKey creates the key for delegator bond with validator VALUE: staking/Delegation

func GetDelegationsKey 

func GetDelegationsKey(delAddr sdk.AccAddress) []byte

GetDelegationsKey creates the prefix for a delegator for all validators

func GetValidatorKey 

func GetValidatorKey(operatorAddr sdk.ValAddress) []byte

GetValidatorKey creates the key for the validator with address VALUE: staking/Validator

func StakingDescription 

func StakingDescription() (desc *github_com_gogo_protobuf_protoc_gen_gogo_descriptor.FileDescriptorSet)

Types

type BondStatus 

type BondStatus int32

BondStatus is the status of a validator. 

const (
	// UNSPECIFIED defines an invalid validator status.
	Unspecified BondStatus = 0
	// UNBONDED defines a validator that is not bonded.
	Unbonded BondStatus = 1
	// UNBONDING defines a validator that is unbonding.
	Unbonding BondStatus = 2
	// BONDED defines a validator that is bonded.
	Bonded BondStatus = 3
)

func (BondStatus) EnumDescriptor 

func (BondStatus) EnumDescriptor() ([]byte, []int)

func (BondStatus) String 

func (x BondStatus) String() string

type Commission 

type Commission struct {
	// commission_rates defines the initial commission rates to be used for creating a validator.
	CommissionRates `protobuf:"bytes,1,opt,name=commission_rates,json=commissionRates,proto3,embedded=commission_rates" json:"commission_rates"`
	// update_time is the last time the commission rate was changed.
	UpdateTime time.Time `protobuf:"bytes,2,opt,name=update_time,json=updateTime,proto3,stdtime" json:"update_time" yaml:"update_time"`
}

Commission defines commission parameters for a given validator.

func (*Commission) Descriptor 

func (*Commission) Descriptor() ([]byte, []int)

func (*Commission) Equal 

func (this *Commission) Equal(that interface{}) bool

func (*Commission) GetUpdateTime 

func (m *Commission) GetUpdateTime() time.Time

func (*Commission) Marshal 

func (m *Commission) Marshal() (dAtA []byte, err error)

func (*Commission) MarshalTo 

func (m *Commission) MarshalTo(dAtA []byte) (int, error)

func (*Commission) MarshalToSizedBuffer 

func (m *Commission) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Commission) ProtoMessage 

func (*Commission) ProtoMessage()

func (*Commission) Reset 

func (m *Commission) Reset()

func (*Commission) Size 

func (m *Commission) Size() (n int)

func (Commission) String 

func (c Commission) String() string

String implements the Stringer interface for a Commission object.

func (*Commission) Unmarshal 

func (m *Commission) Unmarshal(dAtA []byte) error

func (*Commission) XXX_DiscardUnknown 

func (m *Commission) XXX_DiscardUnknown()

func (*Commission) XXX_Marshal 

func (m *Commission) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Commission) XXX_Merge 

func (m *Commission) XXX_Merge(src proto.Message)

func (*Commission) XXX_Size 

func (m *Commission) XXX_Size() int

func (*Commission) XXX_Unmarshal 

func (m *Commission) XXX_Unmarshal(b []byte) error

type CommissionRates 

type CommissionRates struct {
	// rate is the commission rate charged to delegators, as a fraction.
	Rate github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,1,opt,name=rate,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"rate"`
	// max_rate defines the maximum commission rate which validator can ever charge, as a fraction.
	MaxRate github_com_cosmos_cosmos_sdk_types.Dec `` /* 138-byte string literal not displayed */
	// max_change_rate defines the maximum daily increase of the validator commission, as a fraction.
	MaxChangeRate github_com_cosmos_cosmos_sdk_types.Dec `` /* 165-byte string literal not displayed */
}

CommissionRates defines the initial commission rates to be used for creating a validator.

func (*CommissionRates) Descriptor 

func (*CommissionRates) Descriptor() ([]byte, []int)

func (*CommissionRates) Equal 

func (this *CommissionRates) Equal(that interface{}) bool

func (*CommissionRates) Marshal 

func (m *CommissionRates) Marshal() (dAtA []byte, err error)

func (*CommissionRates) MarshalTo 

func (m *CommissionRates) MarshalTo(dAtA []byte) (int, error)

func (*CommissionRates) MarshalToSizedBuffer 

func (m *CommissionRates) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*CommissionRates) ProtoMessage 

func (*CommissionRates) ProtoMessage()

func (*CommissionRates) Reset 

func (m *CommissionRates) Reset()

func (*CommissionRates) Size 

func (m *CommissionRates) Size() (n int)

func (CommissionRates) String 

func (cr CommissionRates) String() string

String implements the Stringer interface for a CommissionRates object.

func (*CommissionRates) Unmarshal 

func (m *CommissionRates) Unmarshal(dAtA []byte) error

func (*CommissionRates) XXX_DiscardUnknown 

func (m *CommissionRates) XXX_DiscardUnknown()

func (*CommissionRates) XXX_Marshal 

func (m *CommissionRates) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*CommissionRates) XXX_Merge 

func (m *CommissionRates) XXX_Merge(src proto.Message)

func (*CommissionRates) XXX_Size 

func (m *CommissionRates) XXX_Size() int

func (*CommissionRates) XXX_Unmarshal 

func (m *CommissionRates) XXX_Unmarshal(b []byte) error

type Delegation 

type Delegation struct {
	// delegator_address is the bech32-encoded address of the delegator.
	DelegatorAddress string `` /* 134-byte string literal not displayed */
	// validator_address is the bech32-encoded address of the validator.
	ValidatorAddress string `` /* 134-byte string literal not displayed */
	// shares define the delegation shares received.
	Shares github_com_cosmos_cosmos_sdk_types.Dec `protobuf:"bytes,3,opt,name=shares,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Dec" json:"shares"`
}

Delegation represents the bond with tokens held by an account. It is owned by one delegator, and is associated with the voting power of one validator.

func (*Delegation) Descriptor 

func (*Delegation) Descriptor() ([]byte, []int)

func (Delegation) GetDelegatorAddr 

func (d Delegation) GetDelegatorAddr() sdk.AccAddress

func (Delegation) GetValidatorAddr 

func (d Delegation) GetValidatorAddr() sdk.ValAddress

func (*Delegation) Marshal 

func (m *Delegation) Marshal() (dAtA []byte, err error)

func (*Delegation) MarshalTo 

func (m *Delegation) MarshalTo(dAtA []byte) (int, error)

func (*Delegation) MarshalToSizedBuffer 

func (m *Delegation) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Delegation) ProtoMessage 

func (*Delegation) ProtoMessage()

func (*Delegation) Reset 

func (m *Delegation) Reset()

func (*Delegation) Size 

func (m *Delegation) Size() (n int)

func (Delegation) String 

func (d Delegation) String() string

String returns a human readable string representation of a Delegation.

func (*Delegation) Unmarshal 

func (m *Delegation) Unmarshal(dAtA []byte) error

func (*Delegation) XXX_DiscardUnknown 

func (m *Delegation) XXX_DiscardUnknown()

func (*Delegation) XXX_Marshal 

func (m *Delegation) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Delegation) XXX_Merge 

func (m *Delegation) XXX_Merge(src proto.Message)

func (*Delegation) XXX_Size 

func (m *Delegation) XXX_Size() int

func (*Delegation) XXX_Unmarshal 

func (m *Delegation) XXX_Unmarshal(b []byte) error

type Description 

type Description struct {
	// moniker defines a human-readable name for the validator.
	Moniker string `protobuf:"bytes,1,opt,name=moniker,proto3" json:"moniker,omitempty"`
	// identity defines an optional identity signature (ex. UPort or Keybase).
	Identity string `protobuf:"bytes,2,opt,name=identity,proto3" json:"identity,omitempty"`
	// website defines an optional website link.
	Website string `protobuf:"bytes,3,opt,name=website,proto3" json:"website,omitempty"`
	// security_contact defines an optional email for security contact.
	SecurityContact string `` /* 130-byte string literal not displayed */
	// details define other optional details.
	Details string `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"`
}

Description defines a validator description.

func (*Description) Descriptor 

func (*Description) Descriptor() ([]byte, []int)

func (*Description) Equal 

func (this *Description) Equal(that interface{}) bool

func (*Description) GetDetails 

func (m *Description) GetDetails() string

func (*Description) GetIdentity 

func (m *Description) GetIdentity() string

func (*Description) GetMoniker 

func (m *Description) GetMoniker() string

func (*Description) GetSecurityContact 

func (m *Description) GetSecurityContact() string

func (*Description) GetWebsite 

func (m *Description) GetWebsite() string

func (*Description) Marshal 

func (m *Description) Marshal() (dAtA []byte, err error)

func (*Description) MarshalTo 

func (m *Description) MarshalTo(dAtA []byte) (int, error)

func (*Description) MarshalToSizedBuffer 

func (m *Description) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Description) ProtoMessage 

func (*Description) ProtoMessage()

func (*Description) Reset 

func (m *Description) Reset()

func (*Description) Size 

func (m *Description) Size() (n int)

func (Description) String 

func (d Description) String() string

String implements the Stringer interface for a Description object.

func (*Description) Unmarshal 

func (m *Description) Unmarshal(dAtA []byte) error

func (*Description) XXX_DiscardUnknown 

func (m *Description) XXX_DiscardUnknown()

func (*Description) XXX_Marshal 

func (m *Description) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Description) XXX_Merge 

func (m *Description) XXX_Merge(src proto.Message)

func (*Description) XXX_Size 

func (m *Description) XXX_Size() int

func (*Description) XXX_Unmarshal 

func (m *Description) XXX_Unmarshal(b []byte) error

type Params 

type Params struct {
	// unbonding_time is the time duration of unbonding.
	UnbondingTime time.Duration `protobuf:"bytes,1,opt,name=unbonding_time,json=unbondingTime,proto3,stdduration" json:"unbonding_time" yaml:"unbonding_time"`
	// max_validators is the maximum number of validators.
	MaxValidators uint32 `protobuf:"varint,2,opt,name=max_validators,json=maxValidators,proto3" json:"max_validators,omitempty" yaml:"max_validators"`
	// max_entries is the max entries for either unbonding delegation or redelegation (per pair/trio).
	MaxEntries uint32 `protobuf:"varint,3,opt,name=max_entries,json=maxEntries,proto3" json:"max_entries,omitempty" yaml:"max_entries"`
	// historical_entries is the number of historical entries to persist.
	HistoricalEntries uint32 `` /* 139-byte string literal not displayed */
	// bond_denom defines the bondable coin denomination.
	BondDenom string `protobuf:"bytes,5,opt,name=bond_denom,json=bondDenom,proto3" json:"bond_denom,omitempty" yaml:"bond_denom"`
}

Params defines the parameters for the staking module.

func MustUnmarshalParams 

func MustUnmarshalParams(cdc *codec.LegacyAmino, value []byte) Params

unmarshal the current staking params value from store key or panic

func UnmarshalParams 

func UnmarshalParams(cdc *codec.LegacyAmino, value []byte) (params Params, err error)

unmarshal the current staking params value from store key

func (*Params) Descriptor 

func (*Params) Descriptor() ([]byte, []int)

func (*Params) Equal 

func (this *Params) Equal(that interface{}) bool

func (*Params) GetBondDenom 

func (m *Params) GetBondDenom() string

func (*Params) GetHistoricalEntries 

func (m *Params) GetHistoricalEntries() uint32

func (*Params) GetMaxEntries 

func (m *Params) GetMaxEntries() uint32

func (*Params) GetMaxValidators 

func (m *Params) GetMaxValidators() uint32

func (*Params) GetUnbondingTime 

func (m *Params) GetUnbondingTime() time.Duration

func (*Params) Marshal 

func (m *Params) Marshal() (dAtA []byte, err error)

func (*Params) MarshalTo 

func (m *Params) MarshalTo(dAtA []byte) (int, error)

func (*Params) MarshalToSizedBuffer 

func (m *Params) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Params) ProtoMessage 

func (*Params) ProtoMessage()

func (*Params) Reset 

func (m *Params) Reset()

func (*Params) Size 

func (m *Params) Size() (n int)

func (Params) String 

func (p Params) String() string

String returns a human readable string representation of the parameters.

func (*Params) Unmarshal 

func (m *Params) Unmarshal(dAtA []byte) error

func (*Params) XXX_DiscardUnknown 

func (m *Params) XXX_DiscardUnknown()

func (*Params) XXX_Marshal 

func (m *Params) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Params) XXX_Merge 

func (m *Params) XXX_Merge(src proto.Message)

func (*Params) XXX_Size 

func (m *Params) XXX_Size() int

func (*Params) XXX_Unmarshal 

func (m *Params) XXX_Unmarshal(b []byte) error

type Validator 

type Validator struct {
	// operator_address defines the address of the validator's operator; bech encoded in JSON.
	OperatorAddress string `` /* 130-byte string literal not displayed */
	// consensus_pubkey is the consensus public key of the validator, as a Protobuf Any.
	ConsensusPubkey *types1.Any `` /* 130-byte string literal not displayed */
	// jailed defined whether the validator has been jailed from bonded status or not.
	Jailed bool `protobuf:"varint,3,opt,name=jailed,proto3" json:"jailed,omitempty"`
	// status is the validator status (bonded/unbonding/unbonded).
	Status BondStatus `protobuf:"varint,4,opt,name=status,proto3,enum=cosmos.staking.v1beta1.BondStatus" json:"status,omitempty"`
	// tokens define the delegated tokens (incl. self-delegation).
	Tokens github_com_cosmos_cosmos_sdk_types.Int `protobuf:"bytes,5,opt,name=tokens,proto3,customtype=github.com/cosmos/cosmos-sdk/types.Int" json:"tokens"`
	// delegator_shares defines total shares issued to a validator's delegators.
	DelegatorShares github_com_cosmos_cosmos_sdk_types.Dec `` /* 170-byte string literal not displayed */
	// description defines the description terms for the validator.
	Description Description `protobuf:"bytes,7,opt,name=description,proto3" json:"description"`
	// unbonding_height defines, if unbonding, the height at which this validator has begun unbonding.
	UnbondingHeight int64 `` /* 131-byte string literal not displayed */
	// unbonding_time defines, if unbonding, the min time for the validator to complete unbonding.
	UnbondingTime time.Time `protobuf:"bytes,9,opt,name=unbonding_time,json=unbondingTime,proto3,stdtime" json:"unbonding_time" yaml:"unbonding_time"`
	// commission defines the commission parameters.
	Commission Commission `protobuf:"bytes,10,opt,name=commission,proto3" json:"commission"`
	// min_self_delegation is the validator's self declared minimum self delegation.
	MinSelfDelegation github_com_cosmos_cosmos_sdk_types.Int `` /* 182-byte string literal not displayed */
	// strictly positive if this validator's unbonding has been stopped by external modules
	UnbondingOnHoldRefCount int64 `` /* 138-byte string literal not displayed */
	// list of unbonding ids, each uniquely identifing an unbonding of this validator
	UnbondingIds []uint64 `protobuf:"varint,13,rep,packed,name=unbonding_ids,json=unbondingIds,proto3" json:"unbonding_ids,omitempty"`
}

Validator defines a validator, together with the total amount of the Validator's bond shares and their exchange rate to coins. Slashing results in a decrease in the exchange rate, allowing correct calculation of future undelegations without iterating over delegators. When coins are delegated to this validator, the validator is credited with a delegation whose number of bond shares is based on the amount of coins delegated divided by the current exchange rate. Voting power can be calculated as total bonded shares multiplied by exchange rate.

func (*Validator) Descriptor 

func (*Validator) Descriptor() ([]byte, []int)

func (Validator) GetOperator 

func (v Validator) GetOperator() sdk.ValAddress

func (*Validator) Marshal 

func (m *Validator) Marshal() (dAtA []byte, err error)

func (*Validator) MarshalTo 

func (m *Validator) MarshalTo(dAtA []byte) (int, error)

func (*Validator) MarshalToSizedBuffer 

func (m *Validator) MarshalToSizedBuffer(dAtA []byte) (int, error)

func (*Validator) ProtoMessage 

func (*Validator) ProtoMessage()

func (*Validator) Reset 

func (m *Validator) Reset()

func (*Validator) Size 

func (m *Validator) Size() (n int)

func (Validator) String 

func (v Validator) String() string

String implements the Stringer interface for a Validator object.

func (*Validator) Unmarshal 

func (m *Validator) Unmarshal(dAtA []byte) error

func (*Validator) XXX_DiscardUnknown 

func (m *Validator) XXX_DiscardUnknown()

func (*Validator) XXX_Marshal 

func (m *Validator) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Validator) XXX_Merge 

func (m *Validator) XXX_Merge(src proto.Message)

func (*Validator) XXX_Size 

func (m *Validator) XXX_Size() int

func (*Validator) XXX_Unmarshal 

func (m *Validator) XXX_Unmarshal(b []byte) error

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.