abci

Documentation

Overview

Package abci implements the Accumulate ABCI applications.

Transaction Processing

Tendermint processes transactions in the following phases:

• BeginBlock
• [CheckTx]
• [DeliverTx]
• EndBlock
• Commit

Index

• Constants
• func ListSnapshots(cfg *config.Config) ([]*snapshot.Header, error)
• type Accumulator
  • func NewAccumulator(opts AccumulatorOptions) *Accumulator
  • func (app *Accumulator) ApplySnapshotChunk(req abci.RequestApplySnapshotChunk) abci.ResponseApplySnapshotChunk
  • func (app *Accumulator) BeginBlock(req abci.RequestBeginBlock) abci.ResponseBeginBlock
  • func (app *Accumulator) CheckTx(req abci.RequestCheckTx) (rct abci.ResponseCheckTx)
  • func (app *Accumulator) Commit() abci.ResponseCommit
  • func (app *Accumulator) DeliverTx(req abci.RequestDeliverTx) (rdt abci.ResponseDeliverTx)
  • func (app *Accumulator) EndBlock(req abci.RequestEndBlock) abci.ResponseEndBlock
  • func (app *Accumulator) Info(abci.RequestInfo) abci.ResponseInfo
  • func (app *Accumulator) InitChain(req abci.RequestInitChain) abci.ResponseInitChain
  • func (app *Accumulator) ListSnapshots(req abci.RequestListSnapshots) abci.ResponseListSnapshots
  • func (app *Accumulator) LoadSnapshotChunk(req abci.RequestLoadSnapshotChunk) abci.ResponseLoadSnapshotChunk
  • func (app *Accumulator) OfferSnapshot(req abci.RequestOfferSnapshot) abci.ResponseOfferSnapshot
  • func (app *Accumulator) OnFatal(f func(error))
  • func (app *Accumulator) Query(reqQuery abci.RequestQuery) (resQuery abci.ResponseQuery)
• type AccumulatorOptions

Constants

const Version uint64 = 0x1

Version is the version of the ABCI applications.

Functions

func ListSnapshots

func ListSnapshots(cfg *config.Config) ([]*snapshot.Header, error)

ListSnapshots queries the node for available snapshots.

Types

type Accumulator

type Accumulator struct {
	abci.BaseApplication
	AccumulatorOptions
	// contains filtered or unexported fields
}

Accumulator is an ABCI application that accumulates validated transactions in a hash tree.

func NewAccumulator

func NewAccumulator(opts AccumulatorOptions) *Accumulator

NewAccumulator returns a new Accumulator.

func (*Accumulator) ApplySnapshotChunk

func (app *Accumulator) ApplySnapshotChunk(req abci.RequestApplySnapshotChunk) abci.ResponseApplySnapshotChunk

ApplySnapshotChunk applies a snapshot to the node.

func (*Accumulator) BeginBlock

func (app *Accumulator) BeginBlock(req abci.RequestBeginBlock) abci.ResponseBeginBlock

BeginBlock implements github.com/tendermint/tendermint/abci/types.Application.

func (*Accumulator) CheckTx

func (app *Accumulator) CheckTx(req abci.RequestCheckTx) (rct abci.ResponseCheckTx)

CheckTx implements github.com/tendermint/tendermint/abci/types.Application.

Verifies the transaction is sane.

func (*Accumulator) Commit

func (app *Accumulator) Commit() abci.ResponseCommit

Commit implements github.com/tendermint/tendermint/abci/types.Application.

Commits the transaction block to the chains.

func (*Accumulator) DeliverTx

func (app *Accumulator) DeliverTx(req abci.RequestDeliverTx) (rdt abci.ResponseDeliverTx)

DeliverTx implements github.com/tendermint/tendermint/abci/types.Application.

Verifies the transaction is valid.

func (*Accumulator) EndBlock

func (app *Accumulator) EndBlock(req abci.RequestEndBlock) abci.ResponseEndBlock

EndBlock implements github.com/tendermint/tendermint/abci/types.Application.

func (*Accumulator) Info

func (app *Accumulator) Info(abci.RequestInfo) abci.ResponseInfo

Info implements github.com/tendermint/tendermint/abci/types.Application.

func (*Accumulator) InitChain

func (app *Accumulator) InitChain(req abci.RequestInitChain) abci.ResponseInitChain

InitChain implements github.com/tendermint/tendermint/abci/types.Application.

Called when a chain is created.

func (*Accumulator) ListSnapshots

func (app *Accumulator) ListSnapshots(req abci.RequestListSnapshots) abci.ResponseListSnapshots

func (*Accumulator) LoadSnapshotChunk

func (app *Accumulator) LoadSnapshotChunk(req abci.RequestLoadSnapshotChunk) abci.ResponseLoadSnapshotChunk

LoadSnapshotChunk queries the node for the body of a snapshot.

func (*Accumulator) OfferSnapshot

func (app *Accumulator) OfferSnapshot(req abci.RequestOfferSnapshot) abci.ResponseOfferSnapshot

OfferSnapshot offers a snapshot to the node.

func (*Accumulator) OnFatal

func (app *Accumulator) OnFatal(f func(error))

FOR TESTING ONLY

func (*Accumulator) Query

func (app *Accumulator) Query(reqQuery abci.RequestQuery) (resQuery abci.ResponseQuery)

Query implements github.com/tendermint/tendermint/abci/types.Application.

Exposed as Tendermint RPC /abci_query.

type AccumulatorOptions

type AccumulatorOptions struct {
	*config.Config
	Tracer   trace.Tracer
	Executor execute.Executor
	EventBus *events.Bus
	Logger   log.Logger
	Database database.Beginner
	Address  crypto.Address // This is the address of this node, and is used to determine if the node is the leader
}