backend

Documentation

Index

• func Factory(ctx context.Context, config *consensus.Config, privateKey *ecdsa.PrivateKey, ...) (consensus.Consensus, error)
• func New(config *ibft.Config, privateKey *ecdsa.PrivateKey, db storage.Storage, ...) consensus.Istanbul
• type API
  • func (api *API) Candidates() map[types.Address]bool
  • func (api *API) Discard(address types.Address)
  • func (api *API) GetSnapshot(number *jsonrpc.BlockNumber) (*Snapshot, error)
  • func (api *API) GetSnapshotAtHash(hash types.Hash) (*Snapshot, error)
  • func (api *API) GetValidators(number *jsonrpc.BlockNumber) ([]types.Address, error)
  • func (api *API) GetValidatorsAtHash(hash types.Hash) ([]types.Address, error)
  • func (api *API) Propose(address types.Address, auth bool)
• type Snapshot
  • func (s *Snapshot) MarshalJSON() ([]byte, error)
  • func (s *Snapshot) UnmarshalJSON(b []byte) error
• type Tally
• type Vote

Functions

func Factory

func Factory(ctx context.Context, config *consensus.Config, privateKey *ecdsa.PrivateKey, db storage.Storage, logger hclog.Logger) (consensus.Consensus, error)

func New

func New(config *ibft.Config, privateKey *ecdsa.PrivateKey, db storage.Storage, logger hclog.Logger) consensus.Istanbul

New creates an Ethereum backend for Istanbul core engine.

Types

type API

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

API is a user facing RPC API to dump Istanbul state

func (*API) Candidates

func (api *API) Candidates() map[types.Address]bool

Candidates returns the current candidates the node tries to uphold and vote on.

func (*API) Discard

func (api *API) Discard(address types.Address)

Discard drops a currently running candidate, stopping the validator from casting further votes (either for or against).

func (*API) GetSnapshot

func (api *API) GetSnapshot(number *jsonrpc.BlockNumber) (*Snapshot, error)

GetSnapshot retrieves the state snapshot at a given block.

func (*API) GetSnapshotAtHash

func (api *API) GetSnapshotAtHash(hash types.Hash) (*Snapshot, error)

GetSnapshotAtHash retrieves the state snapshot at a given block.

func (*API) GetValidators

func (api *API) GetValidators(number *jsonrpc.BlockNumber) ([]types.Address, error)

GetValidators retrieves the list of authorized validators at the specified block.

func (*API) GetValidatorsAtHash

func (api *API) GetValidatorsAtHash(hash types.Hash) ([]types.Address, error)

GetValidatorsAtHash retrieves the state snapshot at a given block.

func (*API) Propose

func (api *API) Propose(address types.Address, auth bool)

Propose injects a new authorization candidate that the validator will attempt to push through.

type Snapshot

type Snapshot struct {
	Epoch uint64 // The number of blocks after which to checkpoint and reset the pending votes

	Number uint64                  // Block number where the snapshot was created
	Hash   types.Hash              // Block hash where the snapshot was created
	Votes  []*Vote                 // List of votes cast in chronological order
	Tally  map[types.Address]Tally // Current vote tally to avoid recalculating
	ValSet ibft.ValidatorSet       // Set of authorized validators at this moment
}

Snapshot is the state of the authorization voting at a given point in time.

func (*Snapshot) MarshalJSON

func (s *Snapshot) MarshalJSON() ([]byte, error)

Marshal to a json byte array

func (*Snapshot) UnmarshalJSON

func (s *Snapshot) UnmarshalJSON(b []byte) error

Unmarshal from a json byte array

type Tally

type Tally struct {
	Authorize bool `json:"authorize"` // Whether the vote it about authorizing or kicking someone
	Votes     int  `json:"votes"`     // Number of votes until now wanting to pass the proposal
}

Tally is a simple vote tally to keep the current score of votes. Votes that go against the proposal aren't counted since it's equivalent to not voting.

type Vote

type Vote struct {
	Validator types.Address `json:"validator"` // Authorized validator that cast this vote
	Block     uint64        `json:"block"`     // Block number the vote was cast in (expire old votes)
	Address   types.Address `json:"address"`   // Account being voted on to change its authorization
	Authorize bool          `json:"authorize"` // Whether to authorize or deauthorize the voted account
}

Vote represents a single vote that an authorized validator made to modify the list of authorizations.