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
• type Accumulator
  • func NewAccumulator(db State, address crypto.Address, chain Chain, logger log.Logger) (*Accumulator, error)
  • 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() (resp abci.ResponseCommit)
  • func (app *Accumulator) DeliverTx(req abci.RequestDeliverTx) (rdt abci.ResponseDeliverTx)
  • func (app *Accumulator) EndBlock(req abci.RequestEndBlock) (resp abci.ResponseEndBlock)
  • func (app *Accumulator) Info(req 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) Query(reqQuery abci.RequestQuery) (resQuery abci.ResponseQuery)
• type BeginBlockRequest
• type Chain
• type EndBlockRequest
• type State

Constants

const Version uint64 = 0x1

Version is the version of the ABCI applications.

Types

type Accumulator

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

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

func NewAccumulator

func NewAccumulator(db State, address crypto.Address, chain Chain, logger log.Logger) (*Accumulator, error)

NewAccumulator returns a new Accumulator.

func (*Accumulator) ApplySnapshotChunk

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

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

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() (resp 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) (resp abci.ResponseEndBlock)

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

func (*Accumulator) Info

func (app *Accumulator) Info(req 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

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

func (*Accumulator) LoadSnapshotChunk

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

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

func (*Accumulator) OfferSnapshot

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

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

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 BeginBlockRequest

type BeginBlockRequest struct {
	IsLeader bool
	Height   int64
	Time     time.Time
}

type Chain

type Chain interface {
	Query(*apiQuery.Query) (k, v []byte, err error)

	BeginBlock(BeginBlockRequest)
	CheckTx(*transactions.GenTransaction) error
	DeliverTx(*transactions.GenTransaction) (*protocol.TxResult, error)
	EndBlock(EndBlockRequest)
	Commit() ([]byte, error)
}

type EndBlockRequest

type EndBlockRequest struct{}

type State

type State interface {
	// BlockIndex returns the current block index/height of the chain
	BlockIndex() int64

	// RootHash returns the root hash of the chain
	RootHash() []byte

	// AddStateEntry only used for genesis
	AddStateEntry(chainId *types.Bytes32, txHash *types.Bytes32, object *state.Object)

	// TODO I think this can be removed
	EnsureRootHash() []byte
}