package
0.2501.0
Repository: https://github.com/oasisprotocol/oasis-core.git
Documentation: pkg.go.dev

# Functions

CometBFTChainID returns the CometBFT chain ID computed from chain context.
EventTypeForApp generates the ABCI event type for events belonging to the specified App.
FromCtx extracts an ABCI context from a context.Context if one has been set.
GetCometBFTGenesisDocument returns the CometBFT genesis document corresponding to the Oasis genesis document specified by the given genesis provider.
IsUnavailableStateError returns true if any error in err's chain is an unavailable state error.
NewBlock creates a new consensus.Block from a CometBFT block.
NewBlockContext creates a new block context.
NewCompositeGasAccountant creates a gas accountant that is composed of multiple gas accountants.
NewContext creates a new context.
NewEventBuilder returns a new EventBuilder for the given ABCI app.
NewGasAccountant creates a basic gas accountant.
NewImmutableState creates a new immutable state wrapper.
NewMockApplicationState creates a new mock application state for testing.
NewNopGasAccountant creates a no-op gas accountant that doesn't do any accounting.
NewServiceDescriptor creates a new consensus service descriptor.
NewStaticServiceDescriptor creates a new static consensus service descriptor.
NodeToP2PAddr converts an Oasis node descriptor to a CometBFT p2p address book entry.
PublicKeyToValidatorUpdate converts an Oasis node public key to a CometBFT validator update.
QueryForApp generates a cmtquery.Query for events belonging to the specified App.
UnavailableStateError wraps an error in an unavailable state error.

# Constants

BackendName is the consensus backend name.
ContextBeginBlock is BeginBlock context.
ContextCheckTx is CheckTx context.
ContextDeliverTx is DeliverTx context.
ContextEndBlock is EndBlock context.
ContextInitChain is InitChain context.
ContextInvalid is invalid context and should never be used.
ContextSimulateTx is SimulateTx context.
LogEventPeerExchangeDisabled is a log event that indicates that CometBFT's peer exchange has been disabled.

# Variables

ErrGasOverflow is the error returned if the gas counter would overflow.
ErrNoState is the error returned when state is nil.
ErrNoSubscribers is the error returned when publishing a message that noone is subscribed to.
ErrOutOfGas is the error returned if the caller is out of gas.
MessageExecuteSubcall is the message kind for requesting subcall execution.
MessageStateSyncCompleted is the message kind for when the node successfully performs a state sync.

# Structs

BaseServiceClient is a default ServiceClient implementation that provides noop implementations of all the delivery methods.
BlockContext can be used to store arbitrary key/value pairs for state that is needed while processing a block.
BlockInfo contains information about a block which is always present in block context.
BlockMeta is the CometBFT-specific per-block metadata that is exposed via the consensus API.
Context is the context of processing a transaction/block.
EventBuilder is a helper for constructing ABCI events.
ImmutableState is an immutable state wrapper.
MockApplicationStateConfig is the configuration for the mock application state.
NoopMessageDispatcher is a no-op message dispatcher that performs no dispatch.
ServiceEvent is a CometBFT-specific consensus.ServiceEvent.
SubcallInfo is the information about a subcall that should be executed.

# Interfaces

Application is the interface implemented by multiplexed Oasis-specific ABCI applications.
ApplicationQueryState is minimum methods required to service ApplicationState queries.
ApplicationState is the overall past, present and future state of all multiplexed applications.
Backend is a CometBFT consensus backend.
BlockContextKey is an interface for a block context key.
ExecutorCommitmentNotifier is an executor commitment notifier interface.
Extension is the interface implemented by application-specific extensions.
GasAccountant is a gas accountant interface.
MessageDispatcher is a message dispatcher interface.
MessageSubscriber is a message subscriber interface.
MockApplicationState is the mock application state interface.
ServiceClient is a consensus service client.
ServiceDescriptor is a CometBFT consensus service descriptor.
TogglableApplication is an application that can be disabled.
TogglableMessageSubscriber is a message subscriber that can be disabled.
TransactionAuthHandler is the interface for ABCI applications that handle authenticating transactions (checking nonces and fees).

# Type aliases

ContextMode is a context mode.