Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdditionalOperationsModule ¶
type AdditionalOperationsModule interface { // RunAdditionalOperations runs all the additional operations required by the module. // This is the perfect place where to initialize all the operations that subscribe to websockets or other // external sources. // NOTE. This method will only be run ONCE before starting the parsing of the blocks. RunAdditionalOperations() error }
type AsyncOperationsModule ¶
type AsyncOperationsModule interface { // RunAsyncOperations runs all the async operations associated with a module. // This method will be run on a separate goroutine, that will stop only when the user stops the entire process. // For this reason, this method cannot return an error, and all raised errors should be signaled by panicking. RunAsyncOperations() }
type AuthzMessageModule ¶
type AuthzMessageModule interface { // HandleMsgExec handles a single message that is contained within an authz.MsgExec instance. // For convenience of use, the index of the message inside the transaction and the transaction itself // are passed as well. // NOTE. The returned error will be logged using the MsgError method. All other modules' handlers // will still be called. HandleMsgExec(index int, authzMsgIndex int, executedMsg types.Message, tx *types.Transaction) error }
type BlockModule ¶
type BlockModule interface { // HandleBlock allows to handle a single block. // For convenience of use, all the transactions present inside the given block will be passed as well. // For each transaction present inside the block, HandleTx will be called as well. // NOTE. The returned error will be logged using the BlockError method. All other modules' handlers // will still be called. HandleBlock(block *tmctypes.ResultBlock, results *tmctypes.ResultBlockResults, txs []*types.Transaction, vals *tmctypes.ResultValidators) error }
type FastSyncModule ¶
type FastSyncModule interface { // DownloadState allows to download the module state at the given height. // This will be called only when the fast sync is used, and only once for the initial height. // It should query the gRPC and get all the possible data. // NOTE. If an error is returned, following modules will still be called. DownloadState(height int64) error }
type GenesisModule ¶
type GenesisModule interface { // HandleGenesis allows to handle the genesis state. // For convenience of use, the already-unmarshalled AppState is provided along with the full GenesisDoc. // NOTE. The returned error will be logged using the GenesisError method. All other modules' handlers // will still be called. HandleGenesis(doc *tmtypes.GenesisDoc, appState map[string]json.RawMessage) error }
type MessageModule ¶
type MessageModule interface { // HandleMsg handles a single message. // For convenience of use, the index of the message inside the transaction and the transaction itself // are passed as well. // NOTE. The returned error will be logged using the MsgError method. All other modules' handlers // will still be called. HandleMsg(index int, msg types.Message, tx *types.Transaction) error }
type Module ¶
type Module interface { // Name returns the module name Name() string }
Module represents a generic module without any particular handling of data
type PeriodicOperationsModule ¶
type PeriodicOperationsModule interface { // RegisterPeriodicOperations allows to register all the operations that will be run on a periodic basis. // The given scheduler can be used to define the periodicity of each task. // NOTE. This method will only be run ONCE during the module initialization. RegisterPeriodicOperations(scheduler *gocron.Scheduler) error }
type TransactionModule ¶
type TransactionModule interface { // HandleTx handles a single transaction. // For each message present inside the transaction, HandleMsg will be called as well. // NOTE. The returned error will be logged using the TxError method. All other modules' handlers // will still be called. HandleTx(tx *types.Transaction) error }
Click to show internal directories.
Click to hide internal directories.