events

Documentation

Index

• Constants
• func CloseEventReporter()
• func EventHook() func(entry zapcore.Entry) error
• func InitializeReporter()
• func ReportAccountUpdate(a types.Address)
• func ReportError(err NodeError)
• func ReportLayerUpdate(layer LayerUpdate)
• func ReportNewActivation(activation *types.VerifiedActivationTx)
• func ReportNewTx(layerID types.LayerID, tx *types.Transaction)
• func ReportNodeStatusUpdate()
• func ReportProposal(status ProposalStatus, proposal *types.Proposal)
• func ReportResult(rst types.TransactionWithResult)
• func ReportRewardReceived(r Reward)
• func ReportTxWithValidity(layerID types.LayerID, tx *types.Transaction, valid bool)
• func SubscribeToLayers(ticker LayerClock)
• type Account
• type ActivationTx
• type BufferedSubscription
  • func Subscribe[T any](opts ...SubOpt) (*BufferedSubscription[T], error)
  • func SubscribeMatched[T any](matcher func(*T) bool, opts ...SubOpt) (*BufferedSubscription[T], error)
  • func (sub *BufferedSubscription[T]) Close()
  • func (sub *BufferedSubscription[T]) Full() <-chan struct{}
  • func (sub *BufferedSubscription[T]) Out() <-chan T
• type EventProposal
• type EventReporter
• type LayerClock
• type LayerUpdate
  • func (nl LayerUpdate) Field() log.Field
• type NodeError
• type ProposalStatus
  • func (s ProposalStatus) String() string
• type Reward
• type Status
• type SubOpt
  • func WithBuffer(n int) SubOpt
• type Subscription
  • func SubcribeProposals() Subscription
  • func SubscribeAccount() Subscription
  • func SubscribeActivations() Subscription
  • func SubscribeErrors() Subscription
  • func SubscribeLayers() Subscription
  • func SubscribeRewards() Subscription
  • func SubscribeStatus() Subscription
  • func SubscribeTxs() Subscription
• type Transaction
• type TxReceipt

Constants

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.

Functions

func CloseEventReporter

func CloseEventReporter()

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

func EventHook

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

EventHook returns hook for logger.

func InitializeReporter

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

func ReportAccountUpdate(a types.Address)

ReportAccountUpdate reports an account whose data has been updated.

func ReportError

func ReportError(err NodeError)

ReportError reports an error.

func ReportLayerUpdate

func ReportLayerUpdate(layer LayerUpdate)

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

func ReportNewActivation

func ReportNewActivation(activation *types.VerifiedActivationTx)

ReportNewActivation reports a new activation.

func ReportNewTx

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

ReportNewTx dispatches incoming events to the reporter singleton.

func ReportNodeStatusUpdate

func ReportNodeStatusUpdate()

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

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

ReportProposal reports a proposal.

func ReportResult

func ReportResult(rst types.TransactionWithResult)

ReportResult reports creation or receipt of a new tx receipt.

func ReportRewardReceived

func ReportRewardReceived(r Reward)

ReportRewardReceived reports a new reward.

func ReportTxWithValidity

func ReportTxWithValidity(layerID types.LayerID, tx *types.Transaction, valid bool)

ReportTxWithValidity reports a tx along with whether it was just invalidated.

func SubscribeToLayers

func SubscribeToLayers(ticker LayerClock)

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

Types

type Account

type Account struct {
	types.Address
}

Account wraps account address.

type ActivationTx

type ActivationTx struct {
	*types.VerifiedActivationTx
}

ActivationTx wraps *types.VerifiedActivationTx.

type BufferedSubscription

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

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

Subscribe to the objects of type T.

func SubscribeMatched

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

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

Close non-blocking close of the subscription.

func (*BufferedSubscription[T]) Full

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

Full is closed if subscriptions buffer overflows.

func (*BufferedSubscription[T]) Out

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

Out is a channel with subscription results.

type EventProposal

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

EventProposal includes proposal and proposal status.

type EventReporter

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

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

type LayerClock

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

type LayerUpdate

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) Field

func (nl LayerUpdate) Field() log.Field

Field returns a log field. Implements the LoggableField interface.

type NodeError

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

NodeError represents an internal error to be reported.

type ProposalStatus

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

func (s ProposalStatus) String() string

type Reward

type Reward struct {
	Layer       types.LayerID
	Total       uint64
	LayerReward uint64
	Coinbase    types.Address
}

Reward represents a reward object with extra data needed by the API.

type Status

type Status struct{}

Status indicates status change event.

type SubOpt

type SubOpt func(*subconf)

SubOpt for changing subscribe options.

func WithBuffer

func WithBuffer(n int) SubOpt

WithBuffer changes subscription buffer size.

type Subscription

type Subscription = event.Subscription

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

func SubcribeProposals

func SubcribeProposals() Subscription

SubcribeProposals subscribes to the proposals.

func SubscribeAccount

func SubscribeAccount() Subscription

SubscribeAccount subscribes to account data updates.

func SubscribeActivations

func SubscribeActivations() Subscription

SubscribeActivations subscribes to activations.

func SubscribeErrors

func SubscribeErrors() Subscription

SubscribeErrors subscribes to node errors.

func SubscribeLayers

func SubscribeLayers() Subscription

SubscribeLayers subscribes to all layer data.

func SubscribeRewards

func SubscribeRewards() Subscription

SubscribeRewards subscribes to rewards.

func SubscribeStatus

func SubscribeStatus() Subscription

SubscribeStatus subscribes to node status messages.

func SubscribeTxs

func SubscribeTxs() Subscription

SubscribeTxs subscribes to new transactions.

type Transaction

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

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

type TxReceipt

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.