Skip to main content

BuiltCommitment

Struct BuiltCommitment 

Source
pub struct BuiltCommitment { /* private fields */ }
Expand description

A fully-built commitment: signed wire blob, cached hash, Merkle tree for inclusion proofs, and a sorted leaf-index lookup for the auditor’s leaf_index field.

Held inside an Arc so audit responders can grab a reference and build a reply without holding the ResponderCommitmentState read lock for the duration of the response.

Implementations§

Source§

impl BuiltCommitment

Source

pub fn build( entries: Vec<(XorName, [u8; 32])>, sender_peer_id: &[u8; 32], secret_key: &MlDsaSecretKey, sender_public_key: &[u8], ) -> Result<Self, CommitmentError>

Build a commitment over entries = [(key, bytes_hash), ...] and sign it with secret_key.

entries does not need to be sorted (the inner MerkleTree sorts internally); sender_peer_id is bound into the signature and the commitment.

§Errors

Returns the wrapped CommitmentError on empty key sets, over-cap key counts, duplicates, or signing failures.

Source

pub fn build_from_tree( tree: MerkleTree, sender_peer_id: &[u8; 32], secret_key: &MlDsaSecretKey, sender_public_key: &[u8], ) -> Result<Self, CommitmentError>

Sign and wrap an ALREADY-BUILT Merkle tree. Lets callers that already built the tree (e.g. the rotation no-op-root check, §11) avoid rebuilding it inside Self::build.

§Errors

Propagates signing / serialization failures, identical to Self::build.

Source

pub fn commitment(&self) -> &StorageCommitment

The signed wire blob.

Source

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

The cached commitment hash. Equal to crate::replication::commitment::commitment_hash (self.commitment()).

Source

pub fn tree(&self) -> &MerkleTree

The Merkle tree behind this commitment.

Used by the subtree-audit responder to plan a proof (select the nonce-determined branch and read its sibling cut-hashes).

Source

pub fn proof_for(&self, key: &XorName) -> Option<(Vec<[u8; 32]>, u32)>

Inclusion path + leaf index for key, if it is in this commitment. Returns None if key is not committed.

Source

pub fn contains_key(&self, key: &XorName) -> bool

Whether key is committed in this tree. Allocation-free membership check (binary search over the sorted leaf keys) — equivalent to proof_for(key).is_some() but without building the inclusion path, for hot callers (e.g. the pruner’s is_held veto) that only need the boolean.

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more