Documentation ¶
Index ¶
- Constants
- type Account
- type AccountBalance
- type AccountBalanceHistory
- type ConsensusEvent
- type Delegation
- type DelegatorRewardAmount
- type Deposit
- type DepositParams
- type DistributionParams
- type DoubleSignEvidence
- type DoubleSignVote
- type Genesis
- type GovParams
- type MintParams
- type Pool
- type Proposal
- type ProposalStakingPoolSnapshot
- type ProposalUpdate
- type ProposalValidatorStatusSnapshot
- type Redelegation
- type SlashingParams
- type StakingParams
- type TallyParams
- type TallyResult
- type Token
- type TokenPrice
- type TokenUnit
- type UnbondingDelegation
- type Validator
- type ValidatorCommission
- type ValidatorCommissionAmount
- type ValidatorDescription
- type ValidatorSigningInfo
- type ValidatorStatus
- type ValidatorVotingPower
- type Vote
- type VotingParams
Constants ¶
const (
HistoryModuleName = "history"
)
const (
ProposalStatusInvalid = "PROPOSAL_STATUS_INVALID"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountBalance ¶
AccountBalance represents the balance of an account at a given height
func NewAccountBalance ¶
func NewAccountBalance(address string, balance sdk.Coins, height int64) AccountBalance
NewAccountBalance allows to build a new AccountBalance instance
type AccountBalanceHistory ¶
type AccountBalanceHistory struct { Account string Balance []sdk.Coin Delegations []sdk.Coin Redelegations []sdk.Coin Unbonding []sdk.Coin Commission []sdk.DecCoin Reward []sdk.DecCoin Timestamp time.Time }
AccountBalanceHistory contains the information of a given balance at a specific height
func NewAccountBalanceHistory ¶
func NewAccountBalanceHistory( account string, balance, delegations, redelegations, unbonding []sdk.Coin, commission, reward []sdk.DecCoin, timestamp time.Time, ) AccountBalanceHistory
NewAccountBalanceHistory allows to build a new AccountBalanceHistory instance
type ConsensusEvent ¶
type ConsensusEvent struct { Height int64 `json:"height"` Round int32 `json:"round"` Step string `json:"step"` }
ConsensusEvent represents a consensus event
func NewConsensusEvent ¶
func NewConsensusEvent(height int64, round int32, step string) *ConsensusEvent
NewConsensusEvent allows to easily build a new ConsensusEvent object
func (ConsensusEvent) Equal ¶
func (c ConsensusEvent) Equal(other ConsensusEvent) bool
Equal tells whether c and other contain the same data
type Delegation ¶
type Delegation struct { DelegatorAddress string ValidatorOperAddr string Amount sdk.Coin Height int64 }
Delegation represents a single delegation made from a delegator to a specific validator at a specific height (and timestamp) containing a given amount of tokens
func NewDelegation ¶
func NewDelegation(delegator string, validatorOperAddr string, amount sdk.Coin, height int64) Delegation
NewDelegation creates a new Delegation instance containing the given data
type DelegatorRewardAmount ¶
type DelegatorRewardAmount struct { ValidatorOperAddr string DelegatorAddress string WithdrawAddress string Amount []sdk.DecCoin Height int64 }
DelegatorRewardAmount contains the data of a delegator commission amount
func NewDelegatorRewardAmount ¶
func NewDelegatorRewardAmount( delegator, valOperAddr, withdrawAddress string, amount sdk.DecCoins, height int64, ) DelegatorRewardAmount
NewDelegatorRewardAmount allows to build a new DelegatorRewardAmount instance
type DepositParams ¶
type DepositParams struct { MinDeposit sdk.Coins `json:"min_deposit,omitempty" yaml:"min_deposit"` MaxDepositPeriod int64 `json:"max_deposit_period,omitempty" yaml:"max_deposit_period"` }
DepositParams contains the data of the deposit parameters of the x/gov module
func NewDepositParam ¶
func NewDepositParam(d govtypes.DepositParams) DepositParams
NewDepositParam allows to build a new DepositParams
type DistributionParams ¶
type DistributionParams struct { distrtypes.Params Height int64 }
DistributionParams represents the parameters of the x/distribution module
func NewDistributionParams ¶
func NewDistributionParams(params distrtypes.Params, height int64) DistributionParams
NewDistributionParams allows to build a new DistributionParams instance
type DoubleSignEvidence ¶
type DoubleSignEvidence struct { VoteA DoubleSignVote VoteB DoubleSignVote Height int64 }
DoubleSignEvidence represent a double sign evidence on each tendermint block
func NewDoubleSignEvidence ¶
func NewDoubleSignEvidence(height int64, voteA DoubleSignVote, voteB DoubleSignVote) DoubleSignEvidence
NewDoubleSignEvidence return a new DoubleSignEvidence object
type DoubleSignVote ¶
type DoubleSignVote struct { BlockID string ValidatorAddress string Signature string Type int Height int64 Round int32 ValidatorIndex int32 }
DoubleSignVote represents a double vote which is included inside a DoubleSignEvidence
func NewDoubleSignVote ¶
func NewDoubleSignVote( roundType int, height int64, round int32, blockID string, validatorAddress string, validatorIndex int32, signature string, ) DoubleSignVote
NewDoubleSignVote allows to create a new DoubleSignVote instance
type Genesis ¶
Genesis contains the useful information about the genesis
func NewGenesis ¶
NewGenesis allows to build a new Genesis instance
type GovParams ¶
type GovParams struct { DepositParams DepositParams `json:"deposit_params" yaml:"deposit_params"` VotingParams VotingParams `json:"voting_params" yaml:"voting_params"` TallyParams TallyParams `json:"tally_params" yaml:"tally_params"` Height int64 `json:"height" ymal:"height"` }
GovParams contains the data of the x/gov module parameters
func NewGovParams ¶
func NewGovParams(votingParams VotingParams, depositParams DepositParams, tallyParams TallyParams, height int64) *GovParams
NewGovParams allows to build a new GovParams instance
type MintParams ¶
MintParams represents the x/mint parameters
func NewMintParams ¶
func NewMintParams(params minttypes.Params, height int64) MintParams
NewMintParams allows to build a new MintParams instance
type Proposal ¶
type Proposal struct { ProposalRoute string ProposalType string ProposalID uint64 Content govtypes.Content Status string SubmitTime time.Time DepositEndTime time.Time VotingStartTime time.Time VotingEndTime time.Time Proposer string }
Proposal represents a single governance proposal
func NewProposal ¶
func NewProposal( proposalID uint64, proposalRoute string, proposalType string, content govtypes.Content, status string, submitTime time.Time, depositEndTime time.Time, votingStartTime time.Time, votingEndTime time.Time, proposer string, ) Proposal
NewProposal return a new Proposal instance
type ProposalStakingPoolSnapshot ¶
ProposalStakingPoolSnapshot contains the data about a single staking pool snapshot to be associated with a proposal
func NewProposalStakingPoolSnapshot ¶
func NewProposalStakingPoolSnapshot(proposalID uint64, pool *Pool) ProposalStakingPoolSnapshot
NewProposalStakingPoolSnapshot returns a new ProposalStakingPoolSnapshot instance
type ProposalUpdate ¶
type ProposalUpdate struct { ProposalID uint64 Status string VotingStartTime time.Time VotingEndTime time.Time }
ProposalUpdate contains the data that should be used when updating a governance proposal
func NewProposalUpdate ¶
func NewProposalUpdate( proposalID uint64, status string, votingStartTime, votingEndTime time.Time, ) ProposalUpdate
NewProposalUpdate allows to build a new ProposalUpdate instance
type ProposalValidatorStatusSnapshot ¶
type ProposalValidatorStatusSnapshot struct { ProposalID uint64 ValidatorConsAddress string ValidatorVotingPower int64 ValidatorStatus int ValidatorJailed bool Height int64 }
ProposalValidatorStatusSnapshot represents a single snapshot of the status of a validator associated with a single proposal
func NewProposalValidatorStatusSnapshot ¶
func NewProposalValidatorStatusSnapshot( proposalID uint64, validatorConsAddr string, validatorVotingPower int64, validatorStatus int, validatorJailed bool, height int64, ) ProposalValidatorStatusSnapshot
NewProposalValidatorStatusSnapshot returns a new ProposalValidatorStatusSnapshot instance
type Redelegation ¶
type Redelegation struct { DelegatorAddress string SrcValidator string DstValidator string Amount sdk.Coin CompletionTime time.Time Height int64 }
Redelegation represents a single re-delegations
func NewRedelegation ¶
func NewRedelegation( delegator string, srcValidator, dstValidator string, amount sdk.Coin, completionTime time.Time, height int64, ) Redelegation
NewRedelegation build a new Redelegation object
func (Redelegation) Equal ¶
func (r Redelegation) Equal(s Redelegation) bool
Equal returns true iff r and s contain the same data
type SlashingParams ¶
type SlashingParams struct { slashingtypes.Params Height int64 }
SlashingParams represents the parameters of the slashing module at a given height
func NewSlashingParams ¶
func NewSlashingParams(params slashingtypes.Params, height int64) SlashingParams
NewSlashingParams allows to build a new SlashingParams instance
type StakingParams ¶
type StakingParams struct { stakingtypes.Params Height int64 }
StakingParams represents the parameters of the x/staking module
func NewStakingParams ¶
func NewStakingParams(params stakingtypes.Params, height int64) StakingParams
NewStakingParams returns a new StakingParams instance
type TallyParams ¶
type TallyParams struct { Quorum sdk.Dec `json:"quorum,omitempty"` Threshold sdk.Dec `json:"threshold,omitempty"` VetoThreshold sdk.Dec `json:"veto_threshold,omitempty" yaml:"veto_threshold"` }
TallyParams contains the tally parameters of the x/gov module
func NewTallyParams ¶
func NewTallyParams(t govtypes.TallyParams) TallyParams
NewTallyParams allows to build a new TallyParams instance
type TallyResult ¶
type TallyResult struct { ProposalID uint64 Yes int64 Abstain int64 No int64 NoWithVeto int64 Height int64 }
TallyResult contains the data about the final results of a proposal
func NewTallyResult ¶
func NewTallyResult( proposalID uint64, yes int64, abstain int64, no int64, noWithVeto int64, height int64, ) TallyResult
NewTallyResult return a new TallyResult instance
type TokenPrice ¶
TokenPrice represents the price at a given moment in time of a token unit
func NewTokenPrice ¶
NewTokenPrice returns a new TokenPrice instance containing the given data
type TokenUnit ¶
type TokenUnit struct { Denom string `toml:"denom"` Exponent int `toml:"exponent"` Aliases []string `toml:"aliases"` PriceID string `toml:"price_id"` }
TokenUnit represents a unit of a token
type UnbondingDelegation ¶
type UnbondingDelegation struct { DelegatorAddress string ValidatorOperAddr string Amount sdk.Coin CompletionTimestamp time.Time Height int64 }
UnbondingDelegation represents a single unbonding delegation
func NewUnbondingDelegation ¶
func NewUnbondingDelegation( delegator string, validatorOperAddr string, amount sdk.Coin, completionTimestamp time.Time, height int64, ) UnbondingDelegation
NewUnbondingDelegation allows to create a new UnbondingDelegation instance
func (UnbondingDelegation) Equal ¶
func (u UnbondingDelegation) Equal(v UnbondingDelegation) bool
Equal returns true iff u and v contain the same data
type Validator ¶
type Validator interface { GetConsAddr() string GetConsPubKey() string GetOperator() string GetSelfDelegateAddress() string GetMaxChangeRate() *sdk.Dec GetMaxRate() *sdk.Dec GetHeight() int64 }
Validator represents a single validator. This is defined as an interface so that we can use the SDK types as well as database types properly.
type ValidatorCommission ¶
type ValidatorCommission struct { ValAddress string Commission *sdk.Dec MinSelfDelegation *sdk.Int Height int64 }
ValidatorCommission contains the data of a validator commission at a given height
func NewValidatorCommission ¶
func NewValidatorCommission( valAddress string, rate *sdk.Dec, minSelfDelegation *sdk.Int, height int64, ) ValidatorCommission
NewValidatorCommission return a new validator commission instance
type ValidatorCommissionAmount ¶
type ValidatorCommissionAmount struct { ValidatorOperAddr string ValidatorSelfDelegateAddr string Amount []sdk.DecCoin Height int64 }
ValidatorCommissionAmount represents the commission amount for a specific validator
func NewValidatorCommissionAmount ¶
func NewValidatorCommissionAmount( valOperAddr, valSelfDelegateAddress string, amount sdk.DecCoins, height int64, ) ValidatorCommissionAmount
NewValidatorCommissionAmount allows to build a new ValidatorCommissionAmount instance
type ValidatorDescription ¶
type ValidatorDescription struct { OperatorAddress string Description stakingtypes.Description AvatarURL string // URL of the avatar to be used. Will be [do-no-modify] if it shouldn't be edited Height int64 }
ValidatorDescription contains the description of a validator and timestamp do the description get changed
func NewValidatorDescription ¶
func NewValidatorDescription( opAddr string, description stakingtypes.Description, avatarURL string, height int64, ) ValidatorDescription
NewValidatorDescription return a new ValidatorDescription object
type ValidatorSigningInfo ¶
type ValidatorSigningInfo struct { ValidatorAddress string StartHeight int64 IndexOffset int64 JailedUntil time.Time Tombstoned bool MissedBlocksCounter int64 Height int64 }
ValidatorSigningInfo contains the signing info of a validator at a given height
func NewValidatorSigningInfo ¶
func NewValidatorSigningInfo( validatorAddress string, startHeight int64, indexOffset int64, jailedUntil time.Time, tombstoned bool, missedBlocksCounter int64, height int64, ) ValidatorSigningInfo
ValidatorSigningInfo allows to build a new ValidatorSigningInfo
func (ValidatorSigningInfo) Equal ¶
func (v ValidatorSigningInfo) Equal(w ValidatorSigningInfo) bool
Equal tells whether v and w represent the same rows
type ValidatorStatus ¶
type ValidatorStatus struct { ConsensusAddress string ConsensusPubKey string Status int Jailed bool Height int64 }
ValidatorStatus represents the current state for the specified validator at the specific height
func NewValidatorStatus ¶
func NewValidatorStatus(valConsAddr, pubKey string, status int, jailed bool, height int64) ValidatorStatus
NewValidatorStatus creates a new ValidatorVotingPower
type ValidatorVotingPower ¶
ValidatorVotingPower represents the voting power of a validator at a specific block height
func NewValidatorVotingPower ¶
func NewValidatorVotingPower(address string, votingPower int64, height int64) ValidatorVotingPower
NewValidatorVotingPower creates a new ValidatorVotingPower
type Vote ¶
type Vote struct { ProposalID uint64 Voter string Option govtypes.VoteOption Height int64 }
Vote contains the data of a single proposal vote
type VotingParams ¶
type VotingParams struct {
VotingPeriod int64 `json:"voting_period,omitempty" yaml:"voting_period"`
}
VotingParams contains the voting parameters of the x/gov module
func NewVotingParams ¶
func NewVotingParams(v govtypes.VotingParams) VotingParams
NewVotingParams allows to build a new VotingParams instance