state

Documentation

Overview

Package state is a generated GoMock package.

Index

• type BlockState
  • func NewBlockState(db database.Database) BlockState
  • func NewMeteredBlockState(db database.Database, namespace string, metrics prometheus.Registerer) (BlockState, error)
• type ChainState
  • func NewChainState(db database.Database) ChainState
• type HeightIndex
  • func NewHeightIndex(db database.Database, commitable versiondb.Commitable) HeightIndex
• type HeightIndexBatchSupport
• type HeightIndexGetter
• type HeightIndexWriter
• type MockState
  • func NewMockState(ctrl *gomock.Controller) *MockState
  • func (m *MockState) Commit() error
  • func (m *MockState) DeleteCheckpoint() error
  • func (m *MockState) DeleteLastAccepted() error
  • func (m *MockState) EXPECT() *MockStateMockRecorder
  • func (m *MockState) GetBlock(arg0 ids.ID) (block.Block, choices.Status, error)
  • func (m *MockState) GetBlockIDAtHeight(arg0 uint64) (ids.ID, error)
  • func (m *MockState) GetCheckpoint() (ids.ID, error)
  • func (m *MockState) GetForkHeight() (uint64, error)
  • func (m *MockState) GetLastAccepted() (ids.ID, error)
  • func (m *MockState) PutBlock(arg0 block.Block, arg1 choices.Status) error
  • func (m *MockState) SetBlockIDAtHeight(arg0 uint64, arg1 ids.ID) error
  • func (m *MockState) SetCheckpoint(arg0 ids.ID) error
  • func (m *MockState) SetForkHeight(arg0 uint64) error
  • func (m *MockState) SetLastAccepted(arg0 ids.ID) error
• type MockStateMockRecorder
  • func (mr *MockStateMockRecorder) Commit() *gomock.Call
  • func (mr *MockStateMockRecorder) DeleteCheckpoint() *gomock.Call
  • func (mr *MockStateMockRecorder) DeleteLastAccepted() *gomock.Call
  • func (mr *MockStateMockRecorder) GetBlock(arg0 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) GetBlockIDAtHeight(arg0 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) GetCheckpoint() *gomock.Call
  • func (mr *MockStateMockRecorder) GetForkHeight() *gomock.Call
  • func (mr *MockStateMockRecorder) GetLastAccepted() *gomock.Call
  • func (mr *MockStateMockRecorder) PutBlock(arg0, arg1 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) SetBlockIDAtHeight(arg0, arg1 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) SetCheckpoint(arg0 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) SetForkHeight(arg0 interface{}) *gomock.Call
  • func (mr *MockStateMockRecorder) SetLastAccepted(arg0 interface{}) *gomock.Call
• type State
  • func New(db *versiondb.Database) State
  • func NewMetered(db *versiondb.Database, namespace string, metrics prometheus.Registerer) (State, error)

Types

type BlockState

type BlockState interface {
	GetBlock(blkID ids.ID) (block.Block, choices.Status, error)
	PutBlock(blk block.Block, status choices.Status) error
}

func NewBlockState

func NewBlockState(db database.Database) BlockState

func NewMeteredBlockState

func NewMeteredBlockState(db database.Database, namespace string, metrics prometheus.Registerer) (BlockState, error)

type ChainState

type ChainState interface {
	SetLastAccepted(blkID ids.ID) error
	DeleteLastAccepted() error
	GetLastAccepted() (ids.ID, error)
}

func NewChainState

func NewChainState(db database.Database) ChainState

type HeightIndex

type HeightIndex interface {
	HeightIndexWriter
	HeightIndexGetter
	HeightIndexBatchSupport
}

HeightIndex contains mapping of blockHeights to accepted proposer block IDs along with some metadata (fork height and checkpoint).

func NewHeightIndex

func NewHeightIndex(db database.Database, commitable versiondb.Commitable) HeightIndex

type HeightIndexBatchSupport

type HeightIndexBatchSupport interface {
	versiondb.Commitable

	GetCheckpoint() (ids.ID, error)
	SetCheckpoint(blkID ids.ID) error
	DeleteCheckpoint() error
}

A checkpoint is the blockID of the next block to be considered for height indexing. We store checkpoints to be able to duly resume long-running re-indexing ops.

type HeightIndexGetter

type HeightIndexGetter interface {
	GetBlockIDAtHeight(height uint64) (ids.ID, error)

	// Fork height is stored when the first post-fork block/option is accepted.
	// Before that, fork height won't be found.
	GetForkHeight() (uint64, error)
}

type HeightIndexWriter

type HeightIndexWriter interface {
	SetBlockIDAtHeight(height uint64, blkID ids.ID) error
	SetForkHeight(height uint64) error
}

type MockState

type MockState struct {
	// contains filtered or unexported fields
}

MockState is a mock of State interface.

func NewMockState

func NewMockState(ctrl *gomock.Controller) *MockState

NewMockState creates a new mock instance.

func (*MockState) Commit

func (m *MockState) Commit() error

Commit mocks base method.

func (*MockState) DeleteCheckpoint

func (m *MockState) DeleteCheckpoint() error

DeleteCheckpoint mocks base method.

func (*MockState) DeleteLastAccepted

func (m *MockState) DeleteLastAccepted() error

DeleteLastAccepted mocks base method.

func (*MockState) EXPECT

func (m *MockState) EXPECT() *MockStateMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockState) GetBlock

func (m *MockState) GetBlock(arg0 ids.ID) (block.Block, choices.Status, error)

GetBlock mocks base method.

func (*MockState) GetBlockIDAtHeight

func (m *MockState) GetBlockIDAtHeight(arg0 uint64) (ids.ID, error)

GetBlockIDAtHeight mocks base method.

func (*MockState) GetCheckpoint

func (m *MockState) GetCheckpoint() (ids.ID, error)

GetCheckpoint mocks base method.

func (*MockState) GetForkHeight

func (m *MockState) GetForkHeight() (uint64, error)

GetForkHeight mocks base method.

func (*MockState) GetLastAccepted

func (m *MockState) GetLastAccepted() (ids.ID, error)

GetLastAccepted mocks base method.

func (*MockState) PutBlock

func (m *MockState) PutBlock(arg0 block.Block, arg1 choices.Status) error

PutBlock mocks base method.

func (*MockState) SetBlockIDAtHeight

func (m *MockState) SetBlockIDAtHeight(arg0 uint64, arg1 ids.ID) error

SetBlockIDAtHeight mocks base method.

func (*MockState) SetCheckpoint

func (m *MockState) SetCheckpoint(arg0 ids.ID) error

SetCheckpoint mocks base method.

func (*MockState) SetForkHeight

func (m *MockState) SetForkHeight(arg0 uint64) error

SetForkHeight mocks base method.

func (*MockState) SetLastAccepted

func (m *MockState) SetLastAccepted(arg0 ids.ID) error

SetLastAccepted mocks base method.

type MockStateMockRecorder

type MockStateMockRecorder struct {
	// contains filtered or unexported fields
}

MockStateMockRecorder is the mock recorder for MockState.

func (*MockStateMockRecorder) Commit

func (mr *MockStateMockRecorder) Commit() *gomock.Call

Commit indicates an expected call of Commit.

func (*MockStateMockRecorder) DeleteCheckpoint

func (mr *MockStateMockRecorder) DeleteCheckpoint() *gomock.Call

DeleteCheckpoint indicates an expected call of DeleteCheckpoint.

func (*MockStateMockRecorder) DeleteLastAccepted

func (mr *MockStateMockRecorder) DeleteLastAccepted() *gomock.Call

DeleteLastAccepted indicates an expected call of DeleteLastAccepted.

func (*MockStateMockRecorder) GetBlock

func (mr *MockStateMockRecorder) GetBlock(arg0 interface{}) *gomock.Call

GetBlock indicates an expected call of GetBlock.

func (*MockStateMockRecorder) GetBlockIDAtHeight

func (mr *MockStateMockRecorder) GetBlockIDAtHeight(arg0 interface{}) *gomock.Call

GetBlockIDAtHeight indicates an expected call of GetBlockIDAtHeight.

func (*MockStateMockRecorder) GetCheckpoint

func (mr *MockStateMockRecorder) GetCheckpoint() *gomock.Call

GetCheckpoint indicates an expected call of GetCheckpoint.

func (*MockStateMockRecorder) GetForkHeight

func (mr *MockStateMockRecorder) GetForkHeight() *gomock.Call

GetForkHeight indicates an expected call of GetForkHeight.

func (*MockStateMockRecorder) GetLastAccepted

func (mr *MockStateMockRecorder) GetLastAccepted() *gomock.Call

GetLastAccepted indicates an expected call of GetLastAccepted.

func (*MockStateMockRecorder) PutBlock

func (mr *MockStateMockRecorder) PutBlock(arg0, arg1 interface{}) *gomock.Call

PutBlock indicates an expected call of PutBlock.

func (*MockStateMockRecorder) SetBlockIDAtHeight

func (mr *MockStateMockRecorder) SetBlockIDAtHeight(arg0, arg1 interface{}) *gomock.Call

SetBlockIDAtHeight indicates an expected call of SetBlockIDAtHeight.

func (*MockStateMockRecorder) SetCheckpoint

func (mr *MockStateMockRecorder) SetCheckpoint(arg0 interface{}) *gomock.Call

SetCheckpoint indicates an expected call of SetCheckpoint.

func (*MockStateMockRecorder) SetForkHeight

func (mr *MockStateMockRecorder) SetForkHeight(arg0 interface{}) *gomock.Call

SetForkHeight indicates an expected call of SetForkHeight.

func (*MockStateMockRecorder) SetLastAccepted

func (mr *MockStateMockRecorder) SetLastAccepted(arg0 interface{}) *gomock.Call

SetLastAccepted indicates an expected call of SetLastAccepted.

type State

type State interface {
	ChainState
	BlockState
	HeightIndex
}

func New

func New(db *versiondb.Database) State

func NewMetered

func NewMetered(db *versiondb.Database, namespace string, metrics prometheus.Registerer) (State, error)