Skip to main content

Block

Struct Block 

Source
pub struct Block<T: Transaction> { /* private fields */ }
Expand description

A block.

A block is defined as its header, a list of slashes, amd a list of transactions, as committed to within the block’s header.

The slashes MUST be sorted by the slashed validator.

The transactions MUST be ordered as provided, unsigned, signed, with:

  • The provided transactions sorted by their scopes
  • The unsigned transactions sorted by their hashes
  • The signed transactions sorted by their signers, then their scopes, then their nonces

These strict requirements on ordering allow single-pass verification, without any dynamic allocations, that a block is free of conflicting unsigned/signed transactions (a problem which is considered an instance of an invalid ordering). It also allows checking provided transactions one scope at a time, and straight-line application of a block’s signed transactions, after having prioritized the provided and unsigned transactions which imply some level of recognition within the application.

The Tributary DOES NOT enforce the uniqueness of signed transactions’ hashes, where signed transactions’ hashes MUST bind to all of their semantic contents.

The block’s serialization prefixes the list of slashes with the two-byte little-endian encoding of its length and the list of transactions with the four-byte little-endian encoding of its length. The limit on slashes is complete as there are at most u16::MAX validators. The limit on transactions is practical and enforced as a syntactic requirement.

Implementations§

Source§

impl<T: Transaction> Block<T>

Source

pub fn verify_syntax(&self, genesis: [u8; 32]) -> Result<(), SyntacticError>

Verify this block’s syntax.

This is a check which can be performed without any context or state, other than the genesis hash, allowing it to be performed in response to network traffic before acquiring any mutexes or occupying any channels.

This DOES verify the slashed validators are committed to within the block’s header. This DOES NOT verify the slashes themselves, which is semantic. This enables malleability in that a malicious peer MAY substitute a valid slash reason for a validator with an invalid slash reason for the same validator. The reason for a slash may be verified via Slash::verify, solely requiring the context which spawned the Tributary (not its current state).

This DOES verify the transactions are committed to within the block’s header. This DOES verify the signed transaction’s signatures. If the application’s transaction type omits signatures from the transaction’s hash, due to them not affecting the semantic meaning of the transaction, a malicious peer MAY substitute a signed transaction’s valid signature with an invalid signature.

If the block is agreed upon by the validators via the consensus process, there MUST be valid uncommitted data available so long as the honest-majority assumption is upheld. This means if a block is received with invalid data which wasn’t committed to, but the block is agreed upon, it is the peer which should be considered valid, not the block. The uncommitted data should be retrieved from an honest peer instead.

For blocks without agreement under consensus, it would not appear immediate to determine if a block with invalid uncommitted data is due to a malicious proposer or a malicious peer. However, if the block was received from a peer who isn’t the proposer, the peer MUST be faulty, as the peer either malleated the block to be invalid themselves or chose to relay an invalid block (assuming the gossip layer does not simply relay every message seen without any scrutiny).

Source

pub fn instantiate( genesis: [u8; 32], parent: [u8; 32], time: u64, slashes: Box<[Slash]>, transactions: Box<[T]>, ) -> Result<Self, SyntacticError>

Instantiate a block.

This will check the block is syntactically valid via Block::verify_syntax. It is intended to enable optimized peer-to-peer layers, where the application syncs block headers independently from their contents, where fine control over each individual item is required (e.g. if a single item was malleated and should be replaced).

Source

pub fn parent(&self) -> [u8; 32]

This block’s parent’s hash.

Source

pub fn time(&self) -> u64

This block’s time.

See BlockHeader::time for more information.

Source

pub fn hash(&self) -> [u8; 32]

The hash of this block.

This is defined as the hash of its header.

Source

pub fn slashes(&self) -> &[Slash]

The slashes within this block.

Source

pub fn transactions(&self) -> &[T]

The transactions within this block.

Trait Implementations§

Source§

impl<T: Clone + Transaction> Clone for Block<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<T: Debug + Transaction> Debug for Block<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: Transaction> ReadWrite for Block<T>

Source§

fn read(reader: impl Read) -> Result<Self>

This will read a block with no size limits applied. While this will not reserve capacity for the alleged length of lists, meaning the amount of memory consumed is proportional to the amount of bytes read, the caller is expected to ensure they are prepared to read this block in its entirety.

Applications SHOULD apply their own size limit to the reader itself to prevent a potential Denial of Service by transmitting several GB of data which, if deserialized, will then be stored in memory.

Source§

fn write(&self, writer: impl Write) -> Result<()>

Write the value of self. Read more
Source§

fn serialize(&self) -> Vec<u8> ⓘ

Serialize self to a Vec<u8>. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Block<T>
where Box<[T]>: Freeze,

§

impl<T> RefUnwindSafe for Block<T>

§

impl<T> Send for Block<T>
where Box<[T]>: Send,

§

impl<T> Sync for Block<T>
where Box<[T]>: Sync,

§

impl<T> Unpin for Block<T>
where Box<[T]>: Unpin,

§

impl<T> UnsafeUnpin for Block<T>

§

impl<T> UnwindSafe for Block<T>
where Box<[T]>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V