podc

package
v0.2.14 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 8, 2021 License: GPL-3.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var DefaultConfig = &Config{
	RequestTimeout: 5000,

	BlockPeriod:    2,
	BlockPauseTime: 2,
	ProposerPolicy: RoundRobin,
	Epoch:          30000,
}
View Source 
var (
	// ErrUnauthorizedAddress is returned when given address cannot be found in
	// current validator set.
	ErrUnauthorizedAddress = errors.New("unauthorized address")
)

Functions

func CheckValidatorSignature 

func CheckValidatorSignature(valSet ValidatorSet, data []byte, sig []byte) (common.Address, error)

func GetSignatureAddress 

func GetSignatureAddress(data []byte, sig []byte) (common.Address, error)

GetSignatureAddress gets the signer address from the signature

func RLPHash 

func RLPHash(v interface{}) (h common.Hash)

Types

type Backend 

type Backend interface {
	// Address returns the owner's address
	Address() common.Address

	// Validators returns the validator set
	Validators(proposal Proposal) ValidatorSet // old istanbul method, I'll remove it in the future after debuging

	// EventMux returns the event mux in backend
	EventMux() *event.TypeMux

	// Send sends a message to specific target : 특정 노드에 보낼때,
	Send(payload []byte, target common.Address) error

	// Broadcast sends a message to all validators : 전체 노드에 보낼때, 기 정의된 Validator집합에..
	Broadcast(valSet ValidatorSet, payload []byte) error

	// Multicast sends a message to specific targets
	Multicast(payload []byte, targets []common.Address) error

	// Commit delivers an approved proposal to backend.
	// The delivered proposal will be put into blockchain.
	Commit(proposal Proposal, seals []byte) error

	// NextRound is called when we want to trigger next Seal()
	NextRound() error

	// Verify verifies the proposal.
	Verify(Proposal) error

	// Sign signs input data with the backend's private key
	Sign([]byte) ([]byte, error)

	// CheckSignature verifies the signature by checking if it's signed by
	// the given validator
	CheckSignature(data []byte, addr common.Address, sig []byte) error
}

Backend provides application specific functions for Istanbul core

type Config 

type Config struct {
	RequestTimeout uint64         `toml:",omitempty"` // The timeout for each Istanbul round in milliseconds. This timeout should be larger than BlockPauseTime
	BlockPeriod    uint64         `toml:",omitempty"` // Default minimum difference between two consecutive block's timestamps in second
	BlockPauseTime uint64         `toml:",omitempty"` // Delay time if no tx in block, the value should be larger than BlockPeriod
	ProposerPolicy ProposerPolicy `toml:",omitempty"` // The policy for proposer selection
	Epoch          uint64         `toml:",omitempty"` // The number of blocks after which to checkpoint and reset the pending votes
}

type ConsensusDataEvent 

type ConsensusDataEvent struct {
	// target to send message
	Target common.Address
	// consensus message data
	Data []byte
}

type D_commit 

type D_commit struct {
	View     *View
	Proposal Proposal
}

type D_select 

type D_select struct {
	// TODO: define Coordinator struct like
	View     *View
	Proposal Proposal
}

type FinalCommittedEvent 

type FinalCommittedEvent struct {
	Proposal Proposal
	Proposer common.Address
}

type MessageEvent 

type MessageEvent struct {
	Payload []byte
}

type Preprepare 

type Preprepare struct {
	View     *View
	Proposal Proposal
}

func (*Preprepare) DecodeRLP 

func (b *Preprepare) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, and load the consensus fields from a RLP stream.

func (*Preprepare) EncodeRLP 

func (b *Preprepare) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Ethereum RLP format.

type Proposal 

type Proposal interface {
	// Number retrieves the sequence number of this proposal.
	Number() *big.Int

	// Hash retrieves the hash of this proposal.
	Hash() common.Hash

	EncodeRLP(w io.Writer) error

	DecodeRLP(s *rlp.Stream) error

	String() string
}

Proposal supports retrieving height(of Block) and serialized block to be used during PoDC consensus. Proposal block ?

type ProposalQman 

type ProposalQman interface {
	// Number retrieves the sequence number of this proposal.
	Number() *big.Int

	// Hash retrieves the hash of this proposal.
	Hash() common.Hash

	EncodeRLP(w io.Writer) error

	DecodeRLP(s *rlp.Stream) error

	String() string
}

Qmanager data exchange format Proposal supports retrieving height and serialized block to be used during Istanbul consensus.

type ProposalSelector 

type ProposalSelector func(ValidatorSet, common.Address, uint64) Validator

type ProposerPolicy 

type ProposerPolicy uint64
const (
	RoundRobin ProposerPolicy = iota
	Sticky
	QRF
)

type QmanDataEvent 

type QmanDataEvent struct {
	// target to send message
	Target common.Address
	// consensus message data
	Data []byte
}

type Request 

type Request struct {
	Proposal Proposal
}

type RequestEvent 

type RequestEvent struct {
	Proposal Proposal
}

-----------------------------------------

type RequestEventQman 

type RequestEventQman struct {
	Proposal Proposal
}

type RequestQman 

type RequestQman struct {
	Proposal ProposalQman
}

type Subject 

type Subject struct {
	View   *View
	Digest common.Hash
}

func (*Subject) DecodeRLP 

func (b *Subject) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, and load the consensus fields from a RLP stream.

func (*Subject) EncodeRLP 

func (b *Subject) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Ethereum RLP format.

func (*Subject) String 

func (b *Subject) String() string

type Validator 

type Validator interface {
	// Address returns address
	Address() common.Address

	// String representation of Validator
	String() string

	Tag() common.Tag

	Qrnd() uint64

	SetAddress(a common.Address)

	SetTag(t common.Tag)

	SetQrnd(q uint64)
}

type ValidatorSet 

type ValidatorSet interface {
	// Calculate the proposer
	CalcProposer(lastProposer common.Address, round uint64) // 최초 Proposer 가 누군지 계산 ,,

	// Return the validator size
	Size() int
	// Return the validator array
	List() []Validator
	// Get validator by index
	GetByIndex(i uint64) Validator
	// Get validator by given address
	GetByAddress(addr common.Address) (int, Validator)
	// Get current proposer
	GetProposer() Validator

	// Check whether the validator with given address is a proposer
	IsProposer(address common.Address) bool

	// Add validator
	AddValidator(address common.Address) bool
	// Remove validator
	RemoveValidator(address common.Address) bool
	// Copy validator set
	Copy() ValidatorSet
	// Get the maximum number of faulty nodes
	F() int
}

type Validators 

type Validators []Validator // go 배열 표현

type Validators []validator.ValidatorElement // go 배열 표현

func (Validators) Len 

func (slice Validators) Len() int
설명 : Validators = [ address, String, Tag ] [ ... ] [ ... ] .........
 Validator node

|-------------------------| | enode address(20 byte) |-------------------------| 

String인데,,String()모르겠으나, 그냥 문자열,
Validator 를 나타내는

|-------------------------| 

Tag를 새로 달았음.

|-------------------------| ............ N 개 Validators

func (Validators) Less 

func (slice Validators) Less(i, j int) bool

func (Validators) Swap 

func (slice Validators) Swap(i, j int)

type View 

type View struct {
	Round    *big.Int
	Sequence *big.Int
}

View includes a round number and a sequence number. Sequence is the block number we'd like to commit. Each round has a number and is composed by 3 steps: preprepare, prepare and commit.

If the given block is not accepted by validators, a round change will occur and the validators start a new round with round+1.

func (*View) Cmp 

func (v *View) Cmp(y *View) int

Cmp compares v and y and returns: 

-1 if v <  y
 0 if v == y
+1 if v >  y

func (*View) DecodeRLP 

func (v *View) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, and load the consensus fields from a RLP stream.

func (*View) EncodeRLP 

func (v *View) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Ethereum RLP format.

func (*View) String 

func (v *View) String() string

Source Files

View all Source files

Directories

Path Synopsis
// Copyright 2017 AMIS Technologies // This file is part of the go-ethereum library.
 // Copyright 2017 AMIS Technologies // This file is part of the go-ethereum library.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.