Documentation ¶
Overview ¶
Package state is a generated GoMock package.
Index ¶
- Constants
- Variables
- type BlockState
- type ChainState
- type HeightIndex
- type HeightIndexGetter
- type HeightIndexWriter
- type MockState
- func (m *MockState) DeleteBlock(arg0 ids.ID) error
- func (m *MockState) DeleteBlockIDAtHeight(arg0 uint64) 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) GetForkHeight() (uint64, error)
- func (m *MockState) GetLastAccepted() (ids.ID, error)
- func (m *MockState) GetMinimumHeight() (uint64, 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) SetForkHeight(arg0 uint64) error
- func (m *MockState) SetLastAccepted(arg0 ids.ID) error
- type MockStateMockRecorder
- func (mr *MockStateMockRecorder) DeleteBlock(arg0 any) *gomock.Call
- func (mr *MockStateMockRecorder) DeleteBlockIDAtHeight(arg0 any) *gomock.Call
- func (mr *MockStateMockRecorder) DeleteLastAccepted() *gomock.Call
- func (mr *MockStateMockRecorder) GetBlock(arg0 any) *gomock.Call
- func (mr *MockStateMockRecorder) GetBlockIDAtHeight(arg0 any) *gomock.Call
- func (mr *MockStateMockRecorder) GetForkHeight() *gomock.Call
- func (mr *MockStateMockRecorder) GetLastAccepted() *gomock.Call
- func (mr *MockStateMockRecorder) GetMinimumHeight() *gomock.Call
- func (mr *MockStateMockRecorder) PutBlock(arg0, arg1 any) *gomock.Call
- func (mr *MockStateMockRecorder) SetBlockIDAtHeight(arg0, arg1 any) *gomock.Call
- func (mr *MockStateMockRecorder) SetForkHeight(arg0 any) *gomock.Call
- func (mr *MockStateMockRecorder) SetLastAccepted(arg0 any) *gomock.Call
- type State
Constants ¶
const CodecVersion = 0
Variables ¶
var Codec codec.Manager
Functions ¶
This section is empty.
Types ¶
type BlockState ¶
type BlockState interface { GetBlock(blkID ids.ID) (block.Block, choices.Status, error) PutBlock(blk block.Block, status choices.Status) error DeleteBlock(blkID ids.ID) 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 ¶ added in v1.7.5
type HeightIndex interface { HeightIndexWriter HeightIndexGetter }
HeightIndex contains mapping of blockHeights to accepted proposer block IDs along with some metadata (fork height and checkpoint).
func NewHeightIndex ¶ added in v1.7.5
func NewHeightIndex(db database.Database, commitable versiondb.Commitable) HeightIndex
type HeightIndexGetter ¶ added in v1.7.5
type HeightIndexGetter interface { // GetMinimumHeight return the smallest height of an indexed blockID. If // there are no indexed blockIDs, ErrNotFound will be returned. GetMinimumHeight() (uint64, error) 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 ¶ added in v1.7.5
type MockState ¶ added in v1.8.3
type MockState struct {
// contains filtered or unexported fields
}
MockState is a mock of State interface.
func NewMockState ¶ added in v1.8.3
func NewMockState(ctrl *gomock.Controller) *MockState
NewMockState creates a new mock instance.
func (*MockState) DeleteBlock ¶ added in v1.10.10
DeleteBlock mocks base method.
func (*MockState) DeleteBlockIDAtHeight ¶ added in v1.10.10
DeleteBlockIDAtHeight mocks base method.
func (*MockState) DeleteLastAccepted ¶ added in v1.8.3
DeleteLastAccepted mocks base method.
func (*MockState) EXPECT ¶ added in v1.8.3
func (m *MockState) EXPECT() *MockStateMockRecorder
EXPECT returns an object that allows the caller to indicate expected use.
func (*MockState) GetBlockIDAtHeight ¶ added in v1.8.3
GetBlockIDAtHeight mocks base method.
func (*MockState) GetForkHeight ¶ added in v1.8.3
GetForkHeight mocks base method.
func (*MockState) GetLastAccepted ¶ added in v1.8.3
GetLastAccepted mocks base method.
func (*MockState) GetMinimumHeight ¶ added in v1.10.10
GetMinimumHeight mocks base method.
func (*MockState) SetBlockIDAtHeight ¶ added in v1.8.3
SetBlockIDAtHeight mocks base method.
func (*MockState) SetForkHeight ¶ added in v1.8.3
SetForkHeight mocks base method.
type MockStateMockRecorder ¶ added in v1.8.3
type MockStateMockRecorder struct {
// contains filtered or unexported fields
}
MockStateMockRecorder is the mock recorder for MockState.
func (*MockStateMockRecorder) DeleteBlock ¶ added in v1.10.10
func (mr *MockStateMockRecorder) DeleteBlock(arg0 any) *gomock.Call
DeleteBlock indicates an expected call of DeleteBlock.
func (*MockStateMockRecorder) DeleteBlockIDAtHeight ¶ added in v1.10.10
func (mr *MockStateMockRecorder) DeleteBlockIDAtHeight(arg0 any) *gomock.Call
DeleteBlockIDAtHeight indicates an expected call of DeleteBlockIDAtHeight.
func (*MockStateMockRecorder) DeleteLastAccepted ¶ added in v1.8.3
func (mr *MockStateMockRecorder) DeleteLastAccepted() *gomock.Call
DeleteLastAccepted indicates an expected call of DeleteLastAccepted.
func (*MockStateMockRecorder) GetBlock ¶ added in v1.8.3
func (mr *MockStateMockRecorder) GetBlock(arg0 any) *gomock.Call
GetBlock indicates an expected call of GetBlock.
func (*MockStateMockRecorder) GetBlockIDAtHeight ¶ added in v1.8.3
func (mr *MockStateMockRecorder) GetBlockIDAtHeight(arg0 any) *gomock.Call
GetBlockIDAtHeight indicates an expected call of GetBlockIDAtHeight.
func (*MockStateMockRecorder) GetForkHeight ¶ added in v1.8.3
func (mr *MockStateMockRecorder) GetForkHeight() *gomock.Call
GetForkHeight indicates an expected call of GetForkHeight.
func (*MockStateMockRecorder) GetLastAccepted ¶ added in v1.8.3
func (mr *MockStateMockRecorder) GetLastAccepted() *gomock.Call
GetLastAccepted indicates an expected call of GetLastAccepted.
func (*MockStateMockRecorder) GetMinimumHeight ¶ added in v1.10.10
func (mr *MockStateMockRecorder) GetMinimumHeight() *gomock.Call
GetMinimumHeight indicates an expected call of GetMinimumHeight.
func (*MockStateMockRecorder) PutBlock ¶ added in v1.8.3
func (mr *MockStateMockRecorder) PutBlock(arg0, arg1 any) *gomock.Call
PutBlock indicates an expected call of PutBlock.
func (*MockStateMockRecorder) SetBlockIDAtHeight ¶ added in v1.8.3
func (mr *MockStateMockRecorder) SetBlockIDAtHeight(arg0, arg1 any) *gomock.Call
SetBlockIDAtHeight indicates an expected call of SetBlockIDAtHeight.
func (*MockStateMockRecorder) SetForkHeight ¶ added in v1.8.3
func (mr *MockStateMockRecorder) SetForkHeight(arg0 any) *gomock.Call
SetForkHeight indicates an expected call of SetForkHeight.
func (*MockStateMockRecorder) SetLastAccepted ¶ added in v1.8.3
func (mr *MockStateMockRecorder) SetLastAccepted(arg0 any) *gomock.Call
SetLastAccepted indicates an expected call of SetLastAccepted.
type State ¶
type State interface { ChainState BlockState HeightIndex }
func NewMetered ¶
func NewMetered(db *versiondb.Database, namespace string, metrics prometheus.Registerer) (State, error)