checkpointoracle

Documentation

Overview

Package checkpointoracle is a wrapper of checkpoint oracle contract with additional rules defined. This package can be used both in LES client or server side for offering oracle related APIs.

Index

• type CheckpointOracle
  • func New(config *params.CheckpointOracleConfig, ...) *CheckpointOracle
  • func (oracle *CheckpointOracle) Contract() *checkpointoracle.CheckpointOracle
  • func (oracle *CheckpointOracle) IsRunning() bool
  • func (oracle *CheckpointOracle) StableCheckpoint() (*params.TrustedCheckpoint, uint64)
  • func (oracle *CheckpointOracle) Start(backend bind.ContractBackend)
  • func (oracle *CheckpointOracle) VerifySigners(index uint64, hash [32]byte, signatures [][]byte) (bool, []common.Address)

Types

type CheckpointOracle

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

CheckpointOracle is responsible for offering the latest stable checkpoint generated and announced by the contract admins on-chain. The checkpoint can be verified by clients locally during the checkpoint syncing.

func New

func New(config *params.CheckpointOracleConfig, getLocal func(uint64) params.TrustedCheckpoint) *CheckpointOracle

New creates a checkpoint oracle handler with given configs and callback.

func (*CheckpointOracle) Contract

func (oracle *CheckpointOracle) Contract() *checkpointoracle.CheckpointOracle

Contract returns the underlying raw checkpoint oracle contract.

func (*CheckpointOracle) IsRunning

func (oracle *CheckpointOracle) IsRunning() bool

IsRunning returns an indicator whether the oracle is running.

func (*CheckpointOracle) StableCheckpoint

func (oracle *CheckpointOracle) StableCheckpoint() (*params.TrustedCheckpoint, uint64)

StableCheckpoint returns the stable checkpoint which was generated by local indexers and announced by trusted signers.

func (*CheckpointOracle) Start

func (oracle *CheckpointOracle) Start(backend bind.ContractBackend)

Start binds the contract backend, initializes the oracle instance and marks the status as available.

func (*CheckpointOracle) VerifySigners

func (oracle *CheckpointOracle) VerifySigners(index uint64, hash [32]byte, signatures [][]byte) (bool, []common.Address)

VerifySigners recovers the signer addresses according to the signature and checks whether there are enough approvals to finalize the checkpoint.