Skip to main content

KeyState

Struct KeyState 

Source
pub struct KeyState {
Show 14 fields pub prefix: Prefix, pub current_keys: Vec<CesrKey>, pub next_commitment: Vec<Said>, pub sequence: u128, pub last_event_said: Said, pub is_abandoned: bool, pub threshold: Threshold, pub next_threshold: Threshold, pub backers: Vec<Prefix>, pub backer_threshold: Threshold, pub config_traits: Vec<ConfigTrait>, pub is_non_transferable: bool, pub delegator: Option<Prefix>, pub last_establishment_sequence: u128,
}
Expand description

Current key state derived from replaying a KEL.

This struct captures the complete state of a KERI identity at a given point in its event log. It is computed by walking the KEL from inception to the latest event.

Fields§

§prefix: Prefix

The KERI identifier prefix (used in did:keri:<prefix>)

§current_keys: Vec<CesrKey>

Current signing key(s), CESR-encoded.

§next_commitment: Vec<Said>

Next key commitment(s) for pre-rotation (Blake3 digests).

§sequence: u128

Current sequence number (0 for inception, increments with each event)

§last_event_said: Said

SAID of the last processed event

§is_abandoned: bool

Whether this identity has been abandoned (empty next commitment in rotation)

§threshold: Threshold

Current signing threshold

§next_threshold: Threshold

Next signing threshold (committed)

§backers: Vec<Prefix>

Current backer/witness list

§backer_threshold: Threshold

Current backer threshold

§config_traits: Vec<ConfigTrait>

Configuration traits from inception (and rotation for RB/NRB)

§is_non_transferable: bool

Whether this identity is non-transferable (inception n was empty)

§delegator: Option<Prefix>

Delegator AID (if this is a delegated identity)

§last_establishment_sequence: u128

Sequence number of the last establishment event (ICP or ROT). Used to locate the pre-committed next key in the keychain. IXN events do not change this value.

Implementations§

Source§

impl KeyState

Source

pub fn from_inception( prefix: Prefix, keys: Vec<CesrKey>, next: Vec<Said>, threshold: Threshold, next_threshold: Threshold, said: Said, backers: Vec<Prefix>, backer_threshold: Threshold, config_traits: Vec<ConfigTrait>, ) -> KeyState

Create initial state from an inception event.

Args:

  • prefix - The KERI identifier (same as inception SAID)
  • keys - The initial signing key(s)
  • next - The next-key commitment(s)
  • threshold - Initial signing threshold
  • next_threshold - Committed next signing threshold
  • said - The inception event SAID
  • backers - Initial witness/backer list
  • backer_threshold - Witness/backer threshold
  • config_traits - Configuration traits from inception
Source

pub fn apply_rotation( &mut self, new_keys: Vec<CesrKey>, new_next: Vec<Said>, threshold: Threshold, next_threshold: Threshold, sequence: u128, said: Said, backers_to_remove: &[Prefix], backers_to_add: &[Prefix], backer_threshold: Threshold, config_traits: Vec<ConfigTrait>, )

Apply a rotation event to update state.

This should only be called after verifying:

  1. The new key matches the previous next_commitment
  2. The event’s previous SAID matches last_event_said
  3. The sequence is exactly last_sequence + 1
Source

pub fn apply_interaction(&mut self, sequence: u128, said: Said)

Apply an interaction event (updates sequence and SAID only).

Interaction events anchor data but don’t change keys.

Source

pub fn current_key(&self) -> Option<&CesrKey>

Get the current signing key (first key for single-sig).

Source

pub fn can_rotate(&self) -> bool

Check if key can be rotated.

Returns false if the identity has been abandoned (empty next commitment).

Source

pub fn can_emit_ixn(&self) -> bool

Check if this identity can emit interaction (ixn) events.

Returns false if the identity is non-transferable (empty n[] at inception) or establishment-only ("EO" in c[]). Both conditions prohibit ixn events per KERI spec.

Source

pub fn did(&self) -> String

Get the DID for this identity.

Trait Implementations§

Source§

impl Clone for KeyState

Source§

fn clone(&self) -> KeyState

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 KeyState

Source§

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

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

impl<'de> Deserialize<'de> for KeyState

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyState, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

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

impl Eq for KeyState

Source§

impl PartialEq for KeyState

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for KeyState

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

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

impl StructuralPartialEq for KeyState

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

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

Source§

fn vzip(self) -> V