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(_ context.Context, req *abci.RequestApplySnapshotChunk) (*abci.ResponseApplySnapshotChunk, error)
  • func (app *Accumulator) CheckTx(_ context.Context, req *abci.RequestCheckTx) (rct *abci.ResponseCheckTx, err error)
  • func (app *Accumulator) Commit(_ context.Context, req *abci.RequestCommit) (*abci.ResponseCommit, error)
  • func (app *Accumulator) FinalizeBlock(_ context.Context, req *abci.RequestFinalizeBlock) (*abci.ResponseFinalizeBlock, error)
  • func (app *Accumulator) Info(context.Context, *abci.RequestInfo) (*abci.ResponseInfo, error)
  • func (app *Accumulator) InitChain(_ context.Context, req *abci.RequestInitChain) (*abci.ResponseInitChain, error)
  • func (app *Accumulator) ListSnapshots(_ context.Context, req *abci.RequestListSnapshots) (*abci.ResponseListSnapshots, error)
  • func (app *Accumulator) LoadSnapshotChunk(_ context.Context, req *abci.RequestLoadSnapshotChunk) (*abci.ResponseLoadSnapshotChunk, error)
  • func (app *Accumulator) OfferSnapshot(_ context.Context, req *abci.RequestOfferSnapshot) (*abci.ResponseOfferSnapshot, error)
  • func (app *Accumulator) OnFatal(f func(error))
  • func (app *Accumulator) Query(_ context.Context, reqQuery *abci.RequestQuery) (*abci.ResponseQuery, error)
• type AccumulatorOptions
• type RequestBeginBlock
• type ResponseEndBlock

Constants

const Version uint64 = 0x2

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(_ context.Context, req *abci.RequestApplySnapshotChunk) (*abci.ResponseApplySnapshotChunk, error)

ApplySnapshotChunk applies a snapshot to the node.

func (*Accumulator) CheckTx

func (app *Accumulator) CheckTx(_ context.Context, req *abci.RequestCheckTx) (rct *abci.ResponseCheckTx, err error)

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

Verifies the transaction is sane.

func (*Accumulator) Commit

func (app *Accumulator) Commit(_ context.Context, req *abci.RequestCommit) (*abci.ResponseCommit, error)

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

Commits the transaction block to the chains.

func (*Accumulator) FinalizeBlock

func (app *Accumulator) FinalizeBlock(_ context.Context, req *abci.RequestFinalizeBlock) (*abci.ResponseFinalizeBlock, error)

func (*Accumulator) Info

func (app *Accumulator) Info(context.Context, *abci.RequestInfo) (*abci.ResponseInfo, error)

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

func (*Accumulator) InitChain

func (app *Accumulator) InitChain(_ context.Context, req *abci.RequestInitChain) (*abci.ResponseInitChain, error)

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

Called when a chain is created.

func (*Accumulator) ListSnapshots

func (app *Accumulator) ListSnapshots(_ context.Context, req *abci.RequestListSnapshots) (*abci.ResponseListSnapshots, error)

func (*Accumulator) LoadSnapshotChunk

func (app *Accumulator) LoadSnapshotChunk(_ context.Context, req *abci.RequestLoadSnapshotChunk) (*abci.ResponseLoadSnapshotChunk, error)

LoadSnapshotChunk queries the node for the body of a snapshot.

func (*Accumulator) OfferSnapshot

func (app *Accumulator) OfferSnapshot(_ context.Context, req *abci.RequestOfferSnapshot) (*abci.ResponseOfferSnapshot, error)

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(_ context.Context, reqQuery *abci.RequestQuery) (*abci.ResponseQuery, error)

Query implements github.com/cometbft/cometbft/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
}

type RequestBeginBlock

type RequestBeginBlock struct {
	Header              *abci.RequestFinalizeBlock
	LastCommitInfo      abci.CommitInfo
	ByzantineValidators []abci.Misbehavior
}

type ResponseEndBlock

type ResponseEndBlock struct {
	ValidatorUpdates []abci.ValidatorUpdate
}