Crate fedimint_core

Fedimint Core library

fedimint-core contains are commonly used types, utilities and primitives, shared between both client and server code.

Things that are server-side only typically live in fedimint-server, and client-side only in fedimint-client.

Wasm support

All code in fedimint-core needs to compile on Wasm, and fedimint-core includes helpers and wrappers around non-wasm-safe utitlies.

In particular:

• fedimint_core::task for task spawning and control
• fedimint_core::time for time-related operations

Re-exports

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

Modules

• admin_client
  Admin (guardian) client types
• amount
• backup
  Federation-stored client backups Federation-stored client backups
• bitcoin_migration
  Gradual bitcoin dependency migration helpers
• bls12_381_serde
  Legacy serde encoding for bls12_381
• config
  Federation configuration
• core
  Fundamental types Fedimint Core API (common) module interface
• db
  Database handling Core Fedimint database traits and types
• encoding
  Consensus 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
• envs
  Common environment variables
• epoch
• fmt_utils
  Formatting helpers
• hex
  Hex encoding helpers
• invite_code
  Federation invite code
• macros
  Common macros
• module
  Extenable module sysystem Fedimint supports modules to allow extending it’s functionality. Some of the standard functionality is implemented in form of modules as well.
• net
  Peer networking
• runtime
  Runtime (wasm32 vs native) differences handling Copyright 2021 The Matrix.org Foundation C.I.C. Abstraction over an executor so we can spawn tasks under WASM the same way we do usually.
• session_outcome
  Atomic BFT unit containing consensus items
• task
  Task handling, including wasm safe logic
• tiered
  Types handling per-denomination values
• tiered_multi
  Types handling multiple per-denomination values
• time
  Time handling, wasm safe functionality
• timing
  Timing helpers
• transaction
  Fedimint transaction (inpus + outputs + signature) types
• txoproof
  Peg-in txo proofs
• util
  General purpose utilities

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.
• fedimint_build_code_version_env
  Get value of FEDIMINT_BUILD_CODE_VERSION_ENV at compile time
• 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
• NumPeers
• 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
• WITNESS_SCALE_FACTOR 🔒

Traits

• BitcoinHash
  Trait which applies to hashes of all types.
• NumPeersExt
  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