Struct OperationId

pub struct OperationId(pub [u8; 32]);

Unique identifier for one semantic, correlatable operation.

The concept of operations is used to avoid losing privacy while being as efficient as possible with regards to network requests.

For Fedimint transactions to be private users need to communicate with the federation using an anonymous communication network. If each API request was done in a way that it cannot be correlated to any other API request we would achieve privacy, but would reduce efficiency. E.g. on Tor we would need to open a new circuit for every request and open a new web socket connection.

Fortunately we do not need to do that to maintain privacy. Many API requests and transactions can be correlated by the federation anyway, in these cases it does not make any difference to re-use the same network connection. All requests, transactions, state machines that are connected from the federation’s point of view anyway are grouped together as one operation.

Choice of Operation ID

In cases where an operation is created by a new transaction that’s being submitted the transaction’s ID can be used as operation ID. If there is no transaction related to it, it should be generated randomly. Since it is a 256bit value collisions are impossible for all intents and purposes.

Tuple Fields

0: [u8; 32]

Implementations

impl OperationId

pub fn new_random() -> Self

Generate random OperationId

pub fn from_encodable<E: Encodable>(encodable: &E) -> Self

pub fn fmt_short(&self) -> OperationIdShortFmt<'_>

pub fn fmt_full(&self) -> OperationIdFullFmt<'_>

Trait Implementations

impl Clone for OperationId

fn clone(&self) -> OperationId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OperationId

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

Formats the value using the given formatter.

impl Decodable for OperationId

fn consensus_decode_from_finite_reader<D: Read>( d: &mut D, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode Self from a size-limited reader.

fn consensus_decode_whole( slice: &[u8], modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

fn consensus_decode<R: Read>( r: &mut R, modules: &ModuleDecoderRegistry, ) -> Result<Self, DecodeError>

Decode an object with a well-defined format.

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

Decode an object from hex

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

impl<'de> Deserialize<'de> for OperationId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodable for OperationId

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

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::Engine: Write,

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

fn consensus_hash_sha256(&self) -> Hash

Self::consensus_hash for [bitcoin::hashes::sha256::Hash]

impl FromStr for OperationId

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for OperationId

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

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 OperationId

fn cmp(&self, other: &OperationId) -> 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 OperationId

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

fn partial_cmp(&self, other: &OperationId) -> 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 OperationId

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

Serialize this value into the given Serde serializer.

impl Copy for OperationId

impl Eq for OperationId

impl StructuralPartialEq for OperationId