contractstaking

Documentation

Index

• Constants
• Variables
• type Bucket
• type BucketType
• type Config
• type Indexer
  • func NewContractStakingIndexer(kvStore db.KVStore, config Config) (*Indexer, error)
  • 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) 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

const (
	// StakingContractABI is the ABI of system staking contract
	StakingContractABI = `` /* 5568-byte string literal not displayed */

)

Variables

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")
)

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:

1. handle contract staking contract events when new block comes to generate index data
2. provide query interface for contract staking index data

func NewContractStakingIndexer

func NewContractStakingIndexer(kvStore db.KVStore, config Config) (*Indexer, error)

NewContractStakingIndexer creates a new contract staking indexer

func (*Indexer) Bucket

func (s *Indexer) Bucket(id uint64, height uint64) (*Bucket, bool, error)

Bucket returns the bucket

func (*Indexer) BucketTypes

func (s *Indexer) BucketTypes(height uint64) ([]*BucketType, error)

BucketTypes returns the active bucket types

func (*Indexer) Buckets

func (s *Indexer) Buckets(height uint64) ([]*Bucket, error)

Buckets returns the buckets

func (*Indexer) BucketsByCandidate

func (s *Indexer) BucketsByCandidate(candidate address.Address, height uint64) ([]*Bucket, error)

BucketsByCandidate returns the buckets by candidate

func (*Indexer) BucketsByIndices

func (s *Indexer) BucketsByIndices(indices []uint64, height uint64) ([]*Bucket, error)

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) DeleteTipBlock

func (s *Indexer) DeleteTipBlock(context.Context, *block.Block) error

DeleteTipBlock deletes the tip block from indexer

func (*Indexer) Height

func (s *Indexer) Height() (uint64, error)

Height returns the tip block height

func (*Indexer) PutBlock

func (s *Indexer) PutBlock(ctx context.Context, blk *block.Block) error

PutBlock puts a block into indexer

func (*Indexer) Start

func (s *Indexer) Start(ctx context.Context) error

Start starts the indexer

func (*Indexer) StartHeight

func (s *Indexer) StartHeight() uint64

StartHeight returns the start height of the indexer

func (*Indexer) Stop

func (s *Indexer) Stop(ctx context.Context) error

Stop stops the indexer

func (*Indexer) TotalBucketCount

func (s *Indexer) TotalBucketCount(height uint64) (uint64, error)

TotalBucketCount returns the total bucket count including active and burnt buckets