Documentation
¶
Index ¶
- Constants
- Variables
- type Bucket
- type BucketType
- type Config
- type Indexer
- func (s *Indexer) Bucket(id uint64, height uint64) (*Bucket, bool, error)
- func (s *Indexer) BucketTypes(height uint64) ([]*BucketType, error)
- func (s *Indexer) Buckets(height uint64) ([]*Bucket, error)
- func (s *Indexer) BucketsByCandidate(candidate address.Address, height uint64) ([]*Bucket, error)
- func (s *Indexer) BucketsByIndices(indices []uint64, height uint64) ([]*Bucket, error)
- func (s *Indexer) CandidateVotes(ctx context.Context, candidate address.Address, height uint64) (*big.Int, error)
- func (s *Indexer) ContractAddress() string
- func (s *Indexer) DeleteTipBlock(context.Context, *block.Block) error
- func (s *Indexer) Height() (uint64, error)
- func (s *Indexer) PutBlock(ctx context.Context, blk *block.Block) error
- func (s *Indexer) Start(ctx context.Context) error
- func (s *Indexer) StartHeight() uint64
- func (s *Indexer) Stop(ctx context.Context) error
- func (s *Indexer) TotalBucketCount(height uint64) (uint64, error)
Constants ¶
View Source
const ( // StakingContractABI is the ABI of system staking contract StakingContractABI = `` /* 5568-byte string literal not displayed */ )
Variables ¶
View Source
var ( // ErrBucketNotExist is the error when bucket does not exist ErrBucketNotExist = errors.New("bucket does not exist") // ErrInvalidHeight is the error when height is invalid ErrInvalidHeight = errors.New("invalid height") )
Functions ¶
This section is empty.
Types ¶
type Bucket ¶
type Bucket = staking.VoteBucket
Bucket defines the bucket struct for contract staking
type BucketType ¶
type BucketType = staking.ContractStakingBucketType
BucketType defines the type of contract staking bucket
type Config ¶
type Config struct {
ContractAddress string // stake contract ContractAddress
ContractDeployHeight uint64 // height of the contract deployment
// TODO: move calculateVoteWeightFunc out of config
CalculateVoteWeight calculateVoteWeightFunc // calculate vote weight function
BlockInterval time.Duration // block produce interval
}
Config is the config for contract staking indexer
type Indexer ¶
type Indexer struct {
// contains filtered or unexported fields
}
Indexer is the contract staking indexer Main functions:
- handle contract staking contract events when new block comes to generate index data
- provide query interface for contract staking index data
func NewContractStakingIndexer ¶
NewContractStakingIndexer creates a new contract staking indexer
func (*Indexer) BucketTypes ¶
func (s *Indexer) BucketTypes(height uint64) ([]*BucketType, error)
BucketTypes returns the active bucket types
func (*Indexer) BucketsByCandidate ¶
BucketsByCandidate returns the buckets by candidate
func (*Indexer) BucketsByIndices ¶
BucketsByIndices returns the buckets by indices
func (*Indexer) CandidateVotes ¶
func (s *Indexer) CandidateVotes(ctx context.Context, candidate address.Address, height uint64) (*big.Int, error)
CandidateVotes returns the candidate votes
func (*Indexer) ContractAddress ¶
ContractAddress returns the contract address
func (*Indexer) DeleteTipBlock ¶
DeleteTipBlock deletes the tip block from indexer
func (*Indexer) StartHeight ¶
StartHeight returns the start height of the indexer
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.