Struct FederationId

pub struct FederationId(pub Hash);

The federation id is a copy of the authentication threshold public key of the federation

Stable id so long as guardians membership does not change Unique id so long as guardians do not all collude

Tuple Fields

0: Hash

Implementations

impl FederationId

Display as a hex encoding

pub fn dummy() -> FederationId

Random dummy id for testing

pub fn to_prefix(&self) -> FederationIdPrefix

pub fn to_fake_ln_pub_key( &self, secp: &Secp256k1<All>, ) -> Result<PublicKey, Error>

Converts a federation id to a public key to which we know but discard the private key.

Clients MUST never use this private key for any signing operations!

That is ok because we only use the public key for adding a route hint to LN invoices that tells fedimint clients that the invoice can only be paid internally. Since no LN node with that pub key can exist other LN senders will know that they cannot pay the invoice.

Trait Implementations

impl Clone for FederationId

fn clone(&self) -> FederationId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FederationId

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

Formats the value using the given formatter.

impl Decodable for FederationId

fn consensus_decode_from_finite_reader<D>( d: &mut D, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<FederationId, DecodeError>

where D: Read,

Decode Self from a size-limited reader.

fn consensus_decode<R>( r: &mut R, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

where R: Read,

Decode an object with a well-defined format.

fn consensus_decode_hex( hex: &str, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

Decode an object from hex

fn consensus_decode_vec( bytes: Vec<u8>, modules: &ModuleRegistry<Decoder, DecodingMode>, ) -> Result<Self, DecodeError>

impl<'de> Deserialize<'de> for FederationId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FederationId

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

Formats the value using the given formatter.

impl Encodable for FederationId

fn consensus_encode<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Encode an object with a well-defined format. Returns the number of bytes written on success.

fn consensus_encode_to_vec(&self) -> Vec<u8>

Self::consensus_encode to newly allocated Vec<u8>

fn consensus_encode_to_hex(&self) -> String

Encode and convert to hex string representation

fn consensus_encode_to_len(&self) -> usize

Encode without storing the encoding, return the size

fn consensus_hash<H>(&self) -> H

where H: Hash, <H as Hash>::Engine: Write,

Generate a SHA256 hash of the consensus encoding using the default hash engine for H.

impl FromStr for FederationId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<FederationId, <FederationId as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for FederationId

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

where __H: Hasher,

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FederationId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for FederationId

fn eq(&self, other: &FederationId) -> 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 PartialOrd for FederationId

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for FederationId

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.

impl Copy for FederationId

impl Eq for FederationId

impl StructuralPartialEq for FederationId