Crate aleph_bft_types

Source
Expand description

Traits that need to be implemented by the user.

Structs§

IncompleteMultisignatureError
Error resulting from multisignature being incomplete.
Indexed
A pair consistsing of signable data and a NodeIndex.
Multisigned
Signable data together with a complete multisignature.
NodeCount
Node count. Right now it doubles as node weight in many places in the code, in the future we might need a new type for that.
NodeIndex
The index of a node
NodeMap
A container keeping items indexed by NodeIndex.
NodeSubset
OrderedUnit
Represents state of the main internal data structure of AlephBFT (i.e. direct acyclic graph) used for achieving consensus.
SignatureError
Error type returned when a verification of a signature fails.
Signed
A correctly signed object of type T.
UncheckedSigned
A pair consisting of an instance of the Signable trait and an (arbitrary) signature.

Enums§

PartiallyMultisigned
Signable data together with a valid partial multisignature.
Recipient
A recipient of a message, either a specific node or everyone.

Traits§

Data
Data type that we want to order.
DataProvider
The source of data items that consensus should order.
FinalizationHandler
The source of finalization of the units that consensus produces.
Hasher
A hasher, used for creating identifiers for blocks or units.
Index
Indicates that an implementor has been assigned some index.
Keychain
Abstraction of the signing data and verifying signatures.
MultiKeychain
Extends Keychain with multisigning functionalities.
Network
Network represents an interface for sending and receiving NetworkData.
PartialMultisignature
A type to which signatures can be aggregated.
Signable
Data which can be signed.
Signature
The type used as a signature.
SpawnHandle
An abstraction for an execution engine for Rust’s asynchronous tasks.
UnitFinalizationHandler
The source of finalization of the units that consensus produces.

Type Aliases§

Round
An asynchronous round of the protocol.
SessionId
The number of a session for which the consensus is run.
SignatureSet
A set of signatures of a subset of nodes serving as a (partial) multisignature
TaskHandle
A handle for waiting the task’s completion.