consensus

Documentation

Index

• type App
• type BeginRequest
• type BeginResponse
• type CheckRequest
• type CheckResponse
• type CommitConsensusError
  • func (CommitConsensusError) Error() string
• type ExecuteHookFunc
• type ExecuteRequest
• type ExecuteResponse
• type ExecutorApp
  • func (a *ExecutorApp) Begin(req *BeginRequest) (*BeginResponse, error)
  • func (a *ExecutorApp) Check(req *CheckRequest) (*CheckResponse, error)
  • func (a *ExecutorApp) Info(*InfoRequest) (*InfoResponse, error)
  • func (a *ExecutorApp) Init(req *InitRequest) (*InitResponse, error)
• type ExecutorBlock
  • func (b *ExecutorBlock) Close() (execute.BlockState, error)
  • func (b *ExecutorBlock) Process(envelope *messaging.Envelope) ([]*protocol.TransactionStatus, error)
• type ExecutorBlockState
  • func (s *ExecutorBlockState) Commit() error
• type Gossip
• type InfoRequest
• type InfoResponse
• type InitRequest
• type InitResponse
• type Node
  • func NewNode(key ed25519.PrivateKey, app App, gossip *Gossip, logger log.Logger) *Node
  • func (n *Node) Check(req *CheckRequest) (*CheckResponse, error)
  • func (n *Node) Execute(req *ExecuteRequest) (*ExecuteResponse, error)
  • func (n *Node) Info(req *InfoRequest) (*InfoResponse, error)
  • func (n *Node) Init(req *InitRequest) (*InitResponse, error)
  • func (n *Node) SetExecuteHook(hook ExecuteHookFunc)
  • func (n *Node) SetRecorder(rec Recorder)
  • func (n *Node) Status(*StatusRequest) (*StatusResponse, error)
• type Recorder
• type RestoreFunc
• type StatusRequest
• type StatusResponse

Types

type App

type App interface {
	Info(*InfoRequest) (*InfoResponse, error)
	Check(*CheckRequest) (*CheckResponse, error)
	Init(*InitRequest) (*InitResponse, error)
	Begin(*BeginRequest) (*BeginResponse, error)
}

type BeginRequest

type BeginRequest struct {
	Params execute.BlockParams
}

type BeginResponse

type BeginResponse struct {
	Block execute.Block
}

type CheckRequest

type CheckRequest struct {
	Context  context.Context
	Envelope *messaging.Envelope
	New      bool
	Pretend  bool
}

type CheckResponse

type CheckResponse struct {
	Results []*protocol.TransactionStatus
}

type CommitConsensusError

type CommitConsensusError [][]byte

func (CommitConsensusError) Error

func (CommitConsensusError) Error() string

type ExecuteHookFunc

type ExecuteHookFunc = func(*Node, execute.BlockParams, []*messaging.Envelope) (_ []*messaging.Envelope, keepHook bool)

type ExecuteRequest

type ExecuteRequest struct {
	Context context.Context
}

type ExecuteResponse

type ExecuteResponse struct {
}

type ExecutorApp

type ExecutorApp struct {
	Executor execute.Executor
	Restore  RestoreFunc
	EventBus *events.Bus
}

func (*ExecutorApp) Begin

func (a *ExecutorApp) Begin(req *BeginRequest) (*BeginResponse, error)

func (*ExecutorApp) Check

func (a *ExecutorApp) Check(req *CheckRequest) (*CheckResponse, error)

func (*ExecutorApp) Info

func (a *ExecutorApp) Info(*InfoRequest) (*InfoResponse, error)

func (*ExecutorApp) Init

func (a *ExecutorApp) Init(req *InitRequest) (*InitResponse, error)

type ExecutorBlock

type ExecutorBlock struct {
	execute.Block
	// contains filtered or unexported fields
}

func (*ExecutorBlock) Close

func (b *ExecutorBlock) Close() (execute.BlockState, error)

func (*ExecutorBlock) Process

func (b *ExecutorBlock) Process(envelope *messaging.Envelope) ([]*protocol.TransactionStatus, error)

type ExecutorBlockState

type ExecutorBlockState struct {
	execute.BlockState
	// contains filtered or unexported fields
}

func (*ExecutorBlockState) Commit

func (s *ExecutorBlockState) Commit() error

type Gossip

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

type InfoRequest

type InfoRequest struct{}

type InfoResponse

type InfoResponse struct {
	LastBlock *execute.BlockParams
	LastHash  [32]byte
}

type InitRequest

type InitRequest struct {
	Snapshot   ioutil.SectionReader
	Validators []*execute.ValidatorUpdate
}

type InitResponse

type InitResponse struct {
	Hash       []byte
	Validators []*execute.ValidatorUpdate
}

type Node

type Node struct {

	// SkipProposalCheck skips checking the proposed block.
	SkipProposalCheck bool

	// IgnoreDeliverResults ignores inconsistencies in the result of DeliverTx
	// (the results of transactions and signatures).
	IgnoreDeliverResults bool

	// IgnoreCommitResults ignores inconsistencies in the result of Commit (the
	// root hash of the BPT).
	IgnoreCommitResults bool
	// contains filtered or unexported fields
}

func NewNode

func NewNode(key ed25519.PrivateKey, app App, gossip *Gossip, logger log.Logger) *Node

func (*Node) Check

func (n *Node) Check(req *CheckRequest) (*CheckResponse, error)

func (*Node) Execute

func (n *Node) Execute(req *ExecuteRequest) (*ExecuteResponse, error)

func (*Node) Info

func (n *Node) Info(req *InfoRequest) (*InfoResponse, error)

func (*Node) Init

func (n *Node) Init(req *InitRequest) (*InitResponse, error)

func (*Node) SetExecuteHook

func (n *Node) SetExecuteHook(hook ExecuteHookFunc)

func (*Node) SetRecorder

func (n *Node) SetRecorder(rec Recorder)

func (*Node) Status

func (n *Node) Status(*StatusRequest) (*StatusResponse, error)

type Recorder

type Recorder interface {
	DidInit(snapshot ioutil.SectionReader) error
	DidExecuteBlock(state execute.BlockState, submissions []*messaging.Envelope) error
}

type RestoreFunc

type RestoreFunc func(ioutil.SectionReader) error

type StatusRequest

type StatusRequest struct{}

type StatusResponse

type StatusResponse struct {
	BlockIndex uint64
	BlockTime  time.Time
}