common

Documentation

Index

• type BaseKeyValueStoreStateMachine
  • func NewBaseKeyValueStoreStateMachine(candidateView uint64, parentState protocol.KVStoreReader, ...) BaseKeyValueStoreStateMachine
  • func (m *BaseKeyValueStoreStateMachine) Build() (*transaction.DeferredBlockPersist, error)
  • func (m *BaseKeyValueStoreStateMachine) ParentState() protocol.KVStoreReader
  • func (m *BaseKeyValueStoreStateMachine) View() uint64

Types

type BaseKeyValueStoreStateMachine

type BaseKeyValueStoreStateMachine struct {
	EvolvingState protocol_state.KVStoreMutator
	// contains filtered or unexported fields
}

BaseKeyValueStoreStateMachine implements a subset of the KeyValueStoreStateMachine interface which is usually common to all state machines that operate on the KV store. All implementors can override the methods as needed.

func NewBaseKeyValueStoreStateMachine

func NewBaseKeyValueStoreStateMachine(
	candidateView uint64,
	parentState protocol.KVStoreReader,
	evolvingState protocol_state.KVStoreMutator,
) BaseKeyValueStoreStateMachine

NewBaseKeyValueStoreStateMachine creates a new instance of BaseKeyValueStoreStateMachine.

func (*BaseKeyValueStoreStateMachine) Build

func (m *BaseKeyValueStoreStateMachine) Build() (*transaction.DeferredBlockPersist, error)

Build is a no-op by default. If a state machine needs to persist data, it should override this method.

func (*BaseKeyValueStoreStateMachine) ParentState

func (m *BaseKeyValueStoreStateMachine) ParentState() protocol.KVStoreReader

ParentState returns parent state associated with this state machine.

func (*BaseKeyValueStoreStateMachine) View

func (m *BaseKeyValueStoreStateMachine) View() uint64

View returns the view associated with this state machine. The view of the state machine equals the view of the block carrying the respective updates.