Skip to main content

Threshold

Enum Threshold 

Source
pub enum Threshold {
    Simple(u64),
    Weighted(Vec<Vec<Fraction>>),
}
Expand description

KERI signing/backer threshold.

Simple thresholds are hex-encoded integers ("1", "2", "a"). Weighted thresholds are clause lists of fractions ([["1/2","1/2"]]). Clauses are ANDed; each is satisfied when the sum of verified weights >= 1.

Usage:

use auths_keri::Threshold;
let t: Threshold = serde_json::from_str("\"2\"").unwrap();
assert_eq!(t.simple_value(), Some(2));

Variants§

§

Simple(u64)

M-of-N threshold (hex-encoded integer in JSON).

§

Weighted(Vec<Vec<Fraction>>)

Fractionally weighted threshold (list of clause lists in JSON). Clauses are ANDed; each is satisfied when sum of verified weights >= 1.

Implementations§

Source§

impl Threshold

Source

pub fn simple_value(&self) -> Option<u64>

Get the simple threshold value, if this is a simple threshold.

Source

pub fn validate_satisfiable(&self, count: usize) -> Result<(), KeriTypeError>

Check that this threshold is structurally satisfiable against a key (or commitment / backer) list of length count.

This is a structural guard run at validation entry — it rejects events whose threshold can never be met regardless of which signatures arrive: a Simple(n) with n > count, a non-zero Simple over an empty list, or a Weighted clause whose length doesn’t match count.

Args:

  • count - Length of the list the threshold governs (k, n, or b).

Usage:

use auths_keri::Threshold;
assert!(Threshold::Simple(2).validate_satisfiable(3).is_ok());
assert!(Threshold::Simple(5).validate_satisfiable(1).is_err());
Source

pub fn is_satisfied(&self, verified_indices: &[u32], key_count: usize) -> bool

Check if the threshold is satisfied by the given set of verified key indices.

For Simple(n): at least n unique indices must be verified. For Weighted(clauses): ALL clauses must be independently satisfied. A clause is satisfied when the sum of weights at verified indices >= 1.

Args:

  • verified_indices - Indices of keys whose signatures have been verified.
  • key_count - Total number of keys in the key list (for bounds checking).

Usage:

use auths_keri::Threshold;
let t = Threshold::Simple(2);
assert!(t.is_satisfied(&[0, 1], 3));
assert!(!t.is_satisfied(&[0], 3));

Trait Implementations§

Source§

impl Clone for Threshold

Source§

fn clone(&self) -> Threshold

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 Debug for Threshold

Source§

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

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

impl Default for Threshold

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Threshold

Source§

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Threshold

Source§

impl PartialEq for Threshold

Source§

fn eq(&self, other: &Threshold) -> bool

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Threshold

Source§

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Threshold

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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

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

Source§

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

Compare self to key and return true if they are equal.
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> 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.