Skip to main content

Address

Struct Address 

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

A self-certifying protocol address: off1….

§Ordering

Ord compares the underlying hash bytes, not the rendered string. The two orders differ: the bech32 charset (qpzry9x8gf2tvdw0s3jn54khce6mua7l) is not monotonic in ASCII — value 4 renders as y (0x79) and value 5 as 9 (0x39) — and a string comparison would also weigh the checksum characters.

Which order a tiebreaker uses is fixed per site, and the sites disagree. Both-create session ownership compares Address values (hash bytes); group leave election, admin auto-promotion and fork leader election sort rendered strings. Each converges on its own, because every peer running that tiebreaker sorts the same way.

Do not “harmonize” one site onto the other order. Peers that changed and peers that did not would then elect different winners from identical input, with no way to detect the disagreement locally. Prefer hash-byte order for anything new. See docs/adr/0003-self-certifying-addresses.md.

Implementations§

Source§

impl Address

Source

pub const HRP_STR: &'static str = "off"

Human-readable part carried by every address.

Source

pub const VERSION: u8 = 0x01

The only address version this build understands.

Source

pub const HASH_LEN: usize = 20

Length of the truncated identity-key hash, in bytes.

160 bits, which is a second-preimage margin of ~2^160 and a collision margin of ~2^80 — the birthday bound on the same truncation. Both are stated here because they buy different things and only the first is what the impersonation claim rests on:

  • ~2^160 is the cost of aiming at an address that already exists: producing a key that derives to someone else’s address. That is the attack the sender-derivation gate replaced the trust-pin store to stop, and it is the figure the guides and changelog quote.
  • ~2^80 is the cost of producing two identity keys that share one address, neither fixed in advance. It impersonates nobody, but it does let a single entity hold two signing keys that are indistinguishable at the address layer — enough to equivocate, and enough to defeat the “one identity cannot hold two leaves” property that the MLS leaf binding otherwise inherits from MLS signature-key uniqueness.

~2^80 is below the ~2^128 a greenfield design would target, and is a deliberate trade rather than an oversight: every mesh frame carries a sender and a recipient address, and BLE budget is the binding constraint. Widening the hash changes the wire, so it is a VERSION bump and a migration, not a patch.

Source

pub const PAYLOAD_LEN: usize

Length of the encoded payload: version byte followed by the hash.

Source

pub const ENCODED_LEN: usize = 44

Length of the canonical string form.

off (3) + separator (1) + data (34) + checksum (6). The data part is 34 characters because 21 bytes is 168 bits, which needs 34 five-bit groups and leaves 2 padding bits.

Source

pub fn from_hash_bytes(hash: [u8; 20]) -> Self

Builds an address from a truncated identity-key hash.

Infallible: every 20-byte value is a valid address payload.

Source

pub fn from_payload(payload: &[u8]) -> Result<Self, AddressError>

Builds an address from a version ‖ hash payload.

Source

pub fn hash_bytes(&self) -> &[u8; 20]

Returns the truncated identity-key hash.

Source

pub fn payload(&self) -> [u8; 21]

Returns the version ‖ hash payload.

Source

pub fn version(&self) -> u8

Returns the address version byte.

Trait Implementations§

Source§

impl Clone for Address

Source§

fn clone(&self) -> Address

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 Copy for Address

Source§

impl Debug for Address

Source§

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

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

impl<'de> Deserialize<'de> for Address

Source§

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

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

impl Display for Address

Source§

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

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

impl Eq for Address

Source§

impl FromStr for Address

Source§

type Err = AddressError

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Address

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Address

Source§

fn cmp(&self, other: &Address) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Address

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Address

Source§

fn partial_cmp(&self, other: &Address) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for Address

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 Address

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<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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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