atxsdata

Documentation

Index

• func NotMalicious(data *ATX, _ lockGuard) bool
• func Warmup(db sql.Executor, cache *Data) error
• type ATX
• type AtxFilter
• type Data
  • func New(opts ...Opt) *Data
  • func Warm(db *sql.Database, opts ...Opt) (*Data, error)
  • func (d *Data) Add(epoch types.EpochID, node types.NodeID, coinbase types.Address, ...) bool
  • func (d *Data) AddFromHeader(atx *types.ActivationTxHeader, nonce types.VRFPostIndex, malicious bool) bool
  • func (d *Data) Evicted() types.EpochID
  • func (d *Data) Get(epoch types.EpochID, atx types.ATXID) *ATX
  • func (d *Data) IsEvicted(epoch types.EpochID) bool
  • func (d *Data) IsMalicious(node types.NodeID) bool
  • func (d *Data) IterateInEpoch(epoch types.EpochID, fn func(types.ATXID, *ATX), filters ...AtxFilter)
  • func (d *Data) MissingInEpoch(epoch types.EpochID, atxs []types.ATXID) []types.ATXID
  • func (d *Data) OnEpoch(applied types.EpochID)
  • func (d *Data) SetMalicious(node types.NodeID)
  • func (d *Data) WeightForSet(epoch types.EpochID, set []types.ATXID) (uint64, []bool)
• type Opt
  • func WithCapacity(capacity types.EpochID) Opt
  • func WithCapacityFromLayers(window, epochSize uint32) Opt

Functions

func NotMalicious

func NotMalicious(data *ATX, _ lockGuard) bool

func Warmup

func Warmup(db sql.Executor, cache *Data) error

Types

type ATX

type ATX struct {
	Node               types.NodeID
	Coinbase           types.Address
	Weight             uint64
	BaseHeight, Height uint64
	Nonce              types.VRFPostIndex
	// contains filtered or unexported fields
}

SAFETY: all exported fields are read-only and are safe to read concurrently. Thanks to the fact that ATX is immutable, it is safe to return a pointer to it.

type AtxFilter

type AtxFilter func(*ATX, lockGuard) bool

AtxFilter is a function that filters atxs. The `lockGuard` prevents using the filter functions outside of the allowed context to prevent data races.

type Data

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

func New

func New(opts ...Opt) *Data

func Warm

func Warm(db *sql.Database, opts ...Opt) (*Data, error)

func (*Data) Add

func (d *Data) Add(
	epoch types.EpochID,
	node types.NodeID,
	coinbase types.Address,
	atx types.ATXID,
	weight, baseHeight, height uint64,
	nonce types.VRFPostIndex,
	malicious bool,
) bool

Add adds atx data to the store. Returns true if the atx was added to the store.

func (*Data) AddFromHeader

func (d *Data) AddFromHeader(atx *types.ActivationTxHeader, nonce types.VRFPostIndex, malicious bool) bool

AddFromVerified extracts relevant fields from verified atx and adds them together with nonce and malicious flag. Returns true if the atx was added to the store.

func (*Data) Evicted

func (d *Data) Evicted() types.EpochID

func (*Data) Get

func (d *Data) Get(epoch types.EpochID, atx types.ATXID) *ATX

Get returns atx data. SAFETY: The returned pointer MUST NOT be modified.

func (*Data) IsEvicted

func (d *Data) IsEvicted(epoch types.EpochID) bool

func (*Data) IsMalicious

func (d *Data) IsMalicious(node types.NodeID) bool

func (*Data) IterateInEpoch

func (d *Data) IterateInEpoch(epoch types.EpochID, fn func(types.ATXID, *ATX), filters ...AtxFilter)

IterateInEpoch calls `fn` for every ATX in epoch. If filters are provided, only atxs that pass all filters are returned. SAFETY: The returned pointer MUST NOT be modified.

func (*Data) MissingInEpoch

func (d *Data) MissingInEpoch(epoch types.EpochID, atxs []types.ATXID) []types.ATXID

func (*Data) OnEpoch

func (d *Data) OnEpoch(applied types.EpochID)

OnEpoch is a notification for cache to evict epochs that are not useful to keep in memory.

func (*Data) SetMalicious

func (d *Data) SetMalicious(node types.NodeID)

func (*Data) WeightForSet

func (d *Data) WeightForSet(epoch types.EpochID, set []types.ATXID) (uint64, []bool)

WeightForSet computes total weight of atxs in the set and returned array with atxs in the set that weren't used.

type Opt

type Opt func(*Data)

func WithCapacity

func WithCapacity(capacity types.EpochID) Opt

WithCapacity sets the number of epochs from the latest applied that cache will maintain in memory.

func WithCapacityFromLayers

func WithCapacityFromLayers(window, epochSize uint32) Opt

WithCapacityFromLayers sets capacity to include all layers in the window.