Crate fedimint_core

Re-exports

• pub use module::ServerModule;
• pub use tiered::Tiered;
• pub use crate::core::server;
• pub use tiered_multi::*;

Modules

• admin_client
• amount
• api
• backup
• bitcoinrpc
• cancellable
• config
• core
  Fedimint Core API (common) module interface
• db
  Core Fedimint database traits and types
• encoding
  This module defines a binary encoding interface which is more suitable for consensus critical encoding than e.g. bincode. Over time all structs that need to be encoded to binary will be migrated to this interface.
• endpoint_constants
• epoch
• fmt_utils
• hex
• macros
• module
• net
• query
• session_outcome
  Atomic BFT unit containing consensus items
• task
• tiered
• tiered_multi
• time
• timing
• transaction
• txoproof
• util

Macros

• __api_endpoint
  Example
• _dyn_newtype_define_inner
• _dyn_newtype_define_with_instance_id_inner
• _dyn_newtype_impl_deref_mut
• async_trait_maybe_send
  async trait that use MaybeSend
• deserialize_as_encodable_hex
• dyn_newtype_define
  Define “dyn newtype” (a newtype over dyn Trait)
• dyn_newtype_display_passthrough
  Implements the Display trait for dyn newtypes whose traits implement Display
• dyn_newtype_impl_dyn_clone_passthrough
  Implement Clone on a “dyn newtype”
• erased_eq_no_instance_id
• extensible_associated_module_type
  Wraps a type into an enum with a default variant, this allows to add new versions of the type in the future. Depending on context unknown versions may be ignored or lead to errors. E.g. the client might just ignore an unknown input version since it cannot originate from itself while the server would reject it for not being able to validate its correctness.
• impl_db_lookup
• impl_db_record
  This is a helper macro that generates the implementations of DatabaseRecord necessary for reading/writing to the database and fetching by prefix.
• maybe_add_send
  MaybeSync can not be used in dyn $Trait + MaybeSend
• maybe_add_send_sync
  See maybe_add_send
• module_plugin_dyn_newtype_clone_passthrough
• module_plugin_dyn_newtype_define
  Define a “module plugin dyn-newtype” which is like a standard “dyn newtype”, but with associated “module_instance_id”.
• module_plugin_dyn_newtype_display_passthrough
• module_plugin_dyn_newtype_encode_decode
  Implement Encodable and Decodable for a “module dyn newtype”
• module_plugin_dyn_newtype_eq_passthrough
• module_plugin_static_trait_define
  Define a “plugin” trait
• module_plugin_static_trait_define_config
  A copy of module_lugin_static_trait_define but for ClientConfig, which is a snowflake that requires : Serialize and conditional implementation for DynUnknown. The macro is getting gnarly, so seems easier to copy-paste-modify, than pile up conditional argument.
• plugin_types_trait_impl_common
  Implements the necessary traits for all associated types of a FederationServer module.
• plugin_types_trait_impl_config
  Implements the necessary traits for all configuration related types of a FederationServer module.
• push_db_key_items
• push_db_pair_items
• push_db_pair_items_no_serde
• serde_as_encodable_hex
• serialize_as_encodable_hex

Structs

• Amount
  Represents an amount of BTC inside the system. The base denomination is milli satoshi for now, this is also why the amount type from rust-bitcoin isn’t used instead.
• Feerate
• OutPoint
  OutPoint represents a globally unique output in a transaction
• PeerId
• TransactionId
  A transaction id for peg-ins, peg-outs and reissuances

Enums

• BitcoinAmountOrAll
  Amount of bitcoin to send, or “all” to send all available funds
• CoreError
• ParseAmountError

Constants

• SATS_PER_BITCOIN

Traits

• BitcoinHash
  Trait which applies to hashes of all types.
• NumPeers
  for consensus-related calculations given the number of peers

Functions

• msats
  Shorthand for Amount::from_msats
• sats
  Shorthand for Amount::from_sats
• weight_to_vbytes
  Converts weight to virtual bytes, defined in BIP-141 as weight / 4 (rounded up to the next integer).

Attribute Macros

• apply