staking

Documentation

Overview

Package staking implements the staking application.

Index

• Constants
• Variables
• func New() api.Application
• type Query
• type QueryFactory
  • func NewQueryFactory(state abciAPI.ApplicationQueryState) *QueryFactory
  • func (sf *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error)

Constants

const (
	// AppID is the unique application identifier.
	AppID uint8 = 0x05
)

Variables

var (
	// AppName is the ABCI application name.
	AppName = stakingState.AppName

	// EventType is the ABCI event type for staking events.
	EventType = api.EventTypeForApp(AppName)

	// QueryApp is a query for filtering events processed by the
	// staking application.
	QueryApp = api.QueryForApp(AppName)
)

Functions

func New

func New() api.Application

New constructs a new staking application instance.

Types

type Query

type Query interface {
	TotalSupply(context.Context) (*quantity.Quantity, error)
	CommonPool(context.Context) (*quantity.Quantity, error)
	LastBlockFees(context.Context) (*quantity.Quantity, error)
	GovernanceDeposits(context.Context) (*quantity.Quantity, error)
	Threshold(context.Context, staking.ThresholdKind) (*quantity.Quantity, error)
	DebondingInterval(context.Context) (beacon.EpochTime, error)
	Addresses(context.Context) ([]staking.Address, error)
	Account(context.Context, staking.Address) (*staking.Account, error)
	DelegationsFor(context.Context, staking.Address) (map[staking.Address]*staking.Delegation, error)
	DelegationInfosFor(context.Context, staking.Address) (map[staking.Address]*staking.DelegationInfo, error)
	DelegationsTo(context.Context, staking.Address) (map[staking.Address]*staking.Delegation, error)
	DebondingDelegationsFor(context.Context, staking.Address) (map[staking.Address][]*staking.DebondingDelegation, error)
	DebondingDelegationInfosFor(context.Context, staking.Address) (map[staking.Address][]*staking.DebondingDelegationInfo, error)
	DebondingDelegationsTo(context.Context, staking.Address) (map[staking.Address][]*staking.DebondingDelegation, error)
	Genesis(context.Context) (*staking.Genesis, error)
	ConsensusParameters(context.Context) (*staking.ConsensusParameters, error)
}

Query is the staking query interface.

type QueryFactory

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

QueryFactory is the staking query factory.

func NewQueryFactory

func NewQueryFactory(state abciAPI.ApplicationQueryState) *QueryFactory

NewQueryFactory returns a new QueryFactory backed by the given state instance.

func (*QueryFactory) QueryAt

func (sf *QueryFactory) QueryAt(ctx context.Context, height int64) (Query, error)

QueryAt returns the staking query interface for a specific height.