atxs

Documentation

Index

• Constants
• func Add(db sql.Executor, atx *types.ActivationTx) error
• func AddCheckpointed(db sql.Executor, catx *CheckpointAtx) error
• func All(db sql.Executor) ([]types.ATXID, error)
• func AtxAdded(db sql.Executor, atx *types.ActivationTx)
• func Coinbase(db sql.Executor, id types.NodeID) (types.Address, error)
• func CommitmentATX(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)
• func CountAtxsByOps(db sql.Executor, operations builder.Operations) (count uint32, err error)
• func FilterAll(types.ATXID) bool
• func Get(db sql.Executor, id types.ATXID) (*types.ActivationTx, error)
• func GetBlobSizes(db sql.Executor, ids [][]byte) (sizes []int, err error)
• func GetByEpochAndNodeID(db sql.Executor, epoch types.EpochID, nodeID types.NodeID) (types.ATXID, error)
• func GetFirstIDByNodeID(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)
• func GetIDByEpochAndNodeID(db sql.Executor, epoch types.EpochID, nodeID types.NodeID) (id types.ATXID, err error)
• func GetIDWithMaxHeight(db sql.Executor, pref types.NodeID, filter Filter) (types.ATXID, error)
• func GetIDsByEpoch(ctx context.Context, db sql.Executor, epoch types.EpochID) (ids []types.ATXID, err error)
• func GetLastIDByNodeID(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)
• func Has(db sql.Executor, id types.ATXID) (bool, error)
• func IdentityExists(db sql.Executor, nodeID types.NodeID) (bool, error)
• func IterateAtxIdsWithMalfeasance(db sql.Executor, publish types.EpochID, ...) error
• func IterateAtxsData(db sql.Executor, from, to types.EpochID, ...) error
• func IterateAtxsOps(db sql.Executor, operations builder.Operations, ...) error
• func IterateAtxsWithMalfeasance(db sql.Executor, publish types.EpochID, ...) error
• func IterateForGrading(db sql.Executor, epoch types.EpochID, ...) error
• func LatestEpoch(db sql.Executor) (types.EpochID, error)
• func LoadBlob(ctx context.Context, db sql.Executor, id []byte, blob *sql.Blob) (types.AtxVersion, error)
• func NonceByID(db sql.Executor, id types.ATXID) (nonce types.VRFPostIndex, err error)
• func PrevIDByNodeID(db sql.Executor, nodeID types.NodeID, pubEpoch types.EpochID) (id types.ATXID, err error)
• func SetValidity(db sql.Executor, id types.ATXID, validity types.Validity) error
• func VRFNonce(db sql.Executor, id types.NodeID, epoch types.EpochID) (nonce types.VRFPostIndex, err error)
• type CheckpointAtx
  • func LatestN(db sql.Executor, n int) ([]CheckpointAtx, error)
• type Filter
• type PrevATXCollision
  • func PrevATXCollisions(db sql.Executor) ([]PrevATXCollision, error)

Constants

const (
	CacheKindEpochATXs sql.QueryCacheKind = "epoch-atxs"
	CacheKindATXBlob   sql.QueryCacheKind = "atx-blob"
)

Functions

func Add

func Add(db sql.Executor, atx *types.ActivationTx) error

func AddCheckpointed

func AddCheckpointed(db sql.Executor, catx *CheckpointAtx) error

func All

func All(db sql.Executor) ([]types.ATXID, error)

All gets all atx IDs.

func AtxAdded

func AtxAdded(db sql.Executor, atx *types.ActivationTx)

AtxAdded updates epoch query cache with new ATX, if the query cache is enabled.

func Coinbase

func Coinbase(db sql.Executor, id types.NodeID) (types.Address, error)

Coinbase retrieves the last coinbase address used by the given node ID.

func CommitmentATX

func CommitmentATX(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)

func CountAtxsByOps

func CountAtxsByOps(db sql.Executor, operations builder.Operations) (count uint32, err error)

func FilterAll

func FilterAll(types.ATXID) bool

func Get

func Get(db sql.Executor, id types.ATXID) (*types.ActivationTx, error)

Get gets an ATX by a given ATX ID.

func GetBlobSizes

func GetBlobSizes(db sql.Executor, ids [][]byte) (sizes []int, err error)

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

func GetByEpochAndNodeID

func GetByEpochAndNodeID(
	db sql.Executor,
	epoch types.EpochID,
	nodeID types.NodeID,
) (types.ATXID, error)

GetByEpochAndNodeID gets any ATX by the specified NodeID published in the given epoch.

func GetFirstIDByNodeID

func GetFirstIDByNodeID(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)

GetFirstIDByNodeID gets the initial ATX ID for a given node ID.

func GetIDByEpochAndNodeID

func GetIDByEpochAndNodeID(db sql.Executor, epoch types.EpochID, nodeID types.NodeID) (id types.ATXID, err error)

GetIDByEpochAndNodeID gets an ATX ID for a given epoch and node ID.

func GetIDWithMaxHeight

func GetIDWithMaxHeight(db sql.Executor, pref types.NodeID, filter Filter) (types.ATXID, error)

GetIDWithMaxHeight returns the ID of the atx from the last 2 epoch with the highest (or tied for the highest) tick height. It is possible that some poet servers are faster than others and the network ends up having its highest ticked atx still in previous epoch and the atxs building on top of it have not been published yet. Selecting from the last two epochs to strike a balance between being fair to honest miners while not giving unfair advantage for malicious actors who retroactively publish a high tick atx many epochs back.

func GetIDsByEpoch

func GetIDsByEpoch(ctx context.Context, db sql.Executor, epoch types.EpochID) (ids []types.ATXID, err error)

GetIDsByEpoch gets ATX IDs for a given epoch.

func GetLastIDByNodeID

func GetLastIDByNodeID(db sql.Executor, nodeID types.NodeID) (id types.ATXID, err error)

GetLastIDByNodeID gets the last ATX ID for a given node ID.

func Has

func Has(db sql.Executor, id types.ATXID) (bool, error)

Has checks if an ATX exists by a given ATX ID.

func IdentityExists

func IdentityExists(db sql.Executor, nodeID types.NodeID) (bool, error)

IdentityExists checks if an identity has ever published an ATX.

func IterateAtxIdsWithMalfeasance

func IterateAtxIdsWithMalfeasance(
	db sql.Executor,
	publish types.EpochID,
	fn func(id types.ATXID, malicious bool) bool,
) error

func IterateAtxsData

func IterateAtxsData(
	db sql.Executor,
	from, to types.EpochID,
	fn func(
		id types.ATXID,
		node types.NodeID,
		epoch types.EpochID,
		coinbase types.Address,
		weight uint64,
		base uint64,
		height uint64,
		nonce types.VRFPostIndex,
		isMalicious bool,
	) bool,
) error

IterateAtxsData iterate over data used for consensus.

func IterateAtxsOps

func IterateAtxsOps(
	db sql.Executor,
	operations builder.Operations,
	fn func(*types.ActivationTx) bool,
) error

func IterateAtxsWithMalfeasance

func IterateAtxsWithMalfeasance(
	db sql.Executor,
	publish types.EpochID,
	fn func(atx *types.ActivationTx, malicious bool) bool,
) error

func IterateForGrading

func IterateForGrading(
	db sql.Executor,
	epoch types.EpochID,
	fn func(id types.ATXID, atxtime, prooftime int64, weight uint64) bool,
) error

IterateForGrading selects every atx from publish epoch and joins identities to load malfeasence proofs if they exist.

func LatestEpoch

func LatestEpoch(db sql.Executor) (types.EpochID, error)

LatestEpoch with atxs.

func LoadBlob

func LoadBlob(ctx context.Context, db sql.Executor, id []byte, blob *sql.Blob) (types.AtxVersion, error)

LoadBlob loads ATX as an encoded blob, ready to be sent over the wire.

func NonceByID

func NonceByID(db sql.Executor, id types.ATXID) (nonce types.VRFPostIndex, err error)

NonceByID retrieves VRFNonce corresponding to the specified ATX ID.

func PrevIDByNodeID

func PrevIDByNodeID(db sql.Executor, nodeID types.NodeID, pubEpoch types.EpochID) (id types.ATXID, err error)

PrevIDByNodeID returns the previous ATX ID for a given node ID and public epoch. It returns the newest ATX ID that was published before the given public epoch.

func SetValidity

func SetValidity(db sql.Executor, id types.ATXID, validity types.Validity) error

func VRFNonce

func VRFNonce(db sql.Executor, id types.NodeID, epoch types.EpochID) (nonce types.VRFPostIndex, err error)

VRFNonce gets the VRF nonce of a smesher for a given epoch.

Types

type CheckpointAtx

type CheckpointAtx struct {
	ID             types.ATXID
	Epoch          types.EpochID
	CommitmentATX  types.ATXID
	VRFNonce       types.VRFPostIndex
	NumUnits       uint32
	BaseTickHeight uint64
	TickCount      uint64
	SmesherID      types.NodeID
	Sequence       uint64
	Coinbase       types.Address
}

func LatestN

func LatestN(db sql.Executor, n int) ([]CheckpointAtx, error)

LatestN returns the latest N ATXs per smesher.

type Filter

type Filter func(types.ATXID) bool

type PrevATXCollision

type PrevATXCollision struct {
	NodeID1 types.NodeID
	ATX1    types.ATXID

	NodeID2 types.NodeID
	ATX2    types.ATXID
}

func PrevATXCollisions

func PrevATXCollisions(db sql.Executor) ([]PrevATXCollision, error)