tangle

package
v0.9.1 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2022 License: Apache-2.0, BSD-2-Clause Imports: 58 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// MessageVersion defines the Version of the message structure.
	MessageVersion uint8 = 1

	// MaxMessageSize defines the maximum size of a message.
	MaxMessageSize = 64 * 1024

	// MessageIDLength defines the length of an MessageID.
	MessageIDLength = types.IdentifierLength

	// MinParentsCount defines the minimum number of parents each parents block must have.
	MinParentsCount = 1

	// MaxParentsCount defines the maximum number of parents each parents block must have.
	MaxParentsCount = 8

	// MinParentsBlocksCount defines the minimum number of parents each parents block must have.
	MinParentsBlocksCount = 1

	// MaxParentsBlocksCount defines the maximum number of parents each parents block must have.
	MaxParentsBlocksCount = 4

	// MinStrongParentsCount defines the minimum number of strong parents a message must have.
	MinStrongParentsCount = 1
)
View Source 
const (
	// MaxLocalQueueSize is the maximum local (containing the message to be issued) queue size in bytes.
	MaxLocalQueueSize = 20
	// RateSettingIncrease is the global additive increase parameter.
	// In the Access Control for Distributed Ledgers in the Internet of Things: A Networking Approach paper this parameter is denoted as "A".
	RateSettingIncrease = 0.075
	// RateSettingDecrease global multiplicative decrease parameter (larger than 1).
	// In the Access Control for Distributed Ledgers in the Internet of Things: A Networking Approach paper this parameter is denoted as "β".
	RateSettingDecrease = 1.5
	// Wmax is the maximum inbox threshold for the node. This value denotes when maximum active mana holder backs off its rate.
	Wmax = 10
	// Wmin is the min inbox threshold for the node. This value denotes when nodes with the least mana back off their rate.
	Wmin = 2
)
View Source 
const (
	// PrefixMessage defines the storage prefix for message.
	PrefixMessage byte = iota

	// PrefixMessageMetadata defines the storage prefix for message metadata.
	PrefixMessageMetadata

	// PrefixApprovers defines the storage prefix for approvers.
	PrefixApprovers

	// PrefixMissingMessage defines the storage prefix for missing message.
	PrefixMissingMessage

	// PrefixAttachments defines the storage prefix for attachments.
	PrefixAttachments

	// PrefixMarkerBranchIDMapping defines the storage prefix for the PrefixMarkerBranchIDMapping.
	PrefixMarkerBranchIDMapping

	// PrefixBranchVoters defines the storage prefix for the BranchVoters.
	PrefixBranchVoters

	// PrefixLatestBranchVotes defines the storage prefix for the LatestBranchVotes.
	PrefixLatestBranchVotes

	// PrefixLatestMarkerVotes defines the storage prefix for the LatestMarkerVotes.
	PrefixLatestMarkerVotes

	// PrefixBranchWeight defines the storage prefix for the BranchWeight.
	PrefixBranchWeight

	// PrefixMarkerMessageMapping defines the storage prefix for the MarkerMessageMapping.
	PrefixMarkerMessageMapping

	// DBSequenceNumber defines the db sequence number.
	DBSequenceNumber = "seq"
)
View Source 
const (
	// DefaultGenesisTime is the default time (Unix in seconds) of the genesis, i.e., the start of the epochs at 2021-03-19 9:00:00 UTC.
	DefaultGenesisTime int64 = 1616144400
	// DefaultSyncTimeWindow is the default sync time window.
	DefaultSyncTimeWindow = 2 * time.Minute
)
View Source 
const ApproverTypeLength = 1

ApproverTypeLength contains the amount of bytes that a marshaled version of the ApproverType contains.

View Source 
const (
	// LastValidBlockType counts StrongParents, WeakParents, ShallowLikeParents.
	LastValidBlockType = ShallowLikeParentType
)
View Source 
const (
	// MaxReattachmentTimeMin defines the max reattachment time.
	MaxReattachmentTimeMin = 10 * time.Minute
)
View Source 
const (
	// MinMana is the minimum amount of Mana needed to issue messages.
	// MaxMessageSize / MinMana is also the upper bound of iterations inside one schedule call, as such it should not be too small.
	MinMana float64 = 1.0
)

Variables

View Source 
var (
	// ErrNotBootstrapped is triggered when somebody tries to issue a Payload before the Tangle is fully bootstrapped.
	ErrNotBootstrapped = errors.New("tangle not bootstrapped")
	// ErrParentsInvalid is returned when one or more parents of a message is invalid.
	ErrParentsInvalid = errors.New("one or more parents is invalid")
)
View Source 
var (
	// ErrNoStrongParents is triggered if there no strong parents.
	ErrNoStrongParents = errors.New("missing strong messages in first parent block")
	// ErrBlockTypeIsUnknown is triggered when the block type is unknown.
	ErrBlockTypeIsUnknown = errors.Errorf("block types must range from %d-%d", 1, LastValidBlockType)
	// ErrConflictingReferenceAcrossBlocks is triggered if there conflicting references across blocks.
	ErrConflictingReferenceAcrossBlocks = errors.New("different blocks have conflicting references")
)
View Source 
var (
	// ErrInvalidPOWDifficultly is returned when the nonce of a message does not fulfill the PoW difficulty.
	ErrInvalidPOWDifficultly = errors.New("invalid PoW")

	// ErrMessageTooSmall is returned when the message does not contain enough data for the PoW.
	ErrMessageTooSmall = errors.New("message too small")

	// ErrInvalidSignature is returned when a message contains an invalid signature.
	ErrInvalidSignature = fmt.Errorf("invalid signature")

	// ErrReceivedDuplicateBytes is returned when duplicated bytes are rejected.
	ErrReceivedDuplicateBytes = fmt.Errorf("received duplicate bytes")

	// ErrInvalidMessageAndTransactionTimestamp is returned when the message its transaction timestamps are invalid.
	ErrInvalidMessageAndTransactionTimestamp = fmt.Errorf("invalid message and transaction timestamp")
)
View Source 
var (
	// ErrInvalidIssuer is returned when an invalid message is passed to the rate setter.
	ErrInvalidIssuer = errors.New("message not issued by local node")
	// ErrStopped is returned when a message is passed to a stopped rate setter.
	ErrStopped = errors.New("rate setter stopped")
)
View Source 
var DefaultRequesterOptions = &RequesterOptions{
	RetryInterval:       10 * time.Second,
	RetryJitter:         10 * time.Second,
	MaxRequestThreshold: 500,
}

DefaultRequesterOptions defines the default options that are used when creating Requester instances.

View Source 
var ErrNotRunning = errors.New("scheduler stopped")

ErrNotRunning is returned when a message is submitted when the scheduler has been stopped.

View Source 
var LatestMarkerVotesKeyPartition = objectstorage.PartitionKey(markers.SequenceID(0).Length(), identity.IDLength)

LatestMarkerVotesKeyPartition defines the partition of the storage key of the LastMarkerVotes model.

View Source 
var MarkerMessageMappingPartitionKeys = objectstorage.PartitionKey(markers.SequenceID(0).Length(), markers.Index(0).Length())

MarkerMessageMappingPartitionKeys defines the "layout" of the key. This enables prefix iterations in the object storage.

View Source 
var MaxDeficit = new(big.Rat).SetInt64(int64(MaxMessageSize))

MaxDeficit is the maximum cap for accumulated deficit, i.e. max bytes that can be scheduled without waiting. It must be >= MaxMessageSize.

View Source 
var ParentTypeToApproverType = map[ParentsType]ApproverType{
	StrongParentType:      StrongApprover,
	WeakParentType:        WeakApprover,
	ShallowLikeParentType: ShallowLikeApprover,
}

ParentTypeToApproverType represents a convenient mapping between a parent type and the approver type.

View Source 
var ZeroWorker = WorkerFunc(func([]byte) (uint64, error) { return 0, nil })

ZeroWorker is a PoW worker that always returns 0 as the nonce.

Functions

func IssueAndValidateMessageApproval added in v0.8.0 

func IssueAndValidateMessageApproval(t *testing.T, messageAlias string, eventMock *EventMock, testFramework *MessageTestFramework, expectedBranchWeights map[string]float64, expectedMarkerWeights map[markers.Marker]float64)

IssueAndValidateMessageApproval issues the msg by the given alias and assets the expected weights.

func MessageIDToContext added in v0.9.0 

func MessageIDToContext(ctx context.Context, messageID MessageID) context.Context

Types

type ActivityLog added in v0.8.0 

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

ActivityLog is a time-based log of node activity. It stores information when a node was active and provides functionality to query for certain timeframes.

func NewActivityLog added in v0.8.0 

func NewActivityLog() *ActivityLog

NewActivityLog is the constructor for ActivityLog.

func (*ActivityLog) Active added in v0.8.0 

func (a *ActivityLog) Active(lowerBound, upperBound time.Time) (active, empty bool)

Active returns true if the node was active between lower and upper bound. It cleans up the log on the fly, meaning that old/stale times are deleted. If the log ends up empty after cleaning up, empty is set to true.

func (*ActivityLog) Add added in v0.8.0 

func (a *ActivityLog) Add(t time.Time) (added bool)

Add adds a node activity to the log.

func (*ActivityLog) Clone added in v0.8.0 

func (a *ActivityLog) Clone() *ActivityLog

Clone clones the ActivityLog.

func (*ActivityLog) Decode added in v0.8.13 

func (a *ActivityLog) Decode(data []byte) (bytesRead int, err error)

Decode deserializes bytes into a valid object.

func (*ActivityLog) Encode added in v0.8.13 

func (a *ActivityLog) Encode() ([]byte, error)

Encode ActivityLog a serialized byte slice of the object.

func (*ActivityLog) String added in v0.8.0 

func (a *ActivityLog) String() string

String returns a human-readable version of ActivityLog.

func (*ActivityLog) Times added in v0.8.0 

func (a *ActivityLog) Times() (times []int64)

Times returns all times stored in this ActivityLog.

type ApprovalWeightManager added in v0.5.7 

type ApprovalWeightManager struct {
	Events *ApprovalWeightManagerEvents
	// contains filtered or unexported fields
}

ApprovalWeightManager is a Tangle component to keep track of relative weights of branches and markers so that consensus can be based on the heaviest perception on the tangle as a data structure.

func NewApprovalWeightManager added in v0.5.7 

func NewApprovalWeightManager(tangle *Tangle) (approvalWeightManager *ApprovalWeightManager)

NewApprovalWeightManager is the constructor for ApprovalWeightManager.

func (*ApprovalWeightManager) Setup added in v0.5.7 

func (a *ApprovalWeightManager) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*ApprovalWeightManager) Shutdown added in v0.5.7 

func (a *ApprovalWeightManager) Shutdown()

Shutdown shuts down the ApprovalWeightManager and persists its state.

func (*ApprovalWeightManager) VotersOfBranch added in v0.8.10 

func (a *ApprovalWeightManager) VotersOfBranch(branchID utxo.TransactionID) (voters *Voters)

VotersOfBranch returns the Voters of the given branch ledger.BranchID.

func (*ApprovalWeightManager) WeightOfBranch added in v0.5.7 

func (a *ApprovalWeightManager) WeightOfBranch(branchID utxo.TransactionID) (weight float64)

WeightOfBranch returns the weight of the given Conflict that was added by Voters of the given epoch.

func (*ApprovalWeightManager) WeightOfMarker added in v0.5.7 

func (a *ApprovalWeightManager) WeightOfMarker(marker markers.Marker, anchorTime time.Time) (weight float64)

WeightOfMarker returns the weight of the given marker based on the anchorTime.

type ApprovalWeightManagerEvents added in v0.5.7 

type ApprovalWeightManagerEvents struct {
	// MessageProcessed is triggered once a message is finished being processed by the ApprovalWeightManager.
	MessageProcessed *event.Event[*MessageProcessedEvent]
	// BranchWeightChanged is triggered when a branch's weight changed.
	BranchWeightChanged *event.Event[*BranchWeightChangedEvent]
	// MarkerWeightChanged is triggered when a marker's weight changed.
	MarkerWeightChanged *event.Event[*MarkerWeightChangedEvent]
}

ApprovalWeightManagerEvents represents events happening in the ApprovalWeightManager.

type Approver 

type Approver struct {
	model.StorableReference[Approver, *Approver, approverSourceModel, MessageID] `serix:"0"`
}

Approver is an approver of a given referenced message.

func NewApprover 

func NewApprover(approverType ApproverType, referencedMessageID MessageID, approverMessageID MessageID) *Approver

NewApprover creates a new approver relation to the given approved/referenced message.

func (*Approver) ApproverMessageID 

func (a *Approver) ApproverMessageID() MessageID

ApproverMessageID returns the ID of the message which referenced the given approved message.

func (*Approver) ReferencedMessageID 

func (a *Approver) ReferencedMessageID() MessageID

ReferencedMessageID returns the ID of the message which is referenced by the approver.

func (*Approver) Type added in v0.3.6 

func (a *Approver) Type() ApproverType

Type returns the type of the Approver reference.

type ApproverType added in v0.3.6 

type ApproverType uint8

ApproverType is a type that represents the different kind of reverse mapping that we have for references formed by strong and weak parents. 

const (
	// StrongApprover is the ApproverType that represents references formed by strong parents.
	StrongApprover ApproverType = iota

	// WeakApprover is the ApproverType that represents references formed by weak parents.
	WeakApprover

	// ShallowLikeApprover is the ApproverType that represents references formed by shallow like parents.
	ShallowLikeApprover
)

func (ApproverType) Bytes added in v0.3.6 

func (a ApproverType) Bytes() []byte

Bytes returns a marshaled version of the ApproverType.

func (ApproverType) String added in v0.3.6 

func (a ApproverType) String() string

String returns a human readable version of the ApproverType.

type Attachment added in v0.3.6 

type Attachment struct {
	model.StorableReference[Attachment, *Attachment, utxo.TransactionID, MessageID] `serix:"0"`
}

Attachment stores the information which transaction was attached by which message. We need this to be able to perform reverse lookups from transactions to their corresponding messages that attach them.

func NewAttachment added in v0.3.6 

func NewAttachment(transactionID utxo.TransactionID, messageID MessageID) *Attachment

NewAttachment creates an attachment object with the given information.

func (*Attachment) MessageID added in v0.3.6 

func (a *Attachment) MessageID() MessageID

MessageID returns the messageID of this Attachment.

func (*Attachment) TransactionID added in v0.3.6 

func (a *Attachment) TransactionID() utxo.TransactionID

TransactionID returns the transactionID of this Attachment.

type BlockOrphanedEvent added in v0.9.0 

type BlockOrphanedEvent struct {
	Block  *Message
	Reason error
}

type Booker added in v0.3.6 

type Booker struct {
	// Events is a dictionary for the Booker related Events.
	Events *BookerEvents

	MarkersManager *BranchMarkersMapper
	// contains filtered or unexported fields
}

Booker is a Tangle component that takes care of booking Messages and Transactions by assigning them to the corresponding Branch of the ledger state.

func NewBooker added in v0.3.6 

func NewBooker(tangle *Tangle) (messageBooker *Booker)

NewBooker is the constructor of a Booker.

func (*Booker) BookMessage added in v0.5.7 

func (b *Booker) BookMessage(message *Message, messageMetadata *MessageMetadata) (err error)

BookMessage tries to book the given Message (and potentially its contained Transaction) into the ledger and the Tangle. It fires a MessageBooked event if it succeeds. If the Message is invalid it fires a MessageInvalid event. Booking a message essentially means that parents are examined, the branch of the message determined based on the branch inheritance rules of the like switch and markers are inherited. If everything is valid, the message is marked as booked. Following, the message branch is set, and it can continue in the dataflow to add support to the determined branches and markers.

func (*Booker) MessageBranchIDs added in v0.8.6 

func (b *Booker) MessageBranchIDs(messageID MessageID) (branchIDs *set.AdvancedSet[utxo.TransactionID], err error)

MessageBranchIDs returns the BranchIDs of the given Message.

func (*Booker) PayloadBranchIDs added in v0.8.6 

func (b *Booker) PayloadBranchIDs(messageID MessageID) (branchIDs *set.AdvancedSet[utxo.TransactionID], err error)

PayloadBranchIDs returns the BranchIDs of the payload contained in the given Message.

func (*Booker) PropagateForkedBranch added in v0.8.6 

func (b *Booker) PropagateForkedBranch(transactionID utxo.TransactionID, addedBranchID utxo.TransactionID, removedBranchIDs *set.AdvancedSet[utxo.TransactionID]) (err error)

PropagateForkedBranch propagates the forked BranchID to the future cone of the attachments of the given Transaction.

func (*Booker) Setup added in v0.4.0 

func (b *Booker) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*Booker) Shutdown added in v0.3.6 

func (b *Booker) Shutdown()

Shutdown shuts down the Booker and persists its state.

type BookerEvents added in v0.3.6 

type BookerEvents struct {
	// MessageBooked is triggered when a Message was booked (it's Branch, and it's Payload's Branch were determined).
	MessageBooked *event.Event[*MessageBookedEvent]

	// MessageBranchUpdated is triggered when the BranchID of a Message is changed in its MessageMetadata.
	MessageBranchUpdated *event.Event[*MessageBranchUpdatedEvent]

	// MarkerBranchAdded is triggered when a Marker is mapped to a new BranchID.
	MarkerBranchAdded *event.Event[*MarkerBranchAddedEvent]

	// Error gets triggered when the Booker faces an unexpected error.
	Error *event.Event[error]
}

BookerEvents represents events happening in the Booker.

func NewBookerEvents added in v0.9.0 

func NewBookerEvents() (new *BookerEvents)

type BranchMarkersMapper added in v0.8.6 

type BranchMarkersMapper struct {
	*markers.Manager
	// contains filtered or unexported fields
}

BranchMarkersMapper is a Tangle component that takes care of managing the Markers which are used to infer structural information about the Tangle in an efficient way.

func NewBranchMarkersMapper added in v0.8.6 

func NewBranchMarkersMapper(tangle *Tangle) (b *BranchMarkersMapper)

NewBranchMarkersMapper is the constructor of the MarkersManager.

func (*BranchMarkersMapper) BranchIDs added in v0.9.0 

func (b *BranchMarkersMapper) BranchIDs(marker markers.Marker) (branchIDs *set.AdvancedSet[utxo.TransactionID])

BranchIDs returns the BranchID that is associated with the given Marker.

func (*BranchMarkersMapper) Ceiling added in v0.8.6 

func (b *BranchMarkersMapper) Ceiling(referenceMarker markers.Marker) (marker markers.Index, branchIDs *set.AdvancedSet[utxo.TransactionID], exists bool)

Ceiling returns the smallest Index that is >= the given Marker, it's BranchID and a boolean value indicating if it exists.

func (*BranchMarkersMapper) Floor added in v0.8.6 

func (b *BranchMarkersMapper) Floor(referenceMarker markers.Marker) (marker markers.Index, branchIDs *set.AdvancedSet[utxo.TransactionID], exists bool)

Floor returns the largest Index that is <= the given Marker, it's BranchIDs and a boolean value indicating if it exists.

func (*BranchMarkersMapper) ForEachBranchIDMapping added in v0.8.6 

func (b *BranchMarkersMapper) ForEachBranchIDMapping(sequenceID markers.SequenceID, thresholdIndex markers.Index, callback func(mappedMarker markers.Marker, mappedBranchIDs *set.AdvancedSet[utxo.TransactionID]))

ForEachBranchIDMapping iterates over all BranchID mappings in the given Sequence that are bigger than the given thresholdIndex. Setting the thresholdIndex to 0 will iterate over all existing mappings.

func (*BranchMarkersMapper) ForEachMarkerReferencingMarker added in v0.8.6 

func (b *BranchMarkersMapper) ForEachMarkerReferencingMarker(referencedMarker markers.Marker, callback func(referencingMarker markers.Marker))

ForEachMarkerReferencingMarker executes the callback function for each Marker of other Sequences that directly reference the given Marker.

func (*BranchMarkersMapper) InheritStructureDetails added in v0.8.6 

func (b *BranchMarkersMapper) InheritStructureDetails(message *Message, structureDetails []*markers.StructureDetails) (newStructureDetails *markers.StructureDetails, newSequenceCreated bool)

InheritStructureDetails returns the structure Details of a Message that are derived from the StructureDetails of its strong and like parents.

func (*BranchMarkersMapper) MessageID added in v0.8.6 

func (b *BranchMarkersMapper) MessageID(marker markers.Marker) (messageID MessageID)

MessageID retrieves the MessageID of the given Marker.

func (*BranchMarkersMapper) SetBranchIDs added in v0.8.10 

func (b *BranchMarkersMapper) SetBranchIDs(marker markers.Marker, branchIDs *set.AdvancedSet[utxo.TransactionID]) (updated bool)

SetBranchIDs associates ledger.BranchIDs with the given Marker.

func (*BranchMarkersMapper) SetMessageID added in v0.8.6 

func (b *BranchMarkersMapper) SetMessageID(marker markers.Marker, messageID MessageID)

SetMessageID associates a MessageID with the given Marker.

type BranchVote added in v0.8.6 

type BranchVote struct {
	model.Mutable[BranchVote, *BranchVote, branchVoteModel] `serix:"0"`
}

BranchVote represents a struct that holds information about what Opinion a certain Voter has on a Branch.

func NewBranchVote added in v0.9.0 

func NewBranchVote(voter Voter, votePower VotePower, branchID utxo.TransactionID, opinion Opinion) (voteWithOpinion *BranchVote)

NewBranchVote derives a vote for th.

func (*BranchVote) BranchID added in v0.8.6 

func (v *BranchVote) BranchID() utxo.TransactionID

func (*BranchVote) Opinion added in v0.8.6 

func (v *BranchVote) Opinion() Opinion

func (*BranchVote) VotePower added in v0.8.6 

func (v *BranchVote) VotePower() VotePower

func (*BranchVote) Voter added in v0.8.6 

func (v *BranchVote) Voter() Voter

func (*BranchVote) WithBranchID added in v0.8.6 

func (v *BranchVote) WithBranchID(branchID utxo.TransactionID) (rejectedVote *BranchVote)

WithBranchID derives a vote for the given BranchID.

func (*BranchVote) WithOpinion added in v0.8.6 

func (v *BranchVote) WithOpinion(opinion Opinion) (voteWithOpinion *BranchVote)

WithOpinion derives a vote for the given Opinion.

type BranchVoters added in v0.8.6 

type BranchVoters struct {
	model.Storable[utxo.TransactionID, BranchVoters, *BranchVoters, Voters] `serix:"0"`
}

BranchVoters is a data structure that tracks which nodes support a branch.

func NewBranchVoters added in v0.8.6 

func NewBranchVoters(branchID utxo.TransactionID) (branchVoters *BranchVoters)

NewBranchVoters is the constructor for the BranchVoters object.

func (*BranchVoters) AddVoter added in v0.8.6 

func (b *BranchVoters) AddVoter(voter Voter) (added bool)

AddVoter adds a new Voter to the tracked BranchID.

func (*BranchVoters) AddVoters added in v0.8.6 

func (b *BranchVoters) AddVoters(voters *Voters) (added bool)

AddVoters adds the Voters set to the tracked BranchID.

func (*BranchVoters) BranchID added in v0.8.6 

func (b *BranchVoters) BranchID() (branchID utxo.TransactionID)

BranchID returns the BranchID that is being tracked.

func (*BranchVoters) DeleteVoter added in v0.8.6 

func (b *BranchVoters) DeleteVoter(voter Voter) (deleted bool)

DeleteVoter deletes a Voter from the tracked BranchID.

func (*BranchVoters) Has added in v0.8.6 

func (b *BranchVoters) Has(voter Voter) bool

Has returns true if the given Voter is currently supporting this Branch.

func (*BranchVoters) Voters added in v0.8.6 

func (b *BranchVoters) Voters() (voters *Voters)

Voters returns the set of Voters that are supporting the given BranchID.

type BranchWeight added in v0.5.7 

type BranchWeight struct {
	model.Storable[utxo.TransactionID, BranchWeight, *BranchWeight, float64] `serix:"0"`
}

BranchWeight is a data structure that tracks the weight of a BranchID.

func NewBranchWeight added in v0.5.7 

func NewBranchWeight(branchID utxo.TransactionID) (branchWeight *BranchWeight)

NewBranchWeight creates a new BranchWeight.

func (*BranchWeight) BranchID added in v0.5.7 

func (b *BranchWeight) BranchID() (branchID utxo.TransactionID)

BranchID returns the BranchID that is being tracked.

func (*BranchWeight) SetWeight added in v0.5.7 

func (b *BranchWeight) SetWeight(weight float64) bool

SetWeight sets the weight for the BranchID and returns true if it was modified.

func (*BranchWeight) Weight added in v0.5.7 

func (b *BranchWeight) Weight() (weight float64)

Weight returns the weight of the BranchID.

type BranchWeightChangedEvent added in v0.8.0 

type BranchWeightChangedEvent struct {
	BranchID utxo.TransactionID
	Weight   float64
}

BranchWeightChangedEvent holds information about a branch and its updated weight.

type BytesFilter 

type BytesFilter interface {
	// Filter filters up on the given bytes and peer and calls the acceptance callback
	// if the input passes or the rejection callback if the input is rejected.
	Filter(bytes []byte, peer *peer.Peer)
	// OnAccept registers the given callback as the acceptance function of the filter.
	OnAccept(callback func(bytes []byte, peer *peer.Peer))
	// OnReject registers the given callback as the rejection function of the filter.
	OnReject(callback func(bytes []byte, err error, peer *peer.Peer))
}

BytesFilter filters based on byte slices and peers.

type BytesRejectedEvent 

type BytesRejectedEvent struct {
	Bytes []byte
	Peer  *peer.Peer
	Error error
}

BytesRejectedEvent holds the information provided by the BytesRejected event that gets triggered when the bytes of a Message did not pass the parsing step.

type CManaWeightProvider added in v0.5.8 

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

CManaWeightProvider is a WeightProvider for consensus mana. It keeps track of active nodes based on their time-based activity in relation to activeTimeThreshold.

func NewCManaWeightProvider added in v0.5.8 

func NewCManaWeightProvider(manaRetrieverFunc ManaRetrieverFunc, timeRetrieverFunc TimeRetrieverFunc, store ...kvstore.KVStore) (cManaWeightProvider *CManaWeightProvider)

NewCManaWeightProvider is the constructor for CManaWeightProvider.

func (*CManaWeightProvider) ActiveNodes added in v0.5.8 

func (c *CManaWeightProvider) ActiveNodes() (activeNodes NodesActivityLog)

ActiveNodes returns the map of the active nodes.

func (*CManaWeightProvider) Shutdown added in v0.5.8 

func (c *CManaWeightProvider) Shutdown()

Shutdown shuts down the WeightProvider and persists its state.

func (*CManaWeightProvider) Update added in v0.5.8 

func (c *CManaWeightProvider) Update(t time.Time, nodeID identity.ID)

Update updates the underlying data structure and keeps track of active nodes.

func (*CManaWeightProvider) Weight added in v0.5.8 

func (c *CManaWeightProvider) Weight(message *Message) (weight, totalWeight float64)

Weight returns the weight and total weight for the given message.

func (*CManaWeightProvider) WeightsOfRelevantVoters added in v0.8.6 

func (c *CManaWeightProvider) WeightsOfRelevantVoters() (weights map[identity.ID]float64, totalWeight float64)

WeightsOfRelevantVoters returns all relevant weights.

type CachedLatestMarkerVotesByVoter added in v0.8.6 

type CachedLatestMarkerVotesByVoter map[Voter]*objectstorage.CachedObject[*LatestMarkerVotes]

CachedLatestMarkerVotesByVoter represents a cached LatestMarkerVotesByVoter mapped by Voter.

func (CachedLatestMarkerVotesByVoter) Consume added in v0.8.6 

func (c CachedLatestMarkerVotesByVoter) Consume(consumer func(latestMarkerVotes *LatestMarkerVotes), forceRelease ...bool) (consumed bool)

Consume unwraps the CachedObject and passes a type-casted version to the consumer (if the object is not empty - it exists). It automatically releases the object when the consumer finishes.

type ConfirmationEvents added in v0.8.0 

type ConfirmationEvents struct {
	MessageConfirmed *event.Event[*MessageConfirmedEvent]
}

ConfirmationEvents are events entailing confirmation.

func NewConfirmationEvents added in v0.9.0 

func NewConfirmationEvents() (new *ConfirmationEvents)

NewConfirmationEvents returns a new ConfirmationEvents object.

type ConfirmationOracle added in v0.8.0 

type ConfirmationOracle interface {
	IsMarkerConfirmed(marker markers.Marker) bool
	IsMessageConfirmed(msgID MessageID) bool
	IsBranchConfirmed(branchID utxo.TransactionID) bool
	IsTransactionConfirmed(transactionID utxo.TransactionID) bool
	IsOutputConfirmed(outputID utxo.OutputID) bool
	FirstUnconfirmedMarkerIndex(sequenceID markers.SequenceID) (unconfirmedMarkerIndex markers.Index)
	Events() *ConfirmationEvents
}

ConfirmationOracle answers questions about entities' confirmation.

type DBStatsResult added in v0.8.4 

type DBStatsResult struct {
	StoredCount                   int
	SolidCount                    int
	BookedCount                   int
	ScheduledCount                int
	SumSolidificationReceivedTime time.Duration
	SumBookedReceivedTime         time.Duration
	SumSchedulerReceivedTime      time.Duration
	SumSchedulerBookedTime        time.Duration
	MissingMessageCount           int
}

DBStatsResult is a structure containing all the statistics retrieved by DBStats() method.

type DispatcherEvents added in v0.8.4 

type DispatcherEvents struct {
	// MessageDispatched is triggered when a message is already scheduled and thus ready to be dispatched.
	MessageDispatched *event.Event[*MessageDispatchedEvent]
}

DispatcherEvents represents events happening in the Dispatcher.

type EventMock added in v0.8.0 

type EventMock struct {
	mock.Mock
	// contains filtered or unexported fields
}

EventMock acts as a container for event mocks.

func NewEventMock added in v0.8.0 

func NewEventMock(t *testing.T, approvalWeightManager *ApprovalWeightManager) *EventMock

NewEventMock creates a new EventMock.

func (*EventMock) AssertExpectations added in v0.8.0 

func (e *EventMock) AssertExpectations(t mock.TestingT) bool

AssertExpectations asserts expectations.

func (*EventMock) BranchWeightChanged added in v0.8.0 

func (e *EventMock) BranchWeightChanged(event *BranchWeightChangedEvent)

BranchWeightChanged is the mocked BranchWeightChanged function.

func (*EventMock) DetachAll added in v0.8.0 

func (e *EventMock) DetachAll()

DetachAll detaches all event handlers.

func (*EventMock) Expect added in v0.8.0 

func (e *EventMock) Expect(eventName string, arguments ...interface{})

Expect is a proxy for Mock.On() but keeping track of num of calls.

func (*EventMock) MarkerWeightChanged added in v0.8.0 

func (e *EventMock) MarkerWeightChanged(event *MarkerWeightChangedEvent)

MarkerWeightChanged is the mocked MarkerWeightChanged function.

func (*EventMock) MessageProcessed added in v0.8.0 

func (e *EventMock) MessageProcessed(event *MessageProcessedEvent)

MessageProcessed is the mocked MessageProcessed function.

type Events 

type Events struct {
	// MessageInvalid is triggered when a Message is detected to be objectively invalid.
	MessageInvalid *event.Event[*MessageInvalidEvent]

	// Error is triggered when the Tangle faces an error from which it can not recover.
	Error *event.Event[error]
}

Events represents events happening in the Tangle.

type LastMessage added in v0.9.1 

type LastMessage struct {
	MessageID MessageID `serix:"0"`
	// MessageTime field is the time of the last confirmed message.
	MessageTime time.Time `serix:"1"`
	// UpdateTime field is the time when the last confirmed message was updated.
	UpdateTime time.Time `serix:"2"`
}

LastMessage is a wrapper type for the last confirmed message, consisting of MessageID, MessageTime and UpdateTime.

func (LastMessage) Bytes added in v0.9.1 

func (l LastMessage) Bytes() (marshaledLastConfirmedMessage []byte)

Bytes returns a marshaled version of the LastMessage.

func (LastMessage) String added in v0.9.1 

func (l LastMessage) String() string

String returns a human-readable version of the LastMessage.

type LatestBranchVotes added in v0.8.6 

type LatestBranchVotes struct {
	model.Storable[Voter, LatestBranchVotes, *LatestBranchVotes, latestBranchVotesModel] `serix:"0"`
}

LatestBranchVotes represents the branch supported from an Issuer.

func NewLatestBranchVotes added in v0.8.6 

func NewLatestBranchVotes(voter Voter) (latestBranchVotes *LatestBranchVotes)

NewLatestBranchVotes creates a new LatestBranchVotes.

func (*LatestBranchVotes) Store added in v0.8.6 

func (l *LatestBranchVotes) Store(vote *BranchVote) (stored bool)

Store stores the vote for the LatestBranchVotes.

func (*LatestBranchVotes) Vote added in v0.8.6 

func (l *LatestBranchVotes) Vote(branchID utxo.TransactionID) (vote *BranchVote, exists bool)

Vote returns the Vote for the LatestBranchVotes.

type LatestMarkerVotes added in v0.8.6 

type LatestMarkerVotes struct {
	model.StorableReferenceWithMetadata[LatestMarkerVotes, *LatestMarkerVotes, markers.SequenceID, Voter, thresholdmap.ThresholdMap[markers.Index, VotePower]] `serix:"0"`
}

LatestMarkerVotes keeps track of the most up-to-date for a certain Voter casted on a specific Marker SequenceID. Votes can be casted on Markers (SequenceID, Index), but can arrive in any arbitrary order. Due to the nature of a Sequence, a vote casted for a certain Index clobbers votes for every lower index. Similarly, if a vote for an Index is casted and an existing vote for an higher Index exists, the operation has no effect.

func NewLatestMarkerVotes added in v0.8.6 

func NewLatestMarkerVotes(sequenceID markers.SequenceID, voter Voter) (newLatestMarkerVotes *LatestMarkerVotes)

NewLatestMarkerVotes creates a new NewLatestMarkerVotes instance associated with the given details.

func (*LatestMarkerVotes) Power added in v0.8.6 

func (l *LatestMarkerVotes) Power(index markers.Index) (power VotePower, exists bool)

Power returns the power of the vote for the given marker Index.

func (*LatestMarkerVotes) Store added in v0.8.6 

func (l *LatestMarkerVotes) Store(index markers.Index, power VotePower) (stored bool, previousHighestIndex markers.Index)

Store stores the vote with the given marker Index and votePower. The votePower parameter is used to determine the order of the vote.

func (*LatestMarkerVotes) Voter added in v0.8.6 

func (l *LatestMarkerVotes) Voter() Voter

Voter returns the Voter for the LatestMarkerVotes.

type LikedConflictMembers added in v0.8.6 

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

LikedConflictMembers is a struct that holds information about which Conflict is the liked one out of a set of ConflictMembers.

type ManaRetrieverFunc added in v0.5.8 

type ManaRetrieverFunc func() map[identity.ID]float64

ManaRetrieverFunc is a function type to retrieve consensus mana (e.g. via the mana plugin).

type MarkerBranchAddedEvent added in v0.9.0 

type MarkerBranchAddedEvent struct {
	Marker      markers.Marker
	NewBranchID utxo.TransactionID
}

type MarkerIndexBranchIDMapping added in v0.3.6 

type MarkerIndexBranchIDMapping struct {
	model.Storable[markers.SequenceID, MarkerIndexBranchIDMapping, *MarkerIndexBranchIDMapping, markerIndexBranchIDMap] `serix:"0"`
}

MarkerIndexBranchIDMapping is a data structure that allows to map marker Indexes to a BranchID.

func NewMarkerIndexBranchIDMapping added in v0.3.6 

func NewMarkerIndexBranchIDMapping(sequenceID markers.SequenceID) (markerBranchMapping *MarkerIndexBranchIDMapping)

NewMarkerIndexBranchIDMapping creates a new MarkerIndexBranchIDMapping for the given SequenceID.

func (*MarkerIndexBranchIDMapping) BranchIDs added in v0.8.10 

func (m *MarkerIndexBranchIDMapping) BranchIDs(markerIndex markers.Index) (branchIDs utxo.TransactionIDs)

BranchIDs returns the BranchID that is associated to the given marker Index.

func (*MarkerIndexBranchIDMapping) Ceiling added in v0.5.7 

func (m *MarkerIndexBranchIDMapping) Ceiling(index markers.Index) (marker markers.Index, branchIDs utxo.TransactionIDs, exists bool)

Ceiling returns the smallest Index that is >= the given Index which has a mapped BranchID (and a boolean value indicating if it exists).

func (*MarkerIndexBranchIDMapping) DeleteBranchID added in v0.8.0 

func (m *MarkerIndexBranchIDMapping) DeleteBranchID(index markers.Index)

DeleteBranchID deletes a mapping between the given marker Index and the stored BranchID.

func (*MarkerIndexBranchIDMapping) Floor added in v0.5.7 

func (m *MarkerIndexBranchIDMapping) Floor(index markers.Index) (marker markers.Index, branchIDs utxo.TransactionIDs, exists bool)

Floor returns the largest Index that is <= the given Index which has a mapped BranchID (and a boolean value indicating if it exists).

func (*MarkerIndexBranchIDMapping) SequenceID added in v0.3.6 

func (m *MarkerIndexBranchIDMapping) SequenceID() markers.SequenceID

SequenceID returns the SequenceID that this MarkerIndexBranchIDMapping represents.

func (*MarkerIndexBranchIDMapping) SetBranchIDs added in v0.8.10 

func (m *MarkerIndexBranchIDMapping) SetBranchIDs(index markers.Index, branchIDs utxo.TransactionIDs)

SetBranchIDs creates a mapping between the given marker Index and the given BranchID.

type MarkerMessageMapping added in v0.5.7 

type MarkerMessageMapping struct {
	model.Storable[markers.Marker, MarkerMessageMapping, *MarkerMessageMapping, MessageID] `serix:"0"`
}

MarkerMessageMapping is a data structure that denotes a mapping from a Marker to a Message.

func NewMarkerMessageMapping added in v0.5.7 

func NewMarkerMessageMapping(marker markers.Marker, messageID MessageID) *MarkerMessageMapping

NewMarkerMessageMapping is the constructor for the MarkerMessageMapping.

func (*MarkerMessageMapping) Marker added in v0.5.7 

func (m *MarkerMessageMapping) Marker() *markers.Marker

Marker returns the Marker that is mapped to a MessageID.

func (*MarkerMessageMapping) MessageID added in v0.5.7 

func (m *MarkerMessageMapping) MessageID() MessageID

MessageID returns the MessageID of the Marker.

type MarkerWeightChangedEvent added in v0.8.0 

type MarkerWeightChangedEvent struct {
	Marker markers.Marker
	Weight float64
}

MarkerWeightChangedEvent holds information about a marker and its updated weight.

type Message 

type Message struct {
	model.Storable[MessageID, Message, *Message, MessageModel] `serix:"0"`
	// contains filtered or unexported fields
}

Message represents the core message for the base layer Tangle.

func NewMessage 

func NewMessage(references ParentMessageIDs, issuingTime time.Time, issuerPublicKey ed25519.PublicKey,
	sequenceNumber uint64, msgPayload payload.Payload, nonce uint64, signature ed25519.Signature, versionOpt ...uint8) *Message

NewMessage creates a new message with the details provided by the issuer.

func NewMessageWithValidation added in v0.9.0 

func NewMessageWithValidation(references ParentMessageIDs, issuingTime time.Time, issuerPublicKey ed25519.PublicKey,
	sequenceNumber uint64, msgPayload payload.Payload, nonce uint64, signature ed25519.Signature, version ...uint8) (result *Message, err error)

NewMessageWithValidation creates a new message while performing ths following syntactical checks: 1. A Strong Parents Block must exist. 2. Parents Block types cannot repeat. 3. Parent count per block 1 <= x <= 8. 4. Parents unique within block. 5. Parents lexicographically sorted within block. 7. Blocks should be ordered by type in ascending order. 6. A Parent(s) repetition is only allowed when it occurs across Strong and Like parents.

func (*Message) DetermineID added in v0.9.0 

func (m *Message) DetermineID() (err error)

DetermineID calculates and sets the message's MessageID.

func (*Message) ForEachParent added in v0.3.1 

func (m *Message) ForEachParent(consumer func(parent Parent))

ForEachParent executes a consumer func for each parent.

func (*Message) ForEachParentByType added in v0.8.0 

func (m *Message) ForEachParentByType(parentType ParentsType, consumer func(parentMessageID MessageID) bool)

ForEachParentByType executes a consumer func for each strong parent.

func (*Message) IDBytes added in v0.6.2 

func (m *Message) IDBytes() []byte

IDBytes implements Element interface in scheduler NodeQueue that returns the MessageID of the message in bytes.

func (*Message) IssuerPublicKey 

func (m *Message) IssuerPublicKey() ed25519.PublicKey

IssuerPublicKey returns the public key of the message issuer.

func (*Message) IssuingTime 

func (m *Message) IssuingTime() time.Time

IssuingTime returns the time when this message was created.

func (*Message) Nonce 

func (m *Message) Nonce() uint64

Nonce returns the Nonce of the message.

func (*Message) Parents added in v0.3.6 

func (m *Message) Parents() (parents []MessageID)

func (*Message) ParentsByType added in v0.8.0 

func (m *Message) ParentsByType(parentType ParentsType) MessageIDs

ParentsByType returns a slice of all parents of the desired type.

func (*Message) ParentsCountByType added in v0.8.0 

func (m *Message) ParentsCountByType(parentType ParentsType) uint8

ParentsCountByType returns the total parents count of this message.

func (*Message) Payload 

func (m *Message) Payload() payload.Payload

Payload returns the Payload of the message.

func (*Message) SequenceNumber 

func (m *Message) SequenceNumber() uint64

SequenceNumber returns the sequence number of this message.

func (*Message) Signature 

func (m *Message) Signature() ed25519.Signature

Signature returns the Signature of the message.

func (*Message) Size added in v0.6.2 

func (m *Message) Size() int

Size returns the message size in bytes.

func (*Message) String 

func (m *Message) String() string

func (*Message) VerifySignature 

func (m *Message) VerifySignature() (valid bool, err error)

VerifySignature verifies the Signature of the message.

func (*Message) Version added in v0.3.1 

func (m *Message) Version() uint8

Version returns the message Version.

type MessageBookedEvent added in v0.9.0 

type MessageBookedEvent struct {
	MessageID MessageID
}

type MessageBranchUpdatedEvent added in v0.9.0 

type MessageBranchUpdatedEvent struct {
	MessageID MessageID
	BranchID  utxo.TransactionID
}

type MessageConfirmedEvent added in v0.9.0 

type MessageConfirmedEvent struct {
	Message *Message
}

type MessageConstructedEvent added in v0.9.0 

type MessageConstructedEvent struct {
	Message *Message
}

type MessageDiscardedEvent added in v0.9.0 

type MessageDiscardedEvent struct {
	MessageID MessageID
}

type MessageDispatchedEvent added in v0.9.0 

type MessageDispatchedEvent struct {
	MessageID MessageID
}

type MessageFactory 

type MessageFactory struct {
	Events *MessageFactoryEvents

	ReferenceProvider *ReferenceProvider
	// contains filtered or unexported fields
}

MessageFactory acts as a factory to create new messages.

func NewMessageFactory 

func NewMessageFactory(tangle *Tangle, selector TipSelector, referencesFunc ...ReferencesFunc) *MessageFactory

NewMessageFactory creates a new message factory.

func (*MessageFactory) EarliestAttachment added in v0.9.0 

func (f *MessageFactory) EarliestAttachment(transactionIDs utxo.TransactionIDs) (earliestAttachment *Message)

func (*MessageFactory) IssuePayload 

func (f *MessageFactory) IssuePayload(p payload.Payload, parentsCount ...int) (*Message, error)

IssuePayload creates a new message including sequence number and tip selection and returns it.

func (*MessageFactory) IssuePayloadWithReferences added in v0.8.10 

func (f *MessageFactory) IssuePayloadWithReferences(p payload.Payload, references ParentMessageIDs, parentsCount ...int) (*Message, error)

IssuePayloadWithReferences creates a new message with the references submit.

func (*MessageFactory) LatestAttachment added in v0.9.0 

func (f *MessageFactory) LatestAttachment(transactionID utxo.TransactionID) (latestAttachment *Message)

func (*MessageFactory) SetTimeout added in v0.6.2 

func (f *MessageFactory) SetTimeout(timeout time.Duration)

SetTimeout sets the timeout for PoW.

func (*MessageFactory) SetWorker 

func (f *MessageFactory) SetWorker(worker Worker)

SetWorker sets the PoW worker to be used for the messages.

func (*MessageFactory) Shutdown 

func (f *MessageFactory) Shutdown()

Shutdown closes the MessageFactory and persists the sequence number.

type MessageFactoryEvents 

type MessageFactoryEvents struct {
	// Fired when a message is built including tips, sequence number and other metadata.
	MessageConstructed *event.Event[*MessageConstructedEvent]

	// Fired when an error occurred.
	Error *event.Event[error]
}

MessageFactoryEvents represents events happening on a message factory.

func NewMessageFactoryEvents added in v0.9.0 

func NewMessageFactoryEvents() (new *MessageFactoryEvents)

NewMessageFactoryEvents returns a new MessageFactoryEvents object.

type MessageFilter 

type MessageFilter interface {
	// Filter filters up on the given message and peer and calls the acceptance callback
	// if the input passes or the rejection callback if the input is rejected.
	Filter(msg *Message, peer *peer.Peer)
	// OnAccept registers the given callback as the acceptance function of the filter.
	OnAccept(callback func(msg *Message, peer *peer.Peer))
	// OnReject registers the given callback as the rejection function of the filter.
	OnReject(callback func(msg *Message, err error, peer *peer.Peer))
	// Closer closes the filter.
	io.Closer
}

MessageFilter filters based on messages and peers.

type MessageID 

type MessageID struct {
	types.Identifier `serix:"0"`
}

MessageID identifies a message via its BLAKE2b-256 hash of its bytes. 

var EmptyMessageID MessageID

EmptyMessageID is an empty id.

func MessageIDFromContext added in v0.9.0 

func MessageIDFromContext(ctx context.Context) MessageID

func NewMessageID 

func NewMessageID(bytes [32]byte) (new MessageID)

NewMessageID returns a new MessageID for the given data.

func (MessageID) CompareTo added in v0.8.0 

func (m MessageID) CompareTo(other MessageID) int

CompareTo does a lexicographical comparison to another messageID. Returns 0 if equal, -1 if smaller, or 1 if larger than other. Passing nil as other will result in a panic.

func (MessageID) Length added in v0.9.0 

func (m MessageID) Length() int

Length returns the byte length of a serialized TransactionID.

func (MessageID) String 

func (m MessageID) String() (humanReadable string)

String returns a human-readable version of the MessageID.

type MessageIDs added in v0.3.1 

type MessageIDs map[MessageID]types.Empty

MessageIDs is a set of MessageIDs where every MessageID is stored only once.

func NewMessageIDs added in v0.8.6 

func NewMessageIDs(msgIDs ...MessageID) MessageIDs

NewMessageIDs construct a new MessageID collection from the optional MessageIDs.

func (MessageIDs) Add added in v0.8.6 

func (m MessageIDs) Add(messageID MessageID) MessageIDs

Add adds a MessageID to the collection and returns the collection to enable chaining.

func (MessageIDs) AddAll added in v0.8.6 

func (m MessageIDs) AddAll(messageIDs MessageIDs) MessageIDs

AddAll adds all MessageIDs to the collection and returns the collection to enable chaining.

func (MessageIDs) Base58 added in v0.8.10 

func (m MessageIDs) Base58() (result []string)

Base58 returns a string slice of base58 MessageID.

func (MessageIDs) Clone added in v0.8.6 

func (m MessageIDs) Clone() (clonedMessageIDs MessageIDs)

Clone creates a copy of the MessageIDs.

func (MessageIDs) Contains added in v0.8.10 

func (m MessageIDs) Contains(target MessageID) (contains bool)

Contains checks if the given target MessageID is part of the MessageIDs.

func (MessageIDs) Empty added in v0.8.11 

func (m MessageIDs) Empty() (empty bool)

Empty checks if MessageIDs is empty.

func (MessageIDs) First added in v0.8.10 

func (m MessageIDs) First() MessageID

First returns the first element in MessageIDs (not ordered). This method only makes sense if there is exactly one element in the collection.

func (MessageIDs) Slice added in v0.8.6 

func (m MessageIDs) Slice() []MessageID

Slice converts the set of MessageIDs into a slice of MessageIDs.

func (MessageIDs) String added in v0.8.10 

func (m MessageIDs) String() string

String returns a human-readable Version of the MessageIDs.

func (MessageIDs) Subtract added in v0.8.11 

func (m MessageIDs) Subtract(other MessageIDs) MessageIDs

Subtract removes all other from the collection and returns the collection to enable chaining.

type MessageInvalidEvent added in v0.7.6 

type MessageInvalidEvent struct {
	MessageID MessageID
	Error     error
}

MessageInvalidEvent is struct that is passed along with triggering a messageInvalidEvent.

type MessageMetadata 

type MessageMetadata struct {
	model.Storable[MessageID, MessageMetadata, *MessageMetadata, messageMetadataModel] `serix:"0"`
}

MessageMetadata defines the metadata for a message.

func NewMessageMetadata 

func NewMessageMetadata(messageID MessageID) *MessageMetadata

NewMessageMetadata creates a new MessageMetadata from the specified messageID.

func (*MessageMetadata) AddBranchID added in v0.8.10 

func (m *MessageMetadata) AddBranchID(branchID utxo.TransactionID) (modified bool)

AddBranchID sets the BranchIDs of the added Branches.

func (*MessageMetadata) AddedBranchIDs added in v0.8.6 

func (m *MessageMetadata) AddedBranchIDs() utxo.TransactionIDs

AddedBranchIDs returns the BranchIDs of the added Branches of the Message.

func (*MessageMetadata) BookedTime added in v0.5.3 

func (m *MessageMetadata) BookedTime() time.Time

BookedTime returns the time when the message represented by this metadata was booked.

func (*MessageMetadata) DiscardedTime added in v0.8.4 

func (m *MessageMetadata) DiscardedTime() time.Time

DiscardedTime returns when the message was discarded.

func (*MessageMetadata) GradeOfFinality added in v0.8.0 

func (m *MessageMetadata) GradeOfFinality() (result gof.GradeOfFinality)

GradeOfFinality returns the grade of finality.

func (*MessageMetadata) GradeOfFinalityTime added in v0.8.0 

func (m *MessageMetadata) GradeOfFinalityTime() time.Time

GradeOfFinalityTime returns the time the grade of finality was set.

func (*MessageMetadata) IsBooked added in v0.3.6 

func (m *MessageMetadata) IsBooked() (result bool)

IsBooked returns true if the message represented by this metadata is booked. False otherwise.

func (*MessageMetadata) IsObjectivelyInvalid added in v0.8.6 

func (m *MessageMetadata) IsObjectivelyInvalid() (result bool)

IsObjectivelyInvalid returns true if the message represented by this metadata is objectively invalid.

func (*MessageMetadata) IsSolid 

func (m *MessageMetadata) IsSolid() (result bool)

IsSolid returns true if the message represented by this metadata is solid. False otherwise.

func (*MessageMetadata) IsSubjectivelyInvalid added in v0.8.6 

func (m *MessageMetadata) IsSubjectivelyInvalid() (result bool)

IsSubjectivelyInvalid returns true if the message represented by this metadata is subjectively invalid.

func (*MessageMetadata) QueuedTime added in v0.8.4 

func (m *MessageMetadata) QueuedTime() time.Time

QueuedTime returns the time a message entered the scheduling queue.

func (*MessageMetadata) ReceivedTime 

func (m *MessageMetadata) ReceivedTime() time.Time

ReceivedTime returns the time when the message was received.

func (*MessageMetadata) Scheduled added in v0.4.0 

func (m *MessageMetadata) Scheduled() bool

Scheduled returns true if the message represented by this metadata was scheduled. False otherwise.

func (*MessageMetadata) ScheduledTime added in v0.5.3 

func (m *MessageMetadata) ScheduledTime() time.Time

ScheduledTime returns the time when the message represented by this metadata was scheduled.

func (*MessageMetadata) SetAddedBranchIDs added in v0.8.6 

func (m *MessageMetadata) SetAddedBranchIDs(addedBranchIDs utxo.TransactionIDs) (modified bool)

SetAddedBranchIDs sets the BranchIDs of the added Branches.

func (*MessageMetadata) SetBooked added in v0.3.6 

func (m *MessageMetadata) SetBooked(booked bool) (modified bool)

SetBooked sets the message associated with this metadata as booked. It returns true if the booked status is modified. False otherwise.

func (*MessageMetadata) SetDiscardedTime added in v0.8.4 

func (m *MessageMetadata) SetDiscardedTime(discardedTime time.Time)

SetDiscardedTime add the discarded time of a message to the metadata.

func (*MessageMetadata) SetGradeOfFinality added in v0.8.0 

func (m *MessageMetadata) SetGradeOfFinality(gradeOfFinality gof.GradeOfFinality) (modified bool)

SetGradeOfFinality sets the grade of finality associated with this metadata. It returns true if the grade of finality is modified. False otherwise.

func (*MessageMetadata) SetObjectivelyInvalid added in v0.8.6 

func (m *MessageMetadata) SetObjectivelyInvalid(invalid bool) (modified bool)

SetObjectivelyInvalid sets the message associated with this metadata as objectively invalid - it returns true if the status was changed.

func (*MessageMetadata) SetQueuedTime added in v0.8.4 

func (m *MessageMetadata) SetQueuedTime(queuedTime time.Time)

SetQueuedTime records the time the message entered the scheduler queue.

func (*MessageMetadata) SetScheduled added in v0.4.0 

func (m *MessageMetadata) SetScheduled(scheduled bool) (modified bool)

SetScheduled sets the message associated with this metadata as scheduled. It returns true if the scheduled status is modified. False otherwise.

func (*MessageMetadata) SetSolid 

func (m *MessageMetadata) SetSolid(solid bool) (modified bool)

SetSolid sets the message associated with this metadata as solid. It returns true if the solid status is modified. False otherwise.

func (*MessageMetadata) SetStructureDetails added in v0.3.6 

func (m *MessageMetadata) SetStructureDetails(structureDetails *markers.StructureDetails) (modified bool)

SetStructureDetails sets the structureDetails of the message.

func (*MessageMetadata) SetSubjectivelyInvalid added in v0.8.6 

func (m *MessageMetadata) SetSubjectivelyInvalid(invalid bool) (modified bool)

SetSubjectivelyInvalid sets the message associated with this metadata as subjectively invalid - it returns true if the status was changed.

func (*MessageMetadata) SetSubtractedBranchIDs added in v0.8.6 

func (m *MessageMetadata) SetSubtractedBranchIDs(subtractedBranchIDs utxo.TransactionIDs) (modified bool)

SetSubtractedBranchIDs sets the BranchIDs of the subtracted Branches.

func (*MessageMetadata) SolidificationTime 

func (m *MessageMetadata) SolidificationTime() time.Time

SolidificationTime returns the time when the message was marked to be solid.

func (*MessageMetadata) StructureDetails added in v0.3.6 

func (m *MessageMetadata) StructureDetails() *markers.StructureDetails

StructureDetails returns the structureDetails of the message.

func (*MessageMetadata) SubtractedBranchIDs added in v0.8.6 

func (m *MessageMetadata) SubtractedBranchIDs() utxo.TransactionIDs

SubtractedBranchIDs returns the BranchIDs of the subtracted Branches of the Message.

type MessageMissingEvent added in v0.9.0 

type MessageMissingEvent struct {
	MessageID MessageID
}

type MessageModel added in v0.9.0 

type MessageModel struct {
	// core properties (get sent over the wire)
	Version         uint8             `serix:"0"`
	Parents         ParentMessageIDs  `serix:"1"`
	IssuerPublicKey ed25519.PublicKey `serix:"2"`
	IssuingTime     time.Time         `serix:"3"`
	SequenceNumber  uint64            `serix:"4"`
	PayloadBytes    []byte            `serix:"5,lengthPrefixType=uint32"`
	Nonce           uint64            `serix:"6"`
	Signature       ed25519.Signature `serix:"7"`
}

type MessageOption added in v0.5.3 

type MessageOption func(*MessageTestFrameworkMessageOptions)

MessageOption is the type that is used for options that can be passed into the CreateMessage method to configure its behavior.

func WithColoredOutput added in v0.5.3 

func WithColoredOutput(alias string, balances map[devnetvm.Color]uint64) MessageOption

WithColoredOutput returns a MessageOption that is used to define a colored Output for the Transaction in the Message.

func WithInputs added in v0.5.3 

func WithInputs(inputAliases ...string) MessageOption

WithInputs returns a MessageOption that is used to provide the Inputs of the Transaction.

func WithIssuer added in v0.5.7 

func WithIssuer(issuer ed25519.PublicKey) MessageOption

WithIssuer returns a MessageOption that is used to define the issuer of the Message.

func WithIssuingTime added in v0.8.0 

func WithIssuingTime(issuingTime time.Time) MessageOption

WithIssuingTime returns a MessageOption that is used to set issuing time of the Message.

func WithOutput added in v0.5.3 

func WithOutput(alias string, balance uint64) MessageOption

WithOutput returns a MessageOption that is used to define a non-colored Output for the Transaction in the Message.

func WithReattachment added in v0.8.0 

func WithReattachment(messageAlias string) MessageOption

WithReattachment returns a MessageOption that is used to select payload of which Message should be reattached.

func WithSequenceNumber added in v0.8.6 

func WithSequenceNumber(sequenceNumber uint64) MessageOption

WithSequenceNumber returns a MessageOption that is used to define the sequence number of the Message.

func WithShallowLikeParents added in v0.8.6 

func WithShallowLikeParents(messageAliases ...string) MessageOption

WithShallowLikeParents returns a MessageOption that is used to define the shallow like parents of the Message.

func WithStrongParents added in v0.5.3 

func WithStrongParents(messageAliases ...string) MessageOption

WithStrongParents returns a MessageOption that is used to define the strong parents of the Message.

func WithWeakParents added in v0.5.3 

func WithWeakParents(messageAliases ...string) MessageOption

WithWeakParents returns a MessageOption that is used to define the weak parents of the Message.

type MessageParsedEvent 

type MessageParsedEvent struct {
	// Message contains the parsed Message.
	Message *Message

	// Peer contains the node that sent this Message to the node.
	Peer *peer.Peer
}

MessageParsedEvent holds the information provided by the MessageParsed event that gets triggered when a message was fully parsed and syntactically validated.

type MessageProcessedEvent added in v0.9.0 

type MessageProcessedEvent struct {
	MessageID MessageID
}

MessageProcessedEvent holds information about a processed message.

type MessageRejectedEvent 

type MessageRejectedEvent struct {
	Message *Message
	Peer    *peer.Peer
	Error   error
}

MessageRejectedEvent holds the information provided by the MessageRejected event that gets triggered when the Message was detected to be invalid.

type MessageRemovedEvent added in v0.9.0 

type MessageRemovedEvent struct {
	MessageID MessageID
}

type MessageScheduledEvent added in v0.9.0 

type MessageScheduledEvent struct {
	MessageID MessageID
}

type MessageSignatureFilter 

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

MessageSignatureFilter filters messages based on whether their signatures are valid.

func NewMessageSignatureFilter 

func NewMessageSignatureFilter() *MessageSignatureFilter

NewMessageSignatureFilter creates a new message signature filter.

func (*MessageSignatureFilter) Close added in v0.7.6 

func (f *MessageSignatureFilter) Close() error

Close closes the filter.

func (*MessageSignatureFilter) Filter 

func (f *MessageSignatureFilter) Filter(msg *Message, peer *peer.Peer)

Filter filters up on the given bytes and peer and calls the acceptance callback if the input passes or the rejection callback if the input is rejected.

func (*MessageSignatureFilter) OnAccept 

func (f *MessageSignatureFilter) OnAccept(callback func(msg *Message, peer *peer.Peer))

OnAccept registers the given callback as the acceptance function of the filter.

func (*MessageSignatureFilter) OnReject 

func (f *MessageSignatureFilter) OnReject(callback func(msg *Message, err error, peer *peer.Peer))

OnReject registers the given callback as the rejection function of the filter.

type MessageSkippedEvent added in v0.9.0 

type MessageSkippedEvent struct {
	MessageID MessageID
}

type MessageSolidEvent added in v0.9.0 

type MessageSolidEvent struct {
	Message *Message
}

type MessageStoredEvent added in v0.9.0 

type MessageStoredEvent struct {
	Message *Message
}

type MessageTestFramework added in v0.5.3 

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

MessageTestFramework implements a framework for conveniently issuing messages in a tangle as part of unit tests in a simplified way.

func NewMessageTestFramework added in v0.5.3 

func NewMessageTestFramework(tangle *Tangle, options ...MessageTestFrameworkOption) (messageTestFramework *MessageTestFramework)

NewMessageTestFramework is the constructor of the MessageTestFramework.

func (*MessageTestFramework) Branch added in v0.8.0 

func (m *MessageTestFramework) Branch(messageAlias string) (b *conflictdag.Conflict[utxo.TransactionID, utxo.OutputID])

Branch returns the branch emerging from the transaction contained within the given message. This function thus only works on the message creating ledger.Conflict. Panics if the message's payload isn't a transaction.

func (*MessageTestFramework) BranchID added in v0.5.7 

func (m *MessageTestFramework) BranchID(alias string) (branchID utxo.TransactionID)

BranchID returns the BranchID registered with the given alias.

func (*MessageTestFramework) BranchIDFromMessage added in v0.8.0 

func (m *MessageTestFramework) BranchIDFromMessage(messageAlias string) utxo.TransactionID

BranchIDFromMessage returns the BranchID of the Transaction contained in the Message associated with the given alias.

func (*MessageTestFramework) BranchIDs added in v0.8.6 

func (m *MessageTestFramework) BranchIDs(aliases ...string) (branchIDs utxo.TransactionIDs)

BranchIDs returns the BranchIDs registered with the given aliases.

func (*MessageTestFramework) CreateMessage added in v0.5.3 

func (m *MessageTestFramework) CreateMessage(messageAlias string, messageOptions ...MessageOption) (message *Message)

CreateMessage creates a Message with the given alias and MessageTestFrameworkMessageOptions.

func (*MessageTestFramework) IncreaseMarkersIndexCallback added in v0.5.7 

func (m *MessageTestFramework) IncreaseMarkersIndexCallback(markers.SequenceID, markers.Index) bool

IncreaseMarkersIndexCallback is the IncreaseMarkersIndexCallback that the MessageTestFramework uses to determine when to assign new Markers to messages.

func (*MessageTestFramework) IssueMessages added in v0.5.3 

func (m *MessageTestFramework) IssueMessages(messageAliases ...string) *MessageTestFramework

IssueMessages stores the given Messages in the Storage and triggers the processing by the Tangle.

func (*MessageTestFramework) Message added in v0.5.3 

func (m *MessageTestFramework) Message(alias string) (message *Message)

Message retrieves the Messages that is associated with the given alias.

func (*MessageTestFramework) MessageIDs added in v0.9.0 

func (m *MessageTestFramework) MessageIDs(aliases ...string) (messageIDs MessageIDs)

Message retrieves the Messages that is associated with the given alias.

func (*MessageTestFramework) MessageMetadata added in v0.5.7 

func (m *MessageTestFramework) MessageMetadata(alias string) (messageMetadata *MessageMetadata)

MessageMetadata retrieves the MessageMetadata that is associated with the given alias.

func (*MessageTestFramework) OutputMetadata added in v0.8.0 

func (m *MessageTestFramework) OutputMetadata(outputID utxo.OutputID) (outMeta *ledger.OutputMetadata)

OutputMetadata returns the given output metadata.

func (*MessageTestFramework) PreventNewMarkers added in v0.5.7 

func (m *MessageTestFramework) PreventNewMarkers(enabled bool) *MessageTestFramework

PreventNewMarkers disables the generation of new Markers for the given Messages.

func (*MessageTestFramework) RegisterBranchID added in v0.8.0 

func (m *MessageTestFramework) RegisterBranchID(alias, messageAlias string)

RegisterBranchID registers a BranchID from the given Messages' transactions with the MessageTestFramework and also an alias when printing the BranchID.

func (*MessageTestFramework) RegisterTransactionID added in v0.9.0 

func (m *MessageTestFramework) RegisterTransactionID(alias, messageAlias string)

func (*MessageTestFramework) Transaction added in v0.8.0 

func (m *MessageTestFramework) Transaction(messageAlias string) (tx utxo.Transaction)

Transaction returns the transaction contained within the given message. Panics if the message's payload isn't a transaction.

func (*MessageTestFramework) TransactionID added in v0.5.7 

func (m *MessageTestFramework) TransactionID(messageAlias string) utxo.TransactionID

TransactionID returns the TransactionID of the Transaction contained in the Message associated with the given alias.

func (*MessageTestFramework) TransactionMetadata added in v0.8.0 

func (m *MessageTestFramework) TransactionMetadata(messageAlias string) (txMeta *ledger.TransactionMetadata)

TransactionMetadata returns the transaction metadata of the transaction contained within the given message. Panics if the message's payload isn't a transaction.

func (*MessageTestFramework) WaitUntilAllTasksProcessed added in v0.9.0 

func (m *MessageTestFramework) WaitUntilAllTasksProcessed() (self *MessageTestFramework)

type MessageTestFrameworkMessageOptions added in v0.5.3 

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

MessageTestFrameworkMessageOptions is a struct that represents a collection of options that can be set when creating a Message with the MessageTestFramework.

func NewMessageTestFrameworkMessageOptions added in v0.5.3 

func NewMessageTestFrameworkMessageOptions(options ...MessageOption) (messageOptions *MessageTestFrameworkMessageOptions)

NewMessageTestFrameworkMessageOptions is the constructor for the MessageTestFrameworkMessageOptions.

type MessageTestFrameworkOption added in v0.5.3 

type MessageTestFrameworkOption func(*MessageTestFrameworkOptions)

MessageTestFrameworkOption is the type that is used for options that can be passed into the MessageTestFramework to configure its behavior.

func WithColoredGenesisOutput added in v0.5.3 

func WithColoredGenesisOutput(alias string, balances map[devnetvm.Color]uint64) MessageTestFrameworkOption

WithColoredGenesisOutput returns a MessageTestFrameworkOption that defines a genesis Output that is loaded as part of the initial snapshot and that supports colored coins.

func WithGenesisOutput added in v0.5.3 

func WithGenesisOutput(alias string, balance uint64) MessageTestFrameworkOption

WithGenesisOutput returns a MessageTestFrameworkOption that defines a genesis Output that is loaded as part of the initial snapshot.

type MessageTestFrameworkOptions added in v0.5.3 

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

MessageTestFrameworkOptions is a container that holds the values of all configurable options of the MessageTestFramework.

func NewMessageTestFrameworkOptions added in v0.5.3 

func NewMessageTestFrameworkOptions(options ...MessageTestFrameworkOption) (frameworkOptions *MessageTestFrameworkOptions)

NewMessageTestFrameworkOptions is the constructor for the MessageTestFrameworkOptions.

type MissingMessage 

type MissingMessage struct {
	model.Storable[MessageID, MissingMessage, *MissingMessage, time.Time] `serix:"0"`
}

MissingMessage represents a missing message.

func NewMissingMessage 

func NewMissingMessage(messageID MessageID) *MissingMessage

NewMissingMessage creates new missing message with the specified messageID.

func (*MissingMessage) MessageID 

func (m *MissingMessage) MessageID() MessageID

MessageID returns the id of the message.

func (*MissingMessage) MissingSince 

func (m *MissingMessage) MissingSince() time.Time

MissingSince returns the time since when this message is missing.

type MissingMessageStoredEvent added in v0.9.0 

type MissingMessageStoredEvent struct {
	MessageID MessageID
}

type MockConfirmationOracle added in v0.8.0 

type MockConfirmationOracle struct {
	sync.RWMutex
}

MockConfirmationOracle is a mock of a ConfirmationOracle.

func (*MockConfirmationOracle) Events added in v0.8.0 

func (m *MockConfirmationOracle) Events() *ConfirmationEvents

Events mocks its interface function.

func (*MockConfirmationOracle) FirstUnconfirmedMarkerIndex added in v0.8.6 

func (m *MockConfirmationOracle) FirstUnconfirmedMarkerIndex(sequenceID markers.SequenceID) (unconfirmedMarkerIndex markers.Index)

FirstUnconfirmedMarkerIndex mocks its interface function.

func (*MockConfirmationOracle) IsBranchConfirmed added in v0.8.0 

func (m *MockConfirmationOracle) IsBranchConfirmed(branchID utxo.TransactionID) bool

IsBranchConfirmed mocks its interface function.

func (*MockConfirmationOracle) IsMarkerConfirmed added in v0.8.0 

func (m *MockConfirmationOracle) IsMarkerConfirmed(markers.Marker) bool

IsMarkerConfirmed mocks its interface function.

func (*MockConfirmationOracle) IsMessageConfirmed added in v0.8.0 

func (m *MockConfirmationOracle) IsMessageConfirmed(msgID MessageID) bool

IsMessageConfirmed mocks its interface function.

func (*MockConfirmationOracle) IsOutputConfirmed added in v0.8.0 

func (m *MockConfirmationOracle) IsOutputConfirmed(outputID utxo.OutputID) bool

IsOutputConfirmed mocks its interface function.

func (*MockConfirmationOracle) IsTransactionConfirmed added in v0.8.0 

func (m *MockConfirmationOracle) IsTransactionConfirmed(transactionID utxo.TransactionID) bool

IsTransactionConfirmed mocks its interface function.

type MockWeightProvider added in v0.8.0 

type MockWeightProvider struct{}

MockWeightProvider is a mock of a WeightProvider.

func (*MockWeightProvider) Shutdown added in v0.8.0 

func (m *MockWeightProvider) Shutdown()

Shutdown mocks its interface function.

func (*MockWeightProvider) Update added in v0.8.0 

func (m *MockWeightProvider) Update(t time.Time, nodeID identity.ID)

Update mocks its interface function.

func (*MockWeightProvider) Weight added in v0.8.0 

func (m *MockWeightProvider) Weight(message *Message) (weight, totalWeight float64)

Weight mocks its interface function.

func (*MockWeightProvider) WeightsOfRelevantVoters added in v0.8.6 

func (m *MockWeightProvider) WeightsOfRelevantVoters() (weights map[identity.ID]float64, totalWeight float64)

WeightsOfRelevantVoters mocks its interface function.

type NodeBlacklistedEvent added in v0.9.0 

type NodeBlacklistedEvent struct {
	NodeID identity.ID
}

type NodeIdentities added in v0.8.0 

type NodeIdentities map[string]*identity.Identity

NodeIdentities defines a set of node identities mapped through an alias.

type NodesActivityLog added in v0.8.13 

type NodesActivityLog map[identity.ID]*ActivityLog

type OTVConsensusManager added in v0.8.0 

type OTVConsensusManager struct {
	consensus.Mechanism
}

OTVConsensusManager is the component in charge of forming opinions about branches.

func NewOTVConsensusManager added in v0.8.0 

func NewOTVConsensusManager(otvConsensusMechanism consensus.Mechanism) *OTVConsensusManager

NewOTVConsensusManager returns a new Mechanism.

type Opinion added in v0.3.6 

type Opinion uint8

Opinion is a type that represents the Opinion of a node on a certain Branch. 

const (
	// UndefinedOpinion represents the zero value of the Opinion type.
	UndefinedOpinion Opinion = iota

	// Confirmed represents the Opinion that a given Branch is the winning one.
	Confirmed

	// Rejected represents the Opinion that a given Branch is the loosing one.
	Rejected
)

type Option 

type Option func(*Options)

Option represents the return type of optional parameters that can be handed into the constructor of the Tangle to configure its behavior.

func ApprovalWeights added in v0.5.7 

func ApprovalWeights(weightProvider WeightProvider) Option

ApprovalWeights is an Option for the Tangle that allows to define how the approval weights of Messages is determined.

func CacheTimeProvider added in v0.7.3 

func CacheTimeProvider(cacheTimeProvider *database.CacheTimeProvider) Option

CacheTimeProvider is an Option for the Tangle that allows to override hard coded cache time.

func GenesisNode added in v0.5.2 

func GenesisNode(genesisNodeBase58 string) Option

GenesisNode is an Option for the Tangle that allows to set the GenesisNode, i.e., the node that is allowed to attach to the Genesis Message.

func Identity added in v0.3.6 

func Identity(identity *identity.LocalIdentity) Option

Identity is an Option for the Tangle that allows to specify the node identity which is used to issue Messages.

func IncreaseMarkersIndexCallback added in v0.4.0 

func IncreaseMarkersIndexCallback(callback markers.IncreaseIndexCallback) Option

IncreaseMarkersIndexCallback is an Option for the Tangle that allows to change the strategy how new Markers are assigned in the Tangle.

func RateSetterConfig added in v0.6.2 

func RateSetterConfig(params RateSetterParams) Option

RateSetterConfig is an Option for the Tangle that allows to set the rate setter.

func SchedulerConfig added in v0.6.2 

func SchedulerConfig(config SchedulerParams) Option

SchedulerConfig is an Option for the Tangle that allows to set the scheduler.

func StartSynced added in v0.5.9 

func StartSynced(startSynced bool) Option

StartSynced is an Option for the Tangle that allows to define if the node starts as synced.

func Store added in v0.3.6 

func Store(store kvstore.KVStore) Option

Store is an Option for the Tangle that allows to specify which storage layer is supposed to be used to persist data.

func SyncTimeWindow added in v0.5.8 

func SyncTimeWindow(syncTimeWindow time.Duration) Option

SyncTimeWindow is an Option for the Tangle that allows to define the time window in which the node will consider itself in sync.

func TimeSinceConfirmationThreshold added in v0.8.10 

func TimeSinceConfirmationThreshold(tscThreshold time.Duration) Option

TimeSinceConfirmationThreshold is an Option for the Tangle that allows to set threshold for Time Since Confirmation check.

func Width added in v0.5.2 

func Width(width int) Option

Width is an Option for the Tangle that allows to change the strategy how Tips get removed.

func WithConflictDAGOptions added in v0.9.0 

func WithConflictDAGOptions(branchDAGOptions ...conflictdag.Option) Option

WithConflictDAGOptions is an Option for the Tangle that allows to set the ConflictDAG options.

type Options 

type Options struct {
	Store                          kvstore.KVStore
	ConflictDAGOptions             []conflictdag.Option
	Identity                       *identity.LocalIdentity
	IncreaseMarkersIndexCallback   markers.IncreaseIndexCallback
	TangleWidth                    int
	GenesisNode                    *ed25519.PublicKey
	SchedulerParams                SchedulerParams
	RateSetterParams               RateSetterParams
	WeightProvider                 WeightProvider
	SyncTimeWindow                 time.Duration
	TimeSinceConfirmationThreshold time.Duration
	StartSynced                    bool
	CacheTimeProvider              *database.CacheTimeProvider
}

Options is a container for all configurable parameters of the Tangle.

type OrphanageManager added in v0.9.0 

type OrphanageManager struct {
	Events *OrphanageManagerEvents

	sync.Mutex
	// contains filtered or unexported fields
}

OrphanageManager is a manager that tracks orphaned messages.

func NewOrphanageManager added in v0.9.0 

func NewOrphanageManager(tangle *Tangle) *OrphanageManager

NewOrphanageManager returns a new OrphanageManager.

func (*OrphanageManager) OrphanBlock added in v0.9.0 

func (o *OrphanageManager) OrphanBlock(blockID MessageID, reason error)

func (*OrphanageManager) Setup added in v0.9.0 

func (o *OrphanageManager) Setup()

type OrphanageManagerEvents added in v0.9.0 

type OrphanageManagerEvents struct {
	BlockOrphaned       *event.Event[*BlockOrphanedEvent]
	AllChildrenOrphaned *event.Event[*Message]
}

type Parent added in v0.3.1 

type Parent struct {
	ID   MessageID
	Type ParentsType
}

Parent is a parent that can be either strong or weak.

type ParentMessageIDs added in v0.8.6 

type ParentMessageIDs map[ParentsType]MessageIDs

ParentMessageIDs is a map of ParentType to MessageIDs.

func NewParentMessageIDs added in v0.8.6 

func NewParentMessageIDs() ParentMessageIDs

NewParentMessageIDs constructs a new ParentMessageIDs.

func (ParentMessageIDs) Add added in v0.8.6 

func (p ParentMessageIDs) Add(parentType ParentsType, messageID MessageID) ParentMessageIDs

Add adds a parent to the map.

func (ParentMessageIDs) AddAll added in v0.8.6 

func (p ParentMessageIDs) AddAll(parentType ParentsType, messageIDs MessageIDs) ParentMessageIDs

AddAll adds a collection of parents to the map.

func (ParentMessageIDs) AddStrong added in v0.8.6 

func (p ParentMessageIDs) AddStrong(messageID MessageID) ParentMessageIDs

AddStrong adds a strong parent to the map.

func (ParentMessageIDs) Clone added in v0.8.6 

func (p ParentMessageIDs) Clone() ParentMessageIDs

Clone returns a copy of map.

func (ParentMessageIDs) IsEmpty added in v0.9.0 

func (p ParentMessageIDs) IsEmpty() bool

IsEmpty returns true if the ParentMessageIDs are empty.

type ParentsType added in v0.8.0 

type ParentsType uint8

ParentsType is a type that defines the type of the parent. 

const (
	// UndefinedParentType is the undefined parent.
	UndefinedParentType ParentsType = iota
	// StrongParentType is the ParentsType for a strong parent.
	StrongParentType
	// WeakParentType is the ParentsType for a weak parent.
	WeakParentType
	// ShallowLikeParentType is the ParentsType for the shallow like parent.
	ShallowLikeParentType
)

func (ParentsType) String added in v0.8.0 

func (bp ParentsType) String() string

String returns string representation of ParentsType.

type Parser added in v0.3.6 

type Parser struct {
	Events *ParserEvents
	// contains filtered or unexported fields
}

Parser parses messages and bytes and emits corresponding events for parsed and rejected messages.

func NewParser added in v0.3.6 

func NewParser() (result *Parser)

NewParser creates a new Message parser.

func (*Parser) AddBytesFilter added in v0.3.6 

func (p *Parser) AddBytesFilter(filter BytesFilter)

AddBytesFilter adds the given bytes filter to the parser.

func (*Parser) AddMessageFilter added in v0.3.6 

func (p *Parser) AddMessageFilter(filter MessageFilter)

AddMessageFilter adds a new message filter to the parser.

func (*Parser) Parse added in v0.3.6 

func (p *Parser) Parse(messageBytes []byte, peer *peer.Peer)

Parse parses the given message bytes.

func (*Parser) Setup added in v0.3.6 

func (p *Parser) Setup()

Setup defines the flow of the parser.

func (*Parser) Shutdown added in v0.7.6 

func (p *Parser) Shutdown()

Shutdown closes all the message filters.

type ParserEvents added in v0.3.6 

type ParserEvents struct {
	// Fired when a message was parsed.
	MessageParsed *event.Event[*MessageParsedEvent]

	// Fired when submitted bytes are rejected by a filter.
	BytesRejected *event.Event[*BytesRejectedEvent]

	// Fired when a message got rejected by a filter.
	MessageRejected *event.Event[*MessageRejectedEvent]
}

ParserEvents represents events happening in the Parser.

type PowFilter 

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

PowFilter is a message bytes filter validating the PoW nonce.

func NewPowFilter 

func NewPowFilter(worker *pow.Worker, difficulty int) *PowFilter

NewPowFilter creates a new PoW bytes filter.

func (*PowFilter) Filter 

func (f *PowFilter) Filter(msgBytes []byte, p *peer.Peer)

Filter checks whether the given bytes pass the PoW validation and calls the corresponding callback.

func (*PowFilter) OnAccept 

func (f *PowFilter) OnAccept(callback func([]byte, *peer.Peer))

OnAccept registers the given callback as the acceptance function of the filter.

func (*PowFilter) OnReject 

func (f *PowFilter) OnReject(callback func([]byte, error, *peer.Peer))

OnReject registers the given callback as the rejection function of the filter.

type PrePostStepTuple added in v0.8.0 

type PrePostStepTuple struct {
	Pre  TestStep
	Post TestStep
}

PrePostStepTuple is a tuple of TestStep(s) called before and after the actual test step is called.

type QueueElement added in v0.9.1 

type QueueElement struct {
	// Value represents the value of the queued element.
	Value MessageID

	// Key represents the time of the element to be used as a key.
	Key time.Time
	// contains filtered or unexported fields
}

QueueElement is an element in the TimedQueue. It

type RateSetter added in v0.6.2 

type RateSetter struct {
	Events *RateSetterEvents
	// contains filtered or unexported fields
}

RateSetter is a Tangle component that takes care of congestion control of local node.

func NewRateSetter added in v0.6.2 

func NewRateSetter(tangle *Tangle) *RateSetter

NewRateSetter returns a new RateSetter.

func (*RateSetter) Estimate added in v0.9.1 

func (r *RateSetter) Estimate() time.Duration

Estimate estimates the issuing time of new message.

func (*RateSetter) Issue added in v0.6.2 

func (r *RateSetter) Issue(message *Message) error

Issue submits a message to the local issuing queue.

func (*RateSetter) Rate added in v0.6.2 

func (r *RateSetter) Rate() float64

Rate returns the rate of the rate setter.

func (*RateSetter) Setup added in v0.6.2 

func (r *RateSetter) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of the other components.

func (*RateSetter) Shutdown added in v0.6.2 

func (r *RateSetter) Shutdown()

Shutdown shuts down the RateSetter.

func (*RateSetter) Size added in v0.6.2 

func (r *RateSetter) Size() int

Size returns the size of the issuing queue.

type RateSetterEvents added in v0.6.2 

type RateSetterEvents struct {
	MessageDiscarded *event.Event[*MessageDiscardedEvent]
	MessageIssued    *event.Event[*MessageConstructedEvent]
	Error            *event.Event[error]
}

RateSetterEvents represents events happening in the rate setter.

type RateSetterParams added in v0.6.2 

type RateSetterParams struct {
	Enabled          bool
	Initial          float64
	RateSettingPause time.Duration
}

RateSetterParams represents the parameters for RateSetter.

type RecentlySeenBytesFilter 

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

RecentlySeenBytesFilter filters so that bytes which were recently seen don't pass the filter.

func NewRecentlySeenBytesFilter 

func NewRecentlySeenBytesFilter() *RecentlySeenBytesFilter

NewRecentlySeenBytesFilter creates a new recently seen bytes filter.

func (*RecentlySeenBytesFilter) Filter 

func (r *RecentlySeenBytesFilter) Filter(bytes []byte, peer *peer.Peer)

Filter filters up on the given bytes and peer and calls the acceptance callback if the input passes or the rejection callback if the input is rejected.

func (*RecentlySeenBytesFilter) OnAccept 

func (r *RecentlySeenBytesFilter) OnAccept(callback func(bytes []byte, peer *peer.Peer))

OnAccept registers the given callback as the acceptance function of the filter.

func (*RecentlySeenBytesFilter) OnReject 

func (r *RecentlySeenBytesFilter) OnReject(callback func(bytes []byte, err error, peer *peer.Peer))

OnReject registers the given callback as the rejection function of the filter.

type ReferenceProvider added in v0.9.0 

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

ReferenceProvider is a component that takes care of creating the correct references when selecting tips.

func NewReferenceProvider added in v0.9.0 

func NewReferenceProvider(tangle *Tangle) (newInstance *ReferenceProvider)

NewReferenceProvider creates a new ReferenceProvider instance.

func (*ReferenceProvider) References added in v0.9.0 

func (r *ReferenceProvider) References(payload payload.Payload, strongParents MessageIDs, issuingTime time.Time) (references ParentMessageIDs, err error)

References is an implementation of ReferencesFunc.

func (*ReferenceProvider) ReferencesToMissingConflicts added in v0.9.0 

func (r *ReferenceProvider) ReferencesToMissingConflicts(issuingTime time.Time, amount int) (blockIDs MessageIDs)

type ReferencesFunc added in v0.8.6 

type ReferencesFunc func(payload payload.Payload, strongParents MessageIDs, issuingTime time.Time) (references ParentMessageIDs, err error)

ReferencesFunc is a function type that returns like references a given set of parents of a Message.

type RequestFailedEvent added in v0.9.0 

type RequestFailedEvent struct {
	MessageID MessageID
}

type RequestIssuedEvent added in v0.9.0 

type RequestIssuedEvent struct {
	MessageID MessageID
}

type RequestStartedEvent added in v0.9.0 

type RequestStartedEvent struct {
	MessageID MessageID
}

type RequestStoppedEvent added in v0.9.0 

type RequestStoppedEvent struct {
	MessageID MessageID
}

type Requester added in v0.3.6 

type Requester struct {
	Events *RequesterEvents
	// contains filtered or unexported fields
}

Requester takes care of requesting messages.

func NewRequester added in v0.3.6 

func NewRequester(tangle *Tangle, optionalOptions ...RequesterOption) *Requester

NewRequester creates a new message requester.

func (*Requester) RequestQueueSize added in v0.3.6 

func (r *Requester) RequestQueueSize() int

RequestQueueSize returns the number of scheduled message requests.

func (*Requester) Setup added in v0.3.6 

func (r *Requester) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*Requester) Shutdown added in v0.8.1 

func (r *Requester) Shutdown()

Shutdown shuts down the Requester.

func (*Requester) StartRequest added in v0.3.6 

func (r *Requester) StartRequest(id MessageID)

StartRequest initiates a regular triggering of the StartRequest event until it has been stopped using StopRequest.

func (*Requester) StopRequest added in v0.3.6 

func (r *Requester) StopRequest(id MessageID)

StopRequest stops requests for the given message to further happen.

type RequesterEvents added in v0.8.1 

type RequesterEvents struct {
	// RequestIssued is an event that is triggered when the requester wants to request the given Message from its
	// neighbors.
	RequestIssued *event.Event[*RequestIssuedEvent]

	// RequestStarted is an event that is triggered when a new request is started.
	RequestStarted *event.Event[*RequestStartedEvent]

	// RequestStopped is an event that is triggered when a request is stopped.
	RequestStopped *event.Event[*RequestStoppedEvent]

	// RequestFailed is an event that is triggered when a request is stopped after too many attempts.
	RequestFailed *event.Event[*RequestFailedEvent]
}

RequesterEvents represents events happening on a message requester.

type RequesterOption added in v0.3.6 

type RequesterOption func(*RequesterOptions)

RequesterOption is a function which inits an option.

func MaxRequestThreshold added in v0.8.1 

func MaxRequestThreshold(maxRequestThreshold int) RequesterOption

MaxRequestThreshold creates an option which defines how often the Requester should try to request messages before canceling the request.

func RetryInterval 

func RetryInterval(interval time.Duration) RequesterOption

RetryInterval creates an option which sets the retry interval to the given value.

func RetryJitter added in v0.8.1 

func RetryJitter(retryJitter time.Duration) RequesterOption

RetryJitter creates an option which sets the retry jitter to the given value.

type RequesterOptions added in v0.3.6 

type RequesterOptions struct {
	// RetryInterval represents an option which defines in which intervals the Requester will try to ask for missing
	// messages.
	RetryInterval time.Duration

	// RetryJitter defines how much the RetryInterval should be randomized, so that the nodes don't always send messages
	// at exactly the same interval.
	RetryJitter time.Duration

	// MaxRequestThreshold represents an option which defines how often the Requester should try to request messages
	// before canceling the request
	MaxRequestThreshold int
}

RequesterOptions holds options for a message requester.

func (RequesterOptions) Apply added in v0.8.1 

func (r RequesterOptions) Apply(optionalOptions ...RequesterOption) (updatedOptions RequesterOptions)

Apply applies the optional Options to the RequesterOptions.

type Scheduler added in v0.3.6 

type Scheduler struct {
	Events *SchedulerEvents
	// contains filtered or unexported fields
}

Scheduler is a Tangle component that takes care of scheduling the messages that shall be booked.

func NewScheduler added in v0.3.6 

func NewScheduler(tangle *Tangle) *Scheduler

NewScheduler returns a new Scheduler.

func (*Scheduler) AccessManaCache added in v0.8.4 

func (s *Scheduler) AccessManaCache() *schedulerutils.AccessManaCache

AccessManaCache returns the object which caches access mana values.

func (*Scheduler) BufferSize added in v0.8.4 

func (s *Scheduler) BufferSize() int

BufferSize returns the size of the buffer.

func (*Scheduler) Clear added in v0.6.2 

func (s *Scheduler) Clear()

Clear removes all submitted messages (ready or not) from the scheduler. The MessageDiscarded event is triggered for each of these messages.

func (*Scheduler) GetDeficit added in v0.9.1 

func (s *Scheduler) GetDeficit(nodeID identity.ID) *big.Rat

func (*Scheduler) GetManaFromCache added in v0.8.4 

func (s *Scheduler) GetManaFromCache(nodeID identity.ID) int64

GetManaFromCache allows you to get the cached mana for a node ID. This is exposed for analytics purposes.

func (*Scheduler) MaxBufferSize added in v0.8.4 

func (s *Scheduler) MaxBufferSize() int

MaxBufferSize returns the max size of the buffer.

func (*Scheduler) NodeQueueSize added in v0.6.2 

func (s *Scheduler) NodeQueueSize(nodeID identity.ID) int

NodeQueueSize returns the size of the nodeIDs queue.

func (*Scheduler) NodeQueueSizes added in v0.6.2 

func (s *Scheduler) NodeQueueSizes() map[identity.ID]int

NodeQueueSizes returns the size for each node queue.

func (*Scheduler) Quanta added in v0.9.1 

func (s *Scheduler) Quanta(nodeID identity.ID) *big.Rat

func (*Scheduler) Rate added in v0.6.2 

func (s *Scheduler) Rate() time.Duration

Rate gets the rate of the scheduler.

func (*Scheduler) Ready added in v0.6.2 

func (s *Scheduler) Ready(messageID MessageID) (err error)

Ready marks a previously submitted message as ready to be scheduled. If Ready is called without a previous Submit, it has no effect.

func (*Scheduler) ReadyMessagesCount added in v0.8.4 

func (s *Scheduler) ReadyMessagesCount() int

ReadyMessagesCount returns the size buffer.

func (*Scheduler) Running added in v0.6.2 

func (s *Scheduler) Running() bool

Running returns true if the scheduler has started.

func (*Scheduler) SetRate added in v0.6.2 

func (s *Scheduler) SetRate(rate time.Duration)

SetRate sets the rate of the scheduler.

func (*Scheduler) Setup added in v0.3.6 

func (s *Scheduler) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of the other components.

func (*Scheduler) Shutdown added in v0.3.6 

func (s *Scheduler) Shutdown()

Shutdown shuts down the Scheduler. Shutdown blocks until the scheduler has been shutdown successfully.

func (*Scheduler) Start added in v0.6.2 

func (s *Scheduler) Start()

Start starts the scheduler.

func (*Scheduler) Submit added in v0.6.2 

func (s *Scheduler) Submit(messageID MessageID) (err error)

Submit submits a message to be considered by the scheduler. This transactions will be included in all the control metrics, but it will never be scheduled until Ready(messageID) has been called.

func (*Scheduler) SubmitAndReady added in v0.6.2 

func (s *Scheduler) SubmitAndReady(message *Message) (err error)

SubmitAndReady submits the message to the scheduler and marks it ready right away.

func (*Scheduler) TotalMessagesCount added in v0.8.4 

func (s *Scheduler) TotalMessagesCount() int

TotalMessagesCount returns the size buffer.

func (*Scheduler) Unsubmit added in v0.6.2 

func (s *Scheduler) Unsubmit(messageID MessageID) (err error)

Unsubmit removes a message from the submitted messages. If that message is already marked as ready, Unsubmit has no effect.

type SchedulerEvents added in v0.3.6 

type SchedulerEvents struct {
	// MessageScheduled is triggered when a message is ready to be scheduled.
	MessageScheduled *event.Event[*MessageScheduledEvent]
	// MessageDiscarded is triggered when a message is removed from the longest mana-scaled queue when the buffer is full.
	MessageDiscarded *event.Event[*MessageDiscardedEvent]
	// MessageSkipped is triggered when a message is confirmed before it's scheduled, and is skipped by the scheduler.
	MessageSkipped  *event.Event[*MessageSkippedEvent]
	NodeBlacklisted *event.Event[*NodeBlacklistedEvent]
	Error           *event.Event[error]
}

SchedulerEvents represents events happening in the Scheduler.

func NewSchedulerEvents added in v0.9.0 

func NewSchedulerEvents() (new *SchedulerEvents)

type SchedulerParams added in v0.6.2 

type SchedulerParams struct {
	MaxBufferSize                     int
	TotalSupply                       int
	Rate                              time.Duration
	TotalAccessManaRetrieveFunc       func() float64
	AccessManaMapRetrieverFunc        func() map[identity.ID]float64
	ConfirmedMessageScheduleThreshold time.Duration
}

SchedulerParams defines the scheduler config parameters.

type SimpleMockOnTangleVoting added in v0.8.0 

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

SimpleMockOnTangleVoting is mock of OTV mechanism.

func (*SimpleMockOnTangleVoting) BranchLiked added in v0.8.6 

func (o *SimpleMockOnTangleVoting) BranchLiked(branchID utxo.TransactionID) (branchLiked bool)

BranchLiked returns whether the branch is the winner across all conflict sets (it is in the liked reality).

func (*SimpleMockOnTangleVoting) LikedConflictMember added in v0.8.6 

func (o *SimpleMockOnTangleVoting) LikedConflictMember(branchID utxo.TransactionID) (likedBranchID utxo.TransactionID, conflictMembers utxo.TransactionIDs)

LikedConflictMember returns branches that are liked instead of a disliked branch as predefined.

type Solidifier added in v0.3.6 

type Solidifier struct {
	// Events contains the Solidifier related events.
	Events *SolidifierEvents
	// contains filtered or unexported fields
}

Solidifier is the Tangle's component that solidifies messages.

func NewSolidifier added in v0.3.6 

func NewSolidifier(tangle *Tangle) (solidifier *Solidifier)

NewSolidifier is the constructor of the Solidifier.

func (*Solidifier) RetrieveMissingMessage added in v0.8.1 

func (s *Solidifier) RetrieveMissingMessage(messageID MessageID) (messageWasMissing bool)

RetrieveMissingMessage checks if the message is missing and triggers the corresponding events to request it. It returns true if the message has been missing.

func (*Solidifier) Setup added in v0.3.6 

func (s *Solidifier) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of the other components.

func (*Solidifier) Solidify added in v0.3.6 

func (s *Solidifier) Solidify(messageID MessageID)

Solidify solidifies the given Message.

type SolidifierEvents added in v0.3.6 

type SolidifierEvents struct {
	// MessageSolid is triggered when a message becomes solid, i.e. its past cone is known and solid.
	MessageSolid *event.Event[*MessageSolidEvent]

	// MessageMissing is triggered when a message references an unknown parent Message.
	MessageMissing *event.Event[*MessageMissingEvent]
}

SolidifierEvents represents events happening in the Solidifier.

type Storage added in v0.3.6 

type Storage struct {
	Events *StorageEvents
	// contains filtered or unexported fields
}

Storage represents the storage of messages.

func NewStorage added in v0.3.6 

func NewStorage(tangle *Tangle) (storage *Storage)

NewStorage creates a new Storage.

func (*Storage) AllLatestMarkerVotes added in v0.8.6 

func (s *Storage) AllLatestMarkerVotes(sequenceID markers.SequenceID) (cachedLatestMarkerVotesByVoter CachedLatestMarkerVotesByVoter)

AllLatestMarkerVotes retrieves all LatestMarkerVotes for the named Sequence.

func (*Storage) Approvers added in v0.3.6 

func (s *Storage) Approvers(messageID MessageID, optionalApproverType ...ApproverType) (cachedApprovers objectstorage.CachedObjects[*Approver])

Approvers retrieves the Approvers of a Message from the object storage. It is possible to provide an optional ApproverType to only return the corresponding Approvers.

func (*Storage) AttachmentMessageIDs added in v0.3.6 

func (s *Storage) AttachmentMessageIDs(transactionID utxo.TransactionID) (messageIDs MessageIDs)

AttachmentMessageIDs returns the messageIDs of the transaction in attachmentStorage.

func (*Storage) Attachments added in v0.3.6 

func (s *Storage) Attachments(transactionID utxo.TransactionID) (cachedAttachments objectstorage.CachedObjects[*Attachment])

Attachments retrieves the attachment of a transaction in attachmentStorage.

func (*Storage) BranchVoters added in v0.8.6 

func (s *Storage) BranchVoters(branchID utxo.TransactionID, computeIfAbsentCallback ...func(branchID utxo.TransactionID) *BranchVoters) *objectstorage.CachedObject[*BranchVoters]

BranchVoters retrieves the BranchVoters with the given ledger.BranchID.

func (*Storage) BranchWeight added in v0.5.7 

func (s *Storage) BranchWeight(branchID utxo.TransactionID, computeIfAbsentCallback ...func(branchID utxo.TransactionID) *BranchWeight) *objectstorage.CachedObject[*BranchWeight]

BranchWeight retrieves the BranchWeight with the given BranchID.

func (*Storage) DBStats added in v0.3.6 

func (s *Storage) DBStats() (res DBStatsResult)

DBStats returns the number of solid messages and total number of messages in the database (messageMetadataStorage, that should contain the messages as messageStorage), the number of messages in missingMessageStorage, furthermore the average time it takes to solidify messages.

func (*Storage) DeleteMarkerMessageMapping added in v0.5.7 

func (s *Storage) DeleteMarkerMessageMapping(branchID utxo.TransactionID, messageID MessageID)

DeleteMarkerMessageMapping deleted a MarkerMessageMapping in the underlying object storage.

func (*Storage) DeleteMessage added in v0.3.6 

func (s *Storage) DeleteMessage(messageID MessageID)

DeleteMessage deletes a message and its association to approvees by un-marking the given message as an approver.

func (*Storage) DeleteMissingMessage added in v0.3.6 

func (s *Storage) DeleteMissingMessage(messageID MessageID)

DeleteMissingMessage deletes a message from the missingMessageStorage.

func (*Storage) IsTransactionAttachedByMessage added in v0.4.0 

func (s *Storage) IsTransactionAttachedByMessage(transactionID utxo.TransactionID, messageID MessageID) (attached bool)

IsTransactionAttachedByMessage checks whether Transaction with transactionID is attached by Message with messageID.

func (*Storage) LatestBranchVotes added in v0.8.6 

func (s *Storage) LatestBranchVotes(voter Voter, computeIfAbsentCallback ...func(voter Voter) *LatestBranchVotes) *objectstorage.CachedObject[*LatestBranchVotes]

LatestBranchVotes retrieves the LatestBranchVotes of the given Voter.

func (*Storage) LatestMarkerVotes added in v0.8.6 

func (s *Storage) LatestMarkerVotes(sequenceID markers.SequenceID, voter Voter, computeIfAbsentCallback ...func(sequenceID markers.SequenceID, voter Voter) *LatestMarkerVotes) *objectstorage.CachedObject[*LatestMarkerVotes]

LatestMarkerVotes retrieves the LatestMarkerVotes of the given voter for the named Sequence.

func (*Storage) MarkerIndexBranchIDMapping added in v0.3.6 

func (s *Storage) MarkerIndexBranchIDMapping(sequenceID markers.SequenceID, computeIfAbsentCallback ...func(sequenceID markers.SequenceID) *MarkerIndexBranchIDMapping) *objectstorage.CachedObject[*MarkerIndexBranchIDMapping]

MarkerIndexBranchIDMapping retrieves the MarkerIndexBranchIDMapping for the given SequenceID. It accepts an optional computeIfAbsent callback that can be used to dynamically create a MarkerIndexBranchIDMapping if it doesn't exist, yet.

func (*Storage) MarkerMessageMapping added in v0.5.7 

func (s *Storage) MarkerMessageMapping(marker markers.Marker) (cachedMarkerMessageMappings *objectstorage.CachedObject[*MarkerMessageMapping])

MarkerMessageMapping retrieves the MarkerMessageMapping associated with the given details.

func (*Storage) MarkerMessageMappings added in v0.5.7 

func (s *Storage) MarkerMessageMappings(sequenceID markers.SequenceID) (cachedMarkerMessageMappings objectstorage.CachedObjects[*MarkerMessageMapping])

MarkerMessageMappings retrieves the MarkerMessageMappings of a Sequence in the object storage.

func (*Storage) Message added in v0.3.6 

func (s *Storage) Message(messageID MessageID) *objectstorage.CachedObject[*Message]

Message retrieves a message from the message store.

func (*Storage) MessageMetadata added in v0.3.6 

func (s *Storage) MessageMetadata(messageID MessageID, computeIfAbsentCallback ...func() *MessageMetadata) *objectstorage.CachedObject[*MessageMetadata]

MessageMetadata retrieves the MessageMetadata with the given MessageID.

func (*Storage) MissingMessages added in v0.3.6 

func (s *Storage) MissingMessages() (ids []MessageID)

MissingMessages return the ids of messages in missingMessageStorage

func (*Storage) Prune added in v0.3.6 

func (s *Storage) Prune() error

Prune resets the database and deletes all objects (good for testing or "node resets").

func (*Storage) RetrieveAllTips added in v0.3.6 

func (s *Storage) RetrieveAllTips() (tips []MessageID)

RetrieveAllTips returns the tips (i.e., solid messages that are not part of the approvers list). It iterates over the messageMetadataStorage, thus only use this method if necessary. TODO: improve this function.

func (*Storage) Setup added in v0.3.6 

func (s *Storage) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*Storage) Shutdown added in v0.3.6 

func (s *Storage) Shutdown()

Shutdown marks the tangle as stopped, so it will not accept any new messages (waits for all backgroundTasks to finish).

func (*Storage) StoreAttachment added in v0.3.6 

func (s *Storage) StoreAttachment(transactionID utxo.TransactionID, messageID MessageID) (cachedAttachment *objectstorage.CachedObject[*Attachment], stored bool)

StoreAttachment stores a new attachment if not already stored.

func (*Storage) StoreMarkerMessageMapping added in v0.5.7 

func (s *Storage) StoreMarkerMessageMapping(markerMessageMapping *MarkerMessageMapping)

StoreMarkerMessageMapping stores a MarkerMessageMapping in the underlying object storage.

func (*Storage) StoreMessage added in v0.3.6 

func (s *Storage) StoreMessage(message *Message)

StoreMessage stores a new message to the message store.

func (*Storage) StoreMissingMessage added in v0.3.6 

func (s *Storage) StoreMissingMessage(missingMessage *MissingMessage) (cachedMissingMessage *objectstorage.CachedObject[*MissingMessage], stored bool)

StoreMissingMessage stores a new MissingMessage entry in the object storage.

type StorageEvents added in v0.3.6 

type StorageEvents struct {
	// Fired when a message has been stored.
	MessageStored *event.Event[*MessageStoredEvent]

	// Fired when a message was removed from storage.
	MessageRemoved *event.Event[*MessageRemovedEvent]

	// Fired when a message which was previously marked as missing was received.
	MissingMessageStored *event.Event[*MissingMessageStoredEvent]
}

StorageEvents represents events happening on the message store.

type SyncChangedEvent added in v0.6.0 

type SyncChangedEvent struct {
	Synced bool
}

SyncChangedEvent represents a sync changed event.

type Tangle 

type Tangle struct {
	Options               *Options
	Parser                *Parser
	Storage               *Storage
	Solidifier            *Solidifier
	Scheduler             *Scheduler
	RateSetter            *RateSetter
	Booker                *Booker
	ApprovalWeightManager *ApprovalWeightManager
	TimeManager           *TimeManager
	OTVConsensusManager   *OTVConsensusManager
	TipManager            *TipManager
	Requester             *Requester
	MessageFactory        *MessageFactory
	Ledger                *ledger.Ledger
	Utils                 *Utils
	WeightProvider        WeightProvider
	Events                *Events
	ConfirmationOracle    ConfirmationOracle
	OrphanageManager      *OrphanageManager
	// contains filtered or unexported fields
}

Tangle is the central data structure of the IOTA protocol.

func New 

func New(options ...Option) (tangle *Tangle)

New is the constructor for the Tangle.

func NewTestTangle added in v0.8.0 

func NewTestTangle(options ...Option) *Tangle

NewTestTangle returns a Tangle instance with a testing schedulerConfig.

func (*Tangle) Bootstrapped added in v0.9.1 

func (t *Tangle) Bootstrapped() bool

Bootstrapped returns a boolean value that indicates if the node has bootstrapped and the Tangle has solidified all messages until the genesis.

func (*Tangle) Configure added in v0.5.0 

func (t *Tangle) Configure(options ...Option)

Configure modifies the configuration of the Tangle.

func (*Tangle) IssuePayload added in v0.5.0 

func (t *Tangle) IssuePayload(p payload.Payload, parentsCount ...int) (message *Message, err error)

IssuePayload allows to attach a payload (i.e. a Transaction) to the Tangle.

func (*Tangle) ProcessGossipMessage added in v0.3.6 

func (t *Tangle) ProcessGossipMessage(messageBytes []byte, peer *peer.Peer)

ProcessGossipMessage is used to feed new Messages from the gossip layer into the Tangle.

func (*Tangle) Prune 

func (t *Tangle) Prune() (err error)

Prune resets the database and deletes all stored objects (good for testing or "node resets").

func (*Tangle) Setup added in v0.3.6 

func (t *Tangle) Setup()

Setup sets up the data flow by connecting the different components (by calling their corresponding Setup method).

func (*Tangle) Shutdown 

func (t *Tangle) Shutdown()

Shutdown marks the tangle as stopped, so it will not accept any new messages (waits for all backgroundTasks to finish).

func (*Tangle) Synced added in v0.5.0 

func (t *Tangle) Synced() bool

Synced returns a boolean value that indicates if the node is in sync at this moment.

type TestScenario added in v0.8.0 

type TestScenario struct {
	Steps    []TestStep
	PostStep TestStep
	Tangle   *Tangle
	// contains filtered or unexported fields
}

TestScenario is a sequence of steps applied onto test scenario.

func ProcessMessageScenario added in v0.8.0 

func ProcessMessageScenario(t *testing.T, options ...Option) *TestScenario

ProcessMessageScenario the approval weight and voter adjustments.

func ProcessMessageScenario2 added in v0.8.6 

func ProcessMessageScenario2(t *testing.T, options ...Option) *TestScenario

ProcessMessageScenario2 creates a scenario useful to validate strong / weak propagation paths.

func (*TestScenario) Cleanup added in v0.8.0 

func (s *TestScenario) Cleanup(t *testing.T) error

Cleanup cleans up the scenario.

func (*TestScenario) HasNext added in v0.8.0 

func (s *TestScenario) HasNext() bool

HasNext returns whether the scenario has a next step.

func (*TestScenario) Next added in v0.8.0 

func (s *TestScenario) Next(prePostStepTuple *PrePostStepTuple)

Next returns the next step or panics if non is available.

func (*TestScenario) Setup added in v0.8.0 

func (s *TestScenario) Setup(t *testing.T) error

Setup sets up the scenario.

type TestStep added in v0.8.0 

type TestStep func(t *testing.T, testFramework *MessageTestFramework, testEventMock *EventMock, nodes NodeIdentities)

TestStep defines a test scenario step.

type TimeManager added in v0.5.8 

type TimeManager struct {
	Events *TimeManagerEvents
	// contains filtered or unexported fields
}

TimeManager is a Tangle component that keeps track of the TangleTime. The TangleTime can be seen as a clock for the entire network as it tracks the time of the last confirmed message. Comparing the issuing time of the last confirmed message to the node's current wall clock time then yields a reasonable assessment of how much in sync the node is.

func NewTimeManager added in v0.5.8 

func NewTimeManager(tangle *Tangle) *TimeManager

NewTimeManager is the constructor for TimeManager.

func (*TimeManager) ATT added in v0.9.1 

func (t *TimeManager) ATT() time.Time

ATT returns the Acceptance Tangle Time, i.e., the issuing time of the last accepted message.

func (*TimeManager) Bootstrapped added in v0.9.1 

func (t *TimeManager) Bootstrapped() bool

Bootstrapped returns whether the node has bootstrapped based on the difference between CTT and the current wall time which can be configured via SyncTimeWindow. When the node becomes bootstrapped and this method returns true, it can't return false after that.

func (*TimeManager) CTT added in v0.9.1 

func (t *TimeManager) CTT() time.Time

CTT returns the confirmed tangle time, i.e. the issuing time of the last confirmed message. For now, it's just a stub, it actually returns ATT.

func (*TimeManager) LastAcceptedMessage added in v0.9.1 

func (t *TimeManager) LastAcceptedMessage() LastMessage

LastAcceptedMessage returns the last confirmed message.

func (*TimeManager) LastConfirmedMessage added in v0.5.8 

func (t *TimeManager) LastConfirmedMessage() LastMessage

LastConfirmedMessage returns the last confirmed message.

func (*TimeManager) RATT added in v0.9.1 

func (t *TimeManager) RATT() time.Time

RATT return relative acceptance tangle time, i.e., ATT + time since last update of ATT.

func (*TimeManager) RCTT added in v0.9.1 

func (t *TimeManager) RCTT() time.Time

RCTT return relative acceptance tangle time, i.e., CTT + time since last update of CTT. For now, it's just a stub, it actually returns RATT.

func (*TimeManager) Setup added in v0.5.8 

func (t *TimeManager) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*TimeManager) Shutdown added in v0.5.8 

func (t *TimeManager) Shutdown()

Shutdown shuts down the TimeManager and persists its state.

func (*TimeManager) Start added in v0.7.3 

func (t *TimeManager) Start()

Start starts the TimeManager.

func (*TimeManager) Synced added in v0.5.8 

func (t *TimeManager) Synced() bool

Synced returns whether the node is in sync based on the difference between CTT and the current wall time which can be configured via SyncTimeWindow.

type TimeManagerEvents added in v0.6.0 

type TimeManagerEvents struct {
	// Fired when the nodes sync status changes.
	SyncChanged           *event.Event[*SyncChangedEvent]
	AcceptanceTimeUpdated *event.Event[*TimeUpdate]
	ConfirmedTimeUpdated  *event.Event[*TimeUpdate]
}

TimeManagerEvents represents events happening in the TimeManager.

type TimeRetrieverFunc added in v0.5.8 

type TimeRetrieverFunc func() time.Time

TimeRetrieverFunc is a function type to retrieve the time.

type TimeUpdate added in v0.9.1 

type TimeUpdate struct {
	NewTime time.Time
}

TimeUpdate represents an update in Tangle Time.

type TimedHeap added in v0.9.1 

type TimedHeap []*QueueElement

TimedHeap defines a heap based on times.

func (TimedHeap) Len added in v0.9.1 

func (h TimedHeap) Len() int

Len is the number of elements in the collection.

func (TimedHeap) Less added in v0.9.1 

func (h TimedHeap) Less(i, j int) bool

Less reports whether the element with index i should sort before the element with index j.

func (*TimedHeap) Pop added in v0.9.1 

func (h *TimedHeap) Pop() interface{}

Pop removes and returns the last element of the heap.

func (*TimedHeap) Push added in v0.9.1 

func (h *TimedHeap) Push(x interface{})

Push adds x as the last element to the heap.

func (TimedHeap) Swap added in v0.9.1 

func (h TimedHeap) Swap(i, j int)

Swap swaps the elements with indexes i and j.

type TipEvent added in v0.4.0 

type TipEvent struct {
	// MessageID of the added/removed tip.
	MessageID MessageID
}

TipEvent holds the information provided by the TipEvent event that gets triggered when a message gets added or removed as tip.

type TipManager added in v0.3.6 

type TipManager struct {
	Events *TipManagerEvents
	// contains filtered or unexported fields
}

TipManager manages a map of tips and emits events for their removal and addition.

func NewTipManager added in v0.3.6 

func NewTipManager(tangle *Tangle, tips ...MessageID) *TipManager

NewTipManager creates a new tip-selector.

func (*TipManager) AddTip added in v0.3.6 

func (t *TipManager) AddTip(message *Message)

AddTip adds the message to the tip pool if its issuing time is within the tipLifeGracePeriod. Parents of a message that are currently tip lose the tip status and are removed.

func (*TipManager) AllTips added in v0.8.0 

func (t *TipManager) AllTips() MessageIDs

AllTips returns a list of all tips that are stored in the TipManger.

func (*TipManager) Setup added in v0.3.6 

func (t *TipManager) Setup()

Setup sets up the behavior of the component by making it attach to the relevant events of other components.

func (*TipManager) Shutdown added in v0.5.1 

func (t *TipManager) Shutdown()

Shutdown stops the TipManager.

func (*TipManager) TipCount added in v0.3.6 

func (t *TipManager) TipCount() int

TipCount the amount of strong tips.

func (*TipManager) Tips added in v0.3.6 

func (t *TipManager) Tips(p payload.Payload, countParents int) (parents MessageIDs)

Tips returns count number of tips, maximum MaxParentsCount.

type TipManagerEvents added in v0.3.6 

type TipManagerEvents struct {
	// Fired when a tip is added.
	TipAdded *event.Event[*TipEvent]

	// Fired when a tip is removed.
	TipRemoved *event.Event[*TipEvent]
}

TipManagerEvents represents events happening on the TipManager.

type TipSelector 

type TipSelector interface {
	Tips(p payload.Payload, countParents int) (parents MessageIDs)
}

A TipSelector selects two tips, parent2 and parent1, for a new message to attach to.

type TipSelectorFunc 

type TipSelectorFunc func(p payload.Payload, countParents int) (parents MessageIDs)

The TipSelectorFunc type is an adapter to allow the use of ordinary functions as tip selectors.

func (TipSelectorFunc) Tips 

func (f TipSelectorFunc) Tips(p payload.Payload, countParents int) (parents MessageIDs)

Tips calls f().

type TipsCleaner added in v0.9.1 

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

func (*TipsCleaner) Add added in v0.9.1 

func (t *TipsCleaner) Add(key time.Time, value MessageID)

Add adds a new element to the heap.

func (*TipsCleaner) RemoveBefore added in v0.9.1 

func (t *TipsCleaner) RemoveBefore(minAllowedTime time.Time)

RemoveBefore removes the elements with key time earlier than the given time.

type TipsConflictTracker added in v0.9.0 

type TipsConflictTracker struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewTipsConflictTracker added in v0.9.0 

func NewTipsConflictTracker(tangle *Tangle) *TipsConflictTracker

func (*TipsConflictTracker) AddTip added in v0.9.0 

func (c *TipsConflictTracker) AddTip(messageID MessageID)

func (*TipsConflictTracker) MissingConflicts added in v0.9.0 

func (c *TipsConflictTracker) MissingConflicts(amount int) (missingConflicts utxo.TransactionIDs)

func (*TipsConflictTracker) RemoveTip added in v0.9.0 

func (c *TipsConflictTracker) RemoveTip(messageID MessageID)

func (*TipsConflictTracker) Setup added in v0.9.0 

func (c *TipsConflictTracker) Setup()

type TransactionFilter added in v0.3.6 

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

TransactionFilter filters messages based on their timestamps and transaction timestamp.

func NewTransactionFilter added in v0.3.6 

func NewTransactionFilter() *TransactionFilter

NewTransactionFilter creates a new transaction filter.

func (*TransactionFilter) Close added in v0.7.6 

func (f *TransactionFilter) Close() error

Close closes the filter.

func (*TransactionFilter) Filter added in v0.3.6 

func (f *TransactionFilter) Filter(msg *Message, peer *peer.Peer)

Filter compares the timestamps between the message, and it's transaction payload and calls the corresponding callback.

func (*TransactionFilter) OnAccept added in v0.3.6 

func (f *TransactionFilter) OnAccept(callback func(msg *Message, peer *peer.Peer))

OnAccept registers the given callback as the acceptance function of the filter.

func (*TransactionFilter) OnReject added in v0.3.6 

func (f *TransactionFilter) OnReject(callback func(msg *Message, err error, peer *peer.Peer))

OnReject registers the given callback as the rejection function of the filter.

type Utils added in v0.3.6 

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

Utils is a Tangle component that bundles methods that can be used to interact with the Tangle, that do not belong into public API.

func NewUtils added in v0.3.6 

func NewUtils(tangle *Tangle) (utils *Utils)

NewUtils is the constructor of the Utils component.

func (*Utils) AllBranchesLiked added in v0.8.6 

func (u *Utils) AllBranchesLiked(branchIDs *set.AdvancedSet[utxo.TransactionID]) bool

AllBranchesLiked returns true if all the passed branches are liked.

func (*Utils) ApprovingMessageIDs added in v0.3.6 

func (u *Utils) ApprovingMessageIDs(messageID MessageID, optionalApproverType ...ApproverType) (approvingMessageIDs MessageIDs)

ApprovingMessageIDs returns the MessageIDs that approve a given Message. It accepts an optional ApproverType to filter the Approvers.

func (*Utils) ComputeIfTransaction added in v0.3.6 

func (u *Utils) ComputeIfTransaction(messageID MessageID, compute func(utxo.TransactionID)) (computed bool)

ComputeIfTransaction computes the given callback if the given messageID contains a transaction.

func (*Utils) ConfirmedConsumer added in v0.9.0 

func (u *Utils) ConfirmedConsumer(outputID utxo.OutputID) (consumerID utxo.TransactionID)

ConfirmedConsumer returns the confirmed transactionID consuming the given outputID.

func (*Utils) FirstAttachment added in v0.8.0 

func (u *Utils) FirstAttachment(transactionID utxo.TransactionID) (oldestAttachmentTime time.Time, oldestAttachmentMessageID MessageID, err error)

FirstAttachment returns the MessageID and timestamp of the first (oldest) attachment of a given transaction.

func (*Utils) WalkMessage added in v0.3.6 

func (u *Utils) WalkMessage(callback func(message *Message, walker *walker.Walker[MessageID]), entryPoints MessageIDs, revisitElements ...bool)

WalkMessage is a generic Tangle walker that executes a custom callback for every visited Message, starting from the given entry points. It accepts an optional boolean parameter which can be set to true if a Message should be visited more than once following different paths. The callback receives a Walker object as the last parameter which can be used to control the behavior of the walk similar to how a "Context" is used in some parts of the stdlib.

func (*Utils) WalkMessageAndMetadata added in v0.3.6 

func (u *Utils) WalkMessageAndMetadata(callback func(message *Message, messageMetadata *MessageMetadata, walker *walker.Walker[MessageID]), entryPoints MessageIDs, revisitElements ...bool)

WalkMessageAndMetadata is a generic Tangle walker that executes a custom callback for every visited Message and MessageMetadata, starting from the given entry points. It accepts an optional boolean parameter which can be set to true if a Message should be visited more than once following different paths. The callback receives a Walker object as the last parameter which can be used to control the behavior of the walk similar to how a "Context" is used in some parts of the stdlib.

func (*Utils) WalkMessageID added in v0.3.6 

func (u *Utils) WalkMessageID(callback func(messageID MessageID, walker *walker.Walker[MessageID]), entryPoints MessageIDs, revisitElements ...bool)

WalkMessageID is a generic Tangle walker that executes a custom callback for every visited MessageID, starting from the given entry points. It accepts an optional boolean parameter which can be set to true if a Message should be visited more than once following different paths. The callback receives a Walker object as the last parameter which can be used to control the behavior of the walk similar to how a "Context" is used in some parts of the stdlib.

func (*Utils) WalkMessageMetadata added in v0.3.6 

func (u *Utils) WalkMessageMetadata(callback func(messageMetadata *MessageMetadata, walker *walker.Walker[MessageID]), entryPoints MessageIDs, revisitElements ...bool)

WalkMessageMetadata is a generic Tangle walker that executes a custom callback for every visited MessageMetadata, starting from the given entry points. It accepts an optional boolean parameter which can be set to true if a Message should be visited more than once following different paths. The callback receives a Walker object as the last parameter which can be used to control the behavior of the walk similar to how a "Context" is used in some parts of the stdlib.

type VotePower added in v0.8.6 

type VotePower = uint64

VotePower is used to establish an absolute order of votes, regardless of their arrival order. Currently, the used VotePower is the SequenceNumber embedded in the Message Layout, so that, regardless of the order in which votes are received, the same conclusion is computed. Alternatively, the objective timestamp of a Message could be used.

type Voter added in v0.8.6 

type Voter = identity.ID

Voter is a type wrapper for identity.ID and defines a node that supports a branch or marker.

type Voters added in v0.8.6 

type Voters struct {
	set.Set[Voter]
}

Voters is a set of node identities that votes for a particular Branch.

func NewVoters added in v0.8.6 

func NewVoters() (voters *Voters)

NewVoters is the constructor of the Voters type.

func (*Voters) AddAll added in v0.8.6 

func (v *Voters) AddAll(voters *Voters)

AddAll adds all new Voters to the Set.

func (*Voters) Clone added in v0.8.6 

func (v *Voters) Clone() (clonedVoters *Voters)

Clone returns a copy of the Voters.

func (*Voters) Decode added in v0.8.13 

func (v *Voters) Decode(data []byte) (bytesRead int, err error)

Decode deserializes bytes into a valid object.

func (*Voters) Intersect added in v0.8.6 

func (v *Voters) Intersect(other *Voters) (intersection *Voters)

Intersect creates an intersection of two set of Voters.

func (*Voters) String added in v0.8.6 

func (v *Voters) String() string

String returns a human-readable version of the Voters.

type WeightProvider added in v0.5.7 

type WeightProvider interface {
	// Update updates the underlying data structure and keeps track of active nodes.
	Update(t time.Time, nodeID identity.ID)

	// Weight returns the weight and total weight for the given message.
	Weight(message *Message) (weight, totalWeight float64)

	// WeightsOfRelevantVoters returns all relevant weights.
	WeightsOfRelevantVoters() (weights map[identity.ID]float64, totalWeight float64)

	// Shutdown shuts down the WeightProvider and persists its state.
	Shutdown()
}

WeightProvider is an interface that allows the ApprovalWeightManager to determine approval weights of Messages in a flexible way, independently of a specific implementation.

type Worker 

type Worker interface {
	DoPOW([]byte) (nonce uint64, err error)
}

A Worker performs the PoW for the provided message in serialized byte form.

type WorkerFunc 

type WorkerFunc func([]byte) (uint64, error)

The WorkerFunc type is an adapter to allow the use of ordinary functions as a PoW performer.

func (WorkerFunc) DoPOW 

func (f WorkerFunc) DoPOW(msg []byte) (uint64, error)

DoPOW calls f(msg).

Source Files

View all Source files

Directories

Path Synopsis

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.