events

package
v1.7.5-beta.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2024 License: MIT Imports: 14 Imported by: 3

Documentation

Index

Constants

View Source 
const (
	LayerStatusTypeUnknown   = iota
	LayerStatusTypeApproved  // approved by Hare
	LayerStatusTypeConfirmed // confirmed by Tortoise
	LayerStatusTypeApplied   // applied to state
)

The status of a layer TODO: this list is woefully inadequate and does not map to reality. See https://github.com/spacemeshos/api/issues/144.

Variables

This section is empty.

Functions

func CloseEventReporter added in v0.1.15 

func CloseEventReporter()

CloseEventReporter shuts down the event reporting service and closes open channels.

func EmitAtxPublished added in v1.0.0 

func EmitAtxPublished(
	nodeID types.NodeID,
	current, target types.EpochID,
	atxID types.ATXID,
	wait time.Time,
)

func EmitBeacon added in v1.0.0 

func EmitBeacon(epoch types.EpochID, beacon types.Beacon)

func EmitEligibilities added in v1.0.0 

func EmitEligibilities(
	nodeID types.NodeID,
	epoch types.EpochID,
	beacon types.Beacon,
	atxID types.ATXID,
	activeSetSize uint32,
	eligibilities map[types.LayerID][]types.VotingEligibility,
)

func EmitInitComplete added in v1.0.0 

func EmitInitComplete(nodeID types.NodeID)

func EmitInitFailure added in v1.0.3 

func EmitInitFailure(nodeID types.NodeID, commitment types.ATXID, err error)

func EmitInitStart added in v1.0.0 

func EmitInitStart(nodeID types.NodeID, commitment types.ATXID)

func EmitInvalidPostProof added in v1.0.3 

func EmitInvalidPostProof(nodeID types.NodeID)

func EmitOwnMalfeasanceProof added in v1.1.0 

func EmitOwnMalfeasanceProof(nodeID types.NodeID, proof []byte)

func EmitPoetWaitProof added in v1.0.0 

func EmitPoetWaitProof(nodeID types.NodeID, publish types.EpochID, wait time.Time)

func EmitPoetWaitRound added in v1.0.0 

func EmitPoetWaitRound(nodeID types.NodeID, current, publish types.EpochID, wait time.Time)

func EmitPostComplete added in v1.0.0 

func EmitPostComplete(nodeID types.NodeID, challenge []byte)

func EmitPostFailure added in v1.0.0 

func EmitPostFailure(nodeID types.NodeID)

func EmitPostServiceStarted added in v1.3.0 

func EmitPostServiceStarted()

func EmitPostServiceStopped added in v1.3.0 

func EmitPostServiceStopped()

func EmitPostStart added in v1.0.0 

func EmitPostStart(nodeID types.NodeID, challenge []byte)

func EmitProposal added in v1.0.0 

func EmitProposal(nodeID types.NodeID, layer types.LayerID, proposal types.ProposalID)

func EventHook added in v1.0.0 

func EventHook() func(entry zapcore.Entry) error

EventHook returns hook for logger.

func InitializeReporter added in v1.0.0 

func InitializeReporter()

InitializeReporter initializes the event reporting interface with a nonzero channel buffer. This is useful for testing, where we want reporting to block.

func ReportAccountUpdate added in v0.1.15 

func ReportAccountUpdate(a types.Address) error

ReportAccountUpdate reports an account whose data has been updated.

func ReportError added in v0.1.15 

func ReportError(err NodeError) error

ReportError reports an error.

func ReportLayerUpdate added in v1.0.0 

func ReportLayerUpdate(layer LayerUpdate) error

ReportLayerUpdate reports a new layer, or an update to an existing layer.

func ReportMalfeasance added in v1.1.0 

func ReportMalfeasance(nodeID types.NodeID, proof []byte)

ReportMalfeasance reports a malfeasance proof.

func ReportNewActivation added in v0.1.15 

func ReportNewActivation(activation *types.ActivationTx) error

ReportNewActivation reports a new activation.

func ReportNewTx added in v0.1.15 

func ReportNewTx(layerID types.LayerID, tx *types.Transaction) error

ReportNewTx dispatches incoming events to the reporter singleton.

func ReportNodeStatusUpdate added in v0.1.15 

func ReportNodeStatusUpdate() error

ReportNodeStatusUpdate reports an update to the node status. It just pings the listener to notify them that there is an update; the listener is responsible for fetching the new status details. This is because status contains disparate information coming from different services, and the listener already knows how to gather that information so there is no point in duplicating that logic here. Note: There is some overlap with channelLayer here, as a new latest or verified layer should be sent over that channel as well. However, that happens inside the Mesh, at the source. It doesn't currently happen here because the status update includes only a layer ID, not full layer data, and the Reporter currently has no way to retrieve full layer data.

func ReportProposal added in v1.0.0 

func ReportProposal(status ProposalStatus, proposal *types.Proposal)

ReportProposal reports a proposal.

func ReportResult added in v1.0.0 

func ReportResult(rst types.TransactionWithResult) error

ReportResult reports creation or receipt of a new tx receipt.

func ReportRewardReceived added in v0.1.15 

func ReportRewardReceived(r types.Reward) error

ReportRewardReceived reports a new reward.

func SubscribeToLayers added in v0.1.15 

func SubscribeToLayers(ticker LayerClock)

SubscribeToLayers is used to track and report automatically every time a new layer is reached.

func SubscribeUserEvents added in v1.0.0 

func SubscribeUserEvents(opts ...SubOpt) (*BufferedSubscription[UserEvent], *Ring[UserEvent], error)

func ToMalfeasancePB added in v1.1.0 

func ToMalfeasancePB(nodeID types.NodeID, proof []byte, includeProof bool) *pb.MalfeasanceProof

Types

type Account added in v1.0.0 

type Account struct {
	types.Address
}

Account wraps account address.

type ActivationTx added in v1.0.0 

type ActivationTx struct {
	*types.ActivationTx
}

ActivationTx wraps *types.ActivationTx.

type BufferedSubscription added in v1.0.0 

type BufferedSubscription[T any] struct {
	// contains filtered or unexported fields
}

BufferedSubscription is meant to be used by API subscribers.

Majority of the events are published on the critical consensus path, and they can't block consensus progress if consumer is slow. To account for slow consumer each subscription maintains an internal buffer with specific events, if this buffer overflows consumer should be dropped and stream restarted.

func Subscribe added in v1.0.0 

func Subscribe[T any](opts ...SubOpt) (*BufferedSubscription[T], error)

Subscribe to the objects of type T.

func SubscribeMatched added in v1.0.0 

func SubscribeMatched[T any](matcher func(*T) bool, opts ...SubOpt) (*BufferedSubscription[T], error)

SubscribeMatched subscribes and filters results before adding them to the Out channel.

func (*BufferedSubscription[T]) Close added in v1.0.0 

func (sub *BufferedSubscription[T]) Close()

Close non-blocking close of the subscription.

func (*BufferedSubscription[T]) Full added in v1.0.0 

func (sub *BufferedSubscription[T]) Full() <-chan struct{}

Full is closed if subscriptions buffer overflows.

func (*BufferedSubscription[T]) Out added in v1.0.0 

func (sub *BufferedSubscription[T]) Out() <-chan T

Out is a channel with subscription results.

type EventMalfeasance added in v1.1.0 

type EventMalfeasance struct {
	Smesher types.NodeID
	Proof   []byte
}

EventMalfeasance includes the malfeasance proof.

type EventProposal added in v1.0.0 

type EventProposal struct {
	Status   ProposalStatus
	Proposal *types.Proposal
}

EventProposal includes proposal and proposal status.

type EventReporter added in v0.1.15 

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

EventReporter is the struct that receives incoming events and dispatches them.

type LayerClock added in v1.0.0 

type LayerClock interface {
	AwaitLayer(layerID types.LayerID) <-chan struct{}
	CurrentLayer() types.LayerID
}

type LayerUpdate added in v1.0.0 

type LayerUpdate struct {
	LayerID types.LayerID
	Status  int
}

LayerUpdate packages up a layer with its status (which a layer does not ordinarily contain).

func (LayerUpdate) MarshalLogObject added in v1.7.0 

func (lu LayerUpdate) MarshalLogObject(enc zapcore.ObjectEncoder) error

type NodeError added in v0.1.15 

type NodeError struct {
	Msg   string
	Trace string
	Level zapcore.Level
}

NodeError represents an internal error to be reported.

type ProposalStatus added in v1.0.0 

type ProposalStatus int

ProposalStatus is a type for proposal status. 

const (
	// ProposalCreated is a status of the proposal that was created.
	ProposalCreated ProposalStatus = iota
	// ProposalIncluded is a status of the proposal when it is included into the block.
	ProposalIncluded
)

func (ProposalStatus) String added in v1.0.0 

func (s ProposalStatus) String() string

type Ring added in v1.0.0 

type Ring[T any] struct {
	// contains filtered or unexported fields
}

Ring is an insert only buffer.

func (*Ring[T]) Copy added in v1.0.0 

func (r *Ring[T]) Copy() *Ring[T]

func (*Ring[T]) Iterate added in v1.0.0 

func (r *Ring[T]) Iterate(iter func(val T) bool)

func (*Ring[T]) Len added in v1.0.0 

func (r *Ring[T]) Len() int

type Status added in v1.0.0 

type Status struct{}

Status indicates status change event.

type SubOpt added in v1.0.0 

type SubOpt func(*subconf)

SubOpt for changing subscribe options.

func WithBuffer added in v1.0.0 

func WithBuffer(n int) SubOpt

WithBuffer changes subscription buffer size.

type Subscription added in v1.0.0 

type Subscription = event.Subscription

Subscription is a subscription to events. Consumer must be aware that publish will block if subscription is not read fast enough.

func SubscribeAccount added in v1.0.0 

func SubscribeAccount() (Subscription, error)

SubscribeAccount subscribes to account data updates.

func SubscribeActivations added in v1.0.0 

func SubscribeActivations() (Subscription, error)

SubscribeActivations subscribes to activations.

func SubscribeErrors added in v1.0.0 

func SubscribeErrors() (Subscription, error)

SubscribeErrors subscribes to node errors.

func SubscribeLayers added in v1.0.0 

func SubscribeLayers() (Subscription, error)

SubscribeLayers subscribes to all layer data.

func SubscribeMalfeasance added in v1.1.0 

func SubscribeMalfeasance() Subscription

SubscribeMalfeasance subscribes malfeasance events.

func SubscribeProposals added in v1.6.0 

func SubscribeProposals() Subscription

SubscribeProposals subscribes to the proposals.

func SubscribeRewards added in v1.0.0 

func SubscribeRewards() (Subscription, error)

SubscribeRewards subscribes to rewards.

func SubscribeStatus added in v1.0.0 

func SubscribeStatus() (Subscription, error)

SubscribeStatus subscribes to node status messages.

func SubscribeTxs added in v1.0.0 

func SubscribeTxs() (Subscription, error)

SubscribeTxs subscribes to new transactions.

type Transaction added in v1.0.0 

type Transaction struct {
	Transaction *types.Transaction
	LayerID     types.LayerID
	Valid       bool
}

Transaction wraps a tx with its layer ID and validity info.

type TxReceipt added in v0.1.15 

type TxReceipt struct {
	ID      types.TransactionID
	Result  int
	GasUsed uint64
	Fee     uint64
	Layer   types.LayerID
	Index   uint32
	Address types.Address
}

TxReceipt represents a transaction receipt.

type UserEvent added in v1.0.0 

type UserEvent struct {
	Event *pb.Event
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.