Skip to main content

SsaClientCommitmentMessage

Struct SsaClientCommitmentMessage 

Source
pub struct SsaClientCommitmentMessage<I, G, K> {
    pub session_id: I,
    pub ssa_index: SsaIndex,
    pub coefficient_index: u16,
    pub commitment_proof: Option<K>,
    pub coefficient_commitments: HashMap<PolynomialIndex, G>,
}
Expand description

Filling up the Client’s commitment to the Session Stealth Address (SSA).

The generic argument G typically represents a PixGroupRepr.

The overall Client’s commitment to a single new SSA usually requires multiple messages, all sharing the same SsaIndex.

Each of these messages contains commitments to polynomial coefficients that all belong to the same coefficient in each polynomial.

In practice every message carries coefficient_index == 0: PIX commits to each polynomial’s constant term and nothing else, so the constant-term pass is the whole commitment. The field (and phase 2 of new_multiple, which now has nothing to emit) is retained because the wire format still admits higher coefficient indices; a peer that sends them merely wastes bandwidth, since the receiver ignores them.

See hopr_protocol_pix::SsaPartCommitment for why the non-constant coefficient commitments were dropped and what that costs.

Fields§

§session_id: I

Session ID.

§ssa_index: SsaIndex

Index of the Session Stealth Address (SSA) that is being committed.

§coefficient_index: u16

Index of the polynomial coefficient that is being committed.

Zero value indicates the polynomial constant term commitment, which when summed over all polynomials for a given SsaIndex results in the Client’s SSA commitment.

This is always zero in practice — see the type-level documentation.

§commitment_proof: Option<K>

Proof that the Client knows the discrete logarithm of its SSA commitment.

Present exactly when coefficient_index == 0: the commitment it opens is the sum of all constant terms, so it belongs with the messages that deliver them, and there is no separate presence flag on the wire — the coefficient index decides it. Every constant-term message carries it rather than only one, so no single lost packet can strand a cycle that would otherwise be recoverable, and the receiver keeps the first it sees.

Without it the receiver cannot distinguish a genuine commitment from one crafted so the combined deposit key is known to the sender alone. See hopr_protocol_pix::SsaCommitmentProof.

§coefficient_commitments: HashMap<PolynomialIndex, G>

Contains the serialized coefficient commitments of multiple polynomials, all belonging to the same coefficient_index in each polynomial.

This might not be the complete set yet and might require multiple messages to deliver the complete commitment to the given coefficient of all polynomials for the given SSA.

Implementations§

Source§

impl<I: Serialize + Clone, G: Clone, K: Clone> SsaClientCommitmentMessage<I, G, K>

Source

pub fn new_multiple<S: PixSpec>( session_id: I, commitment: SsaCommitment<S, S::Pseudonym>, ) -> Result<Vec<Self>, StartProtocolError>

Uses given the session_id and an SsaCommitment that will be split across multiple messages.

The returned messages are ordered by coefficient index, making sure the constant terms of the polynomials are delivered first.

Trait Implementations§

Source§

impl<I: Clone, G: Clone, K: Clone> Clone for SsaClientCommitmentMessage<I, G, K>

Source§

fn clone(&self) -> SsaClientCommitmentMessage<I, G, K>

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<I: Debug, G: Debug, K: Debug> Debug for SsaClientCommitmentMessage<I, G, K>

Source§

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

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

impl<I: Eq, G: Eq, K: Eq> Eq for SsaClientCommitmentMessage<I, G, K>

Source§

impl<I: PartialEq, G: PartialEq, K: PartialEq> PartialEq for SsaClientCommitmentMessage<I, G, K>

Source§

fn eq(&self, other: &SsaClientCommitmentMessage<I, G, K>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl<I: PartialEq, G: PartialEq, K: PartialEq> StructuralPartialEq for SsaClientCommitmentMessage<I, G, K>

Auto Trait Implementations§

§

impl<I, G, K> Freeze for SsaClientCommitmentMessage<I, G, K>
where I: Freeze, K: Freeze,

§

impl<I, G, K> RefUnwindSafe for SsaClientCommitmentMessage<I, G, K>

§

impl<I, G, K> Send for SsaClientCommitmentMessage<I, G, K>
where I: Send, K: Send, G: Send,

§

impl<I, G, K> Sync for SsaClientCommitmentMessage<I, G, K>
where I: Sync, K: Sync, G: Sync,

§

impl<I, G, K> Unpin for SsaClientCommitmentMessage<I, G, K>
where I: Unpin, K: Unpin, G: Unpin,

§

impl<I, G, K> UnsafeUnpin for SsaClientCommitmentMessage<I, G, K>
where I: UnsafeUnpin, K: UnsafeUnpin,

§

impl<I, G, K> UnwindSafe for SsaClientCommitmentMessage<I, G, K>
where I: UnwindSafe, K: UnwindSafe, G: 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
§

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

§

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> DynClone for T
where T: Clone,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

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
§

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
§

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> 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, 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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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