carrier

Documentation

Index

• type Carrier
  • func NewEthereumVoteCarrier(clientURLs []string, registerContractAddress common.Address, ...) (Carrier, error)
• type EthClientPool
  • func NewEthClientPool(urls []string) *EthClientPool
  • func (pool *EthClientPool) Close()
  • func (pool *EthClientPool) Execute(callback func(c *ethclient.Client) error) (err error)
• type EthereumBucketsResult
• type TipInfo

Types

type Carrier

type Carrier interface {
	// BlockTimestamp returns the timestamp of a block
	BlockTimestamp(uint64) (time.Time, error)
	// SubscribeNewBlock callbacks on new block created
	SubscribeNewBlock(chan *TipInfo, chan error, chan bool)
	// Tip returns the latest height and its timestamp
	Tip() (*TipInfo, error)
	// Candidates returns the candidates on height
	Candidates(uint64, *big.Int, uint8) (*big.Int, []*types.Candidate, error)
	// Votes returns the votes on height
	Votes(uint64, *big.Int, uint8) (*big.Int, []*types.Vote, error)
	// Close closes carrier
	Close()
}

Carrier defines an interfact to fetch votes

func NewEthereumVoteCarrier

func NewEthereumVoteCarrier(
	clientURLs []string,
	registerContractAddress common.Address,
	stakingContractAddress common.Address,
) (Carrier, error)

NewEthereumVoteCarrier defines a carrier to fetch votes from ethereum contract

type EthClientPool

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

EthClientPool defines a set of ethereum clients with execute interface

func NewEthClientPool

func NewEthClientPool(urls []string) *EthClientPool

NewEthClientPool creates a new pool

func (*EthClientPool) Close

func (pool *EthClientPool) Close()

Close closes the current client if available

func (*EthClientPool) Execute

func (pool *EthClientPool) Execute(callback func(c *ethclient.Client) error) (err error)

Execute executes callback by rotating all client urls

type EthereumBucketsResult

type EthereumBucketsResult struct {
	Count           *big.Int
	Indexes         []*big.Int
	StakeStartTimes []*big.Int
	StakeDurations  []*big.Int
	Decays          []bool
	StakedAmounts   []*big.Int
	CanNames        [][12]byte
	Owners          []common.Address
}

EthereumBucketsResult defines the data structure the buckets api returns

type TipInfo

type TipInfo struct {
	Height    uint64
	BlockTime time.Time
}

TipInfo is the info of a tip block