common

Documentation

Index

• type ModuleConfig
• type ModuleParams
• type State

Types

type ModuleConfig

type ModuleConfig struct {
	Self   t.ModuleID // id of this module
	Hasher t.ModuleID
}

ModuleConfig sets the module ids. All replicas are expected to use identical module configurations.

type ModuleParams

type ModuleParams struct {
	MaxTransactionsInBatch int

	// If this parameter is not nil, the mempool will not receive transactions directly (through NewRequests) events.
	// On reception of such an event, it will report an error (making the system crash).
	// Instead, TxFetcher will be called to pull transactions from an external source
	// when they are needed to form a batch (upon the RequestBatch event).
	// Looking up transactions by ID will also always fail (return no transactions).
	TxFetcher func() []*requestpbtypes.Request
}

ModuleParams sets the values for the parameters of an instance of the protocol. All replicas are expected to use identical module parameters.

type State

type State struct {
	TxByID map[string]*requestpbtypes.Request
}

State represents the common state accessible to all parts of the module implementation.