Struct ParentDeclaration 

pub struct ParentDeclaration { /* private fields */ }

A node’s declaration of its parent in the spanning tree.

Each node periodically announces its parent selection. The declaration includes a monotonic sequence number for freshness and a signature for authenticity. When parent_id == node_addr, the node declares itself as a root candidate.

Implementations

impl ParentDeclaration

pub fn new( node_addr: NodeAddr, parent_id: NodeAddr, sequence: u64, timestamp: u64, ) -> Self

Create a new unsigned parent declaration.

The declaration must be signed before transmission using set_signature().

pub fn self_root(node_addr: NodeAddr, sequence: u64, timestamp: u64) -> Self

Create a self-declaration (node is root candidate).

pub fn with_signature( node_addr: NodeAddr, parent_id: NodeAddr, sequence: u64, timestamp: u64, signature: Signature, ) -> Self

Create a declaration with a pre-computed signature.

pub fn node_addr(&self) -> &NodeAddr

Get the declaring node’s ID.

pub fn parent_id(&self) -> &NodeAddr

Get the parent node’s ID.

pub fn sequence(&self) -> u64

Get the sequence number.

pub fn timestamp(&self) -> u64

Get the timestamp.

pub fn signature(&self) -> Option<&Signature>

Get the signature, if set.

pub fn set_signature(&mut self, signature: Signature)

Set the signature after signing.

pub fn sign(&mut self, identity: &Identity) -> Result<(), TreeError>

Sign this declaration with the given identity.

The identity’s node_addr must match this declaration’s node_addr. Returns an error if the node_addrs don’t match.

pub fn is_root(&self) -> bool

Check if this is a root declaration (parent == self).

pub fn is_signed(&self) -> bool

Check if this declaration is signed.

pub fn signing_bytes(&self) -> Vec<u8>

Get the bytes that should be signed.

Format: node_addr (16) || parent_id (16) || sequence (8) || timestamp (8)

pub fn verify(&self, pubkey: &XOnlyPublicKey) -> Result<(), TreeError>

Verify the signature on this declaration.

Returns Ok(()) if the signature is valid, or an error otherwise.

pub fn is_fresher_than(&self, other: &ParentDeclaration) -> bool

Check if this declaration is fresher than another.

Trait Implementations

impl Clone for ParentDeclaration

fn clone(&self) -> ParentDeclaration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParentDeclaration

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

Formats the value using the given formatter.

impl PartialEq for ParentDeclaration

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for ParentDeclaration