messagelayer

Documentation

Index

• Constants
• Variables
• func AwaitMessageToBeBooked(f func() (*tangle.Message, error), txID ledgerstate.TransactionID, ...) (*tangle.Message, error)
• func Plugin() *node.Plugin
• func Tangle() *tangle.Tangle

Constants

const (
	// PluginName defines the plugin name.
	PluginName = "MessageLayer"
	// DefaultAverageNetworkDelay contains the default average time it takes for a network to propagate through gossip.
	DefaultAverageNetworkDelay = 5 * time.Second

	// CfgMessageLayerSnapshotFile is the path to the snapshot file.
	CfgMessageLayerSnapshotFile = "messageLayer.snapshot.file"

	// CfgMessageLayerFCOBAverageNetworkDelay is the avg. network delay to use for FCoB rules
	CfgMessageLayerFCOBAverageNetworkDelay = "messageLayer.fcob.averageNetworkDelay"

	// CfgTangleWidth is the width of the Tangle.
	CfgTangleWidth = "messageLayer.tangleWidth"
)

Variables

var (
	// ErrMessageWasNotBookedInTime is returned if a message did not get booked
	// within the defined await time.
	ErrMessageWasNotBookedInTime = errors.New("message could not be booked in time")
)

Functions

func AwaitMessageToBeBooked

func AwaitMessageToBeBooked(f func() (*tangle.Message, error), txID ledgerstate.TransactionID, maxAwait time.Duration) (*tangle.Message, error)

AwaitMessageToBeBooked awaits maxAwait for the given message to get booked.

func Plugin

func Plugin() *node.Plugin

Plugin gets the plugin instance.

func Tangle

func Tangle() *tangle.Tangle

Tangle gets the tangle instance.