datastore

Documentation

Overview

Package datastore is a generated GoMock package.

Index

• Variables
• type BlobStore
  • func NewBlobStore(db sql.StateDatabase, proposals *store.Store) *BlobStore
  • func (bs *BlobStore) GetBlobSizes(hint Hint, ids [][]byte) (sizes []int, err error)
  • func (bs *BlobStore) Has(hint Hint, key []byte) (bool, error)
  • func (bs *BlobStore) LoadBlob(ctx context.Context, hint Hint, key []byte, blob *sql.Blob) error
  • func (bs *BlobStore) SetMalfeasanceProvider(p MalfeasanceProvider)
• type CachedDB
  • func NewCachedDB(db sql.StateDatabase, lg *zap.Logger, opts ...Opt) *CachedDB
  • func (db *CachedDB) CacheMalfeasanceProof(id types.NodeID, proof []byte)
  • func (db *CachedDB) GetAtx(id types.ATXID) (*types.ActivationTx, error)
  • func (db *CachedDB) IterateMalfeasanceProofs(iter func(types.NodeID, []byte) error) error
  • func (db *CachedDB) MalfeasanceProof(id types.NodeID) ([]byte, error)
  • func (db *CachedDB) MaxHeightAtx() (types.ATXID, error)
  • func (db *CachedDB) Previous(id types.ATXID) ([]types.ATXID, error)
  • func (db *CachedDB) VRFNonce(id types.NodeID, epoch types.EpochID) (types.VRFPostIndex, error)
• type Config
  • func DefaultConfig() Config
• type Hint
• type MalfeasanceProvider
• type MockMalfeasanceProvider
  • func NewMockMalfeasanceProvider(ctrl *gomock.Controller) *MockMalfeasanceProvider
  • func (m *MockMalfeasanceProvider) EXPECT() *MockMalfeasanceProviderMockRecorder
  • func (m *MockMalfeasanceProvider) ProofByID(ctx context.Context, nodeID types.NodeID) ([]byte, error)
• type MockMalfeasanceProviderMockRecorder
  • func (mr *MockMalfeasanceProviderMockRecorder) ProofByID(ctx, nodeID any) *MockMalfeasanceProviderProofByIDCall
• type MockMalfeasanceProviderProofByIDCall
  • func (c *MockMalfeasanceProviderProofByIDCall) Do(f func(context.Context, types.NodeID) ([]byte, error)) *MockMalfeasanceProviderProofByIDCall
  • func (c *MockMalfeasanceProviderProofByIDCall) DoAndReturn(f func(context.Context, types.NodeID) ([]byte, error)) *MockMalfeasanceProviderProofByIDCall
  • func (c *MockMalfeasanceProviderProofByIDCall) Return(arg0 []byte, arg1 error) *MockMalfeasanceProviderProofByIDCall
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithConsensusCache(c *atxsdata.Data) Opt
• type VrfNonceKey

Variables

var ErrNotFound = errors.New("not found")

Types

type BlobStore

type BlobStore struct {
	DB sql.StateDatabase
	// contains filtered or unexported fields
}

BlobStore gets data as a blob to serve direct fetch requests.

func NewBlobStore

func NewBlobStore(db sql.StateDatabase, proposals *store.Store) *BlobStore

NewBlobStore returns a BlobStore.

func (*BlobStore) GetBlobSizes

func (bs *BlobStore) GetBlobSizes(hint Hint, ids [][]byte) (sizes []int, err error)

GetBlobSizes returns the sizes of the blobs corresponding to the specified ids. For non-existent objects, the corresponding items are set to -1.

func (*BlobStore) Has

func (bs *BlobStore) Has(hint Hint, key []byte) (bool, error)

func (*BlobStore) LoadBlob

func (bs *BlobStore) LoadBlob(ctx context.Context, hint Hint, key []byte, blob *sql.Blob) error

LoadBlob gets an blob as bytes by an object ID as bytes.

func (*BlobStore) SetMalfeasanceProvider

func (bs *BlobStore) SetMalfeasanceProvider(p MalfeasanceProvider)

SetMalfeasanceProvider sets the malfeasance provider dependency.

TODO(mafa): this is a hack because of a cyclic dependency between the packages

malfeasance2 -> fetcher -> datastore -> malfeasance2

type CachedDB

type CachedDB struct {
	sql.Database
	// contains filtered or unexported fields
}

CachedDB is simply a database injected with cache.

func NewCachedDB

func NewCachedDB(db sql.StateDatabase, lg *zap.Logger, opts ...Opt) *CachedDB

NewCachedDB create an instance of a CachedDB.

func (*CachedDB) CacheMalfeasanceProof

func (db *CachedDB) CacheMalfeasanceProof(id types.NodeID, proof []byte)

CacheMalfeasanceProof caches the malfeasance proof for the given node ID. This function is thread safe. Deprecated: caching is done by the sql database automatically.

func (*CachedDB) GetAtx

func (db *CachedDB) GetAtx(id types.ATXID) (*types.ActivationTx, error)

GetAtx returns the ATX by the given ID. This function is thread safe and will return an error if the ID is not found in the ATX DB.

func (*CachedDB) IterateMalfeasanceProofs

func (db *CachedDB) IterateMalfeasanceProofs(
	iter func(types.NodeID, []byte) error,
) error

IterateMalfeasanceProofs iterates over all malfeasance proofs in the database and calls the provided callback on each. Deprecated: replaced by identities.IterateOps and malfeasance.IterateOps.

func (*CachedDB) MalfeasanceProof

func (db *CachedDB) MalfeasanceProof(id types.NodeID) ([]byte, error)

MalfeasanceProof returns the malfeasance proof for the given node ID. This function is thread safe and will return an error if the proof is not found in the ATX DB. Deprecated: use functions in the `sql/identities` and `sql/malfeasance` packages.

func (*CachedDB) MaxHeightAtx

func (db *CachedDB) MaxHeightAtx() (types.ATXID, error)

MaxHeightAtx returns the ATX ID with the maximum height. Deprecated: replaced by atxs.GetIDWithMaxHeight.

func (*CachedDB) Previous

func (db *CachedDB) Previous(id types.ATXID) ([]types.ATXID, error)

Previous retrieves the list of previous ATXs for the given ATX ID. Deprecated: replaced by atxs.Previous.

func (*CachedDB) VRFNonce

func (db *CachedDB) VRFNonce(id types.NodeID, epoch types.EpochID) (types.VRFPostIndex, error)

VRFNonce returns the VRF nonce of for the given node in the given epoch. This function is thread safe and will return an error if the nonce is not found in the ATX DB.

type Config

type Config struct {
	// ATXSize must be larger than the sum of all ATXs in last 2 epochs to be effective
	ATXSize         int `mapstructure:"atx-size"`
	MalfeasanceSize int `mapstructure:"malfeasance-size"`
}

func DefaultConfig

func DefaultConfig() Config

type Hint

type Hint string

Hint marks which DB should be queried for a certain provided hash.

const (
	NoHint            Hint = ""
	BallotDB          Hint = "ballotDB"
	BlockDB           Hint = "blocksDB"
	ProposalDB        Hint = "proposalDB"
	ATXDB             Hint = "ATXDB"
	TXDB              Hint = "TXDB"
	POETDB            Hint = "POETDB"
	LegacyMalfeasance Hint = "malfeasance"
	Malfeasance       Hint = "malfeasance2"
	ActiveSet         Hint = "activeset"
)

DB hints per DB.

type MalfeasanceProvider

type MalfeasanceProvider interface {
	ProofByID(ctx context.Context, nodeID types.NodeID) ([]byte, error)
}

type MockMalfeasanceProvider

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

MockMalfeasanceProvider is a mock of MalfeasanceProvider interface.

func NewMockMalfeasanceProvider

func NewMockMalfeasanceProvider(ctrl *gomock.Controller) *MockMalfeasanceProvider

NewMockMalfeasanceProvider creates a new mock instance.

func (*MockMalfeasanceProvider) EXPECT

func (m *MockMalfeasanceProvider) EXPECT() *MockMalfeasanceProviderMockRecorder

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

func (*MockMalfeasanceProvider) ProofByID

func (m *MockMalfeasanceProvider) ProofByID(ctx context.Context, nodeID types.NodeID) ([]byte, error)

ProofByID mocks base method.

type MockMalfeasanceProviderMockRecorder

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

MockMalfeasanceProviderMockRecorder is the mock recorder for MockMalfeasanceProvider.

func (*MockMalfeasanceProviderMockRecorder) ProofByID

func (mr *MockMalfeasanceProviderMockRecorder) ProofByID(ctx, nodeID any) *MockMalfeasanceProviderProofByIDCall

ProofByID indicates an expected call of ProofByID.

type MockMalfeasanceProviderProofByIDCall

type MockMalfeasanceProviderProofByIDCall struct {
	*gomock.Call
}

MockMalfeasanceProviderProofByIDCall wrap *gomock.Call

func (*MockMalfeasanceProviderProofByIDCall) Do

func (c *MockMalfeasanceProviderProofByIDCall) Do(f func(context.Context, types.NodeID) ([]byte, error)) *MockMalfeasanceProviderProofByIDCall

Do rewrite *gomock.Call.Do

func (*MockMalfeasanceProviderProofByIDCall) DoAndReturn

func (c *MockMalfeasanceProviderProofByIDCall) DoAndReturn(f func(context.Context, types.NodeID) ([]byte, error)) *MockMalfeasanceProviderProofByIDCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockMalfeasanceProviderProofByIDCall) Return

func (c *MockMalfeasanceProviderProofByIDCall) Return(arg0 []byte, arg1 error) *MockMalfeasanceProviderProofByIDCall

Return rewrite *gomock.Call.Return

type Opt

type Opt func(*cacheOpts)

func WithConfig

func WithConfig(cfg Config) Opt

func WithConsensusCache

func WithConsensusCache(c *atxsdata.Data) Opt

type VrfNonceKey

type VrfNonceKey struct {
	ID    types.NodeID
	Epoch types.EpochID
}