app

package
v100.1.0 Latest Latest
Warning

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

 Go to latest Published: Sep 3, 2024 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

View Source 
const AbciReq = "abci-req"

Variables

This section is empty.

Functions

func GetABCIRequestFromString 

func GetABCIRequestFromString(s string) (*abci.Request, error)

GetABCIRequestFromString parse string and try to get a string of a Request created by GetRequestString.

func GetABCIRequestString 

func GetABCIRequestString(req *abci.Request) (string, error)

GetRequestString gets the string representation of the request that will be logged by the application.

Types

type Application 

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

Application is an ABCI application for use by end-to-end tests. It is a simple key/value store for strings, storing data in memory and persisting to disk as JSON, taking state sync snapshots if requested.

func NewApplication 

func NewApplication(cfg *Config) (*Application, error)

NewApplication creates the application.

func (*Application) ApplySnapshotChunk 

func (app *Application) ApplySnapshotChunk(_ context.Context, req *abci.ApplySnapshotChunkRequest) (*abci.ApplySnapshotChunkResponse, error)

ApplySnapshotChunk implements ABCI.

func (*Application) CheckTx 

func (app *Application) CheckTx(_ context.Context, req *abci.CheckTxRequest) (*abci.CheckTxResponse, error)

CheckTx implements ABCI.

func (*Application) Commit 

func (app *Application) Commit(_ context.Context, _ *abci.CommitRequest) (*abci.CommitResponse, error)

Commit implements ABCI.

func (*Application) ExtendVote 

func (app *Application) ExtendVote(_ context.Context, req *abci.ExtendVoteRequest) (*abci.ExtendVoteResponse, error)

ExtendVote will produce vote extensions in the form of random numbers to demonstrate vote extension nondeterminism.

In the next block, if there are any vote extensions from the previous block, a new transaction will be proposed that updates a special value in the key/value store ("extensionSum") with the sum of all of the numbers collected from the vote extensions.

func (*Application) FinalizeBlock 

func (app *Application) FinalizeBlock(_ context.Context, req *abci.FinalizeBlockRequest) (*abci.FinalizeBlockResponse, error)

FinalizeBlock implements ABCI.

func (*Application) Info 

func (app *Application) Info(context.Context, *abci.InfoRequest) (*abci.InfoResponse, error)

Info implements ABCI.

func (*Application) InitChain 

func (app *Application) InitChain(_ context.Context, req *abci.InitChainRequest) (*abci.InitChainResponse, error)

Info implements ABCI.

func (*Application) ListSnapshots 

func (app *Application) ListSnapshots(context.Context, *abci.ListSnapshotsRequest) (*abci.ListSnapshotsResponse, error)

ListSnapshots implements ABCI.

func (*Application) LoadSnapshotChunk 

func (app *Application) LoadSnapshotChunk(_ context.Context, req *abci.LoadSnapshotChunkRequest) (*abci.LoadSnapshotChunkResponse, error)

LoadSnapshotChunk implements ABCI.

func (*Application) OfferSnapshot 

func (app *Application) OfferSnapshot(_ context.Context, req *abci.OfferSnapshotRequest) (*abci.OfferSnapshotResponse, error)

OfferSnapshot implements ABCI.

func (*Application) PrepareProposal 

func (app *Application) PrepareProposal(
	_ context.Context, req *abci.PrepareProposalRequest,
) (*abci.PrepareProposalResponse, error)

PrepareProposal will take the given transactions and attempt to prepare a proposal from them when it's our turn to do so. If the current height has vote extension enabled, this method will use vote extensions from the previous height, passed from CometBFT as parameters to construct a special transaction whose value is the sum of all of the vote extensions from the previous round, if voteExtensionSize has not been specified or the sum of all vote extensions sizes, if a size has been specified.

Additionally, we verify the vote extension signatures passed from CometBFT and include all data necessary for such verification in the special transaction's payload so that ProcessProposal at other nodes can also verify the proposer constructed the special transaction correctly.

If vote extensions are enabled for the current height, PrepareProposal makes sure there was at least one non-empty vote extension whose signature it could verify. If vote extensions are not enabled for the current height, PrepareProposal makes sure non-empty vote extensions are not present.

The special vote extension-generated transaction must fit within an empty block and takes precedence over all other transactions coming from the mempool.

func (*Application) ProcessProposal 

func (app *Application) ProcessProposal(_ context.Context, req *abci.ProcessProposalRequest) (*abci.ProcessProposalResponse, error)

ProcessProposal implements part of the Application interface. It accepts any proposal that does not contain a malformed transaction. NOTE It is up to real Applications to effect punitive behavior in the cases ProcessProposal returns PROCESS_PROPOSAL_STATUS_REJECT, as it is evidence of misbehavior.

func (*Application) Query 

func (app *Application) Query(_ context.Context, req *abci.QueryRequest) (*abci.QueryResponse, error)

Query implements ABCI.

func (*Application) Rollback 

func (app *Application) Rollback() error

func (*Application) VerifyVoteExtension 

func (app *Application) VerifyVoteExtension(_ context.Context, req *abci.VerifyVoteExtensionRequest) (*abci.VerifyVoteExtensionResponse, error)

VerifyVoteExtension simply validates vote extensions from other validators without doing anything about them. In this case, it just makes sure that the vote extension is a well-formed integer value.

type Config 

type Config struct {
	// The directory with which state.json will be persisted in. Usually $HOME/.cometbft/data
	Dir string `toml:"dir"`

	// SnapshotInterval specifies the height interval at which the application
	// will take state sync snapshots. Defaults to 0 (disabled).
	SnapshotInterval uint64 `toml:"snapshot_interval"`

	// RetainBlocks specifies the number of recent blocks to retain. Defaults to
	// 0, which retains all blocks. Must be greater that PersistInterval,
	// SnapshotInterval and EvidenceAgeHeight.
	RetainBlocks uint64 `toml:"retain_blocks"`

	// KeyType sets the curve that will be used by validators.
	// Options are ed25519 & secp256k1
	KeyType string `toml:"key_type"`

	// PersistInterval specifies the height interval at which the application
	// will persist state to disk. Defaults to 1 (every height), setting this to
	// 0 disables state persistence.
	PersistInterval uint64 `toml:"persist_interval"`

	// ValidatorUpdates is a map of heights to validator names and their power,
	// and will be returned by the ABCI application. For example, the following
	// changes the power of validator01 and validator02 at height 1000:
	//
	// [validator_update.1000]
	// validator01 = 20
	// validator02 = 10
	//
	// Specifying height 0 returns the validator update during InitChain. The
	// application returns the validator updates as-is, i.e. removing a
	// validator must be done by returning it with power 0, and any validators
	// not specified are not changed.
	//
	// height <-> pubkey <-> voting power
	ValidatorUpdates map[string]map[string]uint8 `toml:"validator_update"`

	// Add artificial delays to each of the main ABCI calls to mimic computation time
	// of the application
	PrepareProposalDelay time.Duration `toml:"prepare_proposal_delay"`
	ProcessProposalDelay time.Duration `toml:"process_proposal_delay"`
	CheckTxDelay         time.Duration `toml:"check_tx_delay"`
	FinalizeBlockDelay   time.Duration `toml:"finalize_block_delay"`
	VoteExtensionDelay   time.Duration `toml:"vote_extension_delay"`

	// Vote extension padding size, to simulate different vote extension sizes.
	VoteExtensionSize uint `toml:"vote_extension_size"`

	// VoteExtensionsEnableHeight configures the first height during which
	// the chain will use and require vote extension data to be present
	// in precommit messages.
	VoteExtensionsEnableHeight int64 `toml:"vote_extensions_enable_height"`

	// VoteExtensionsUpdateHeight configures the height at which consensus
	// param VoteExtensionsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	VoteExtensionsUpdateHeight int64 `toml:"vote_extensions_update_height"`

	// Flag for enabling and disabling logging of ABCI requests.
	ABCIRequestsLoggingEnabled bool `toml:"abci_requests_logging_enabled"`

	// PbtsEnableHeight configures the first height during which
	// the chain will start using Proposer-Based Timestamps (PBTS)
	// to create and validate new blocks.
	PbtsEnableHeight int64 `toml:"pbts_enable_height"`

	// PbtsUpdateHeight configures the height at which consensus
	// param PbtsEnableHeight will be set.
	// -1 denotes it is set at genesis.
	// 0 denotes it is set at InitChain.
	PbtsUpdateHeight int64 `toml:"pbts_update_height"`
}

Config allows for the setting of high level parameters for running the e2e Application KeyType and ValidatorUpdates must be the same for all nodes running the same application.

func DefaultConfig 

func DefaultConfig(dir string) *Config

type SnapshotStore 

type SnapshotStore struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

SnapshotStore stores state sync snapshots. Snapshots are stored simply as JSON files, and chunks are generated on-the-fly by splitting the JSON data into fixed-size chunks.

func NewSnapshotStore 

func NewSnapshotStore(dir string) (*SnapshotStore, error)

NewSnapshotStore creates a new snapshot store.

func (*SnapshotStore) Create 

func (s *SnapshotStore) Create(state *State) (abci.Snapshot, error)

Create creates a snapshot of the given application state's key/value pairs.

func (*SnapshotStore) List 

func (s *SnapshotStore) List() ([]*abci.Snapshot, error)

List lists available snapshots.

func (*SnapshotStore) LoadChunk 

func (s *SnapshotStore) LoadChunk(height uint64, format uint32, chunk uint32) ([]byte, error)

LoadChunk loads a snapshot chunk.

func (*SnapshotStore) Prune 

func (s *SnapshotStore) Prune(n int) error

Prune removes old snapshots ensuring only the most recent n snapshots remain.

type State 

type State struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

State is the application state.

func NewState 

func NewState(dir string, persistInterval uint64) (*State, error)

NewState creates a new state.

func (*State) Commit 

func (s *State) Commit() (uint64, error)

Commit commits the current state.

func (*State) Export 

func (s *State) Export() ([]byte, uint64, []byte, error)

Export exports key/value pairs as JSON, used for state sync snapshots. Additionally returns the current height and hash of the state.

func (*State) Finalize 

func (s *State) Finalize() []byte

Finalize is called after applying a block, updating the height and returning the new app_hash.

func (*State) Get 

func (s *State) Get(key string) string

Get fetches a value. A missing value is returned as an empty string.

func (*State) GetHash 

func (s *State) GetHash() []byte

GetHash provides a thread-safe way of accessing a copy of the current state hash.

func (*State) Import 

func (s *State) Import(height uint64, jsonBytes []byte) error

Import imports key/value pairs from JSON bytes, used for InitChain.AppStateBytes and state sync snapshots. It also saves the state once imported.

func (*State) Info 

func (s *State) Info() (uint64, []byte)

Info returns both the height and hash simultaneously, and is used in the ABCI Info call.

func (*State) MarshalJSON 

func (s *State) MarshalJSON() ([]byte, error)

func (*State) Query 

func (s *State) Query(key string) (string, uint64)

Query is used in the ABCI Query call, and provides both the current height and the value associated with the given key.

func (*State) Rollback 

func (s *State) Rollback() error

func (*State) Set 

func (s *State) Set(key, value string)

Set sets a value. Setting an empty value is equivalent to deleting it.

func (*State) UnmarshalJSON 

func (s *State) UnmarshalJSON(b []byte) error

Source Files

View all Source files

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.