Struct Fedimintd

pub struct Fedimintd {
    server_gens: ServerModuleInitRegistry,
    server_gen_params: ServerModuleConfigGenParamsRegistry,
    code_version_hash: String,
    code_version_str: String,
    opts: ServerOpts,
    bitcoind_rpc: BitcoinRpcConfig,
}

fedimintd builder

Fedimint supports third party modules. Right now (and for forseable feature) modules needs to be combined with the rest of the code at compilation time.

To make this easier, Fedimintd builder is exposed, allowing building fedimintd with custom set of modules.

Example:

use fedimint_ln_server::LightningInit;
use fedimint_mint_server::MintInit;
use fedimint_wallet_server::WalletInit;
use fedimintd::Fedimintd;

// Note: not called `main` to avoid rustdoc executing it
// #[tokio::main]
async fn main_() -> anyhow::Result<()> {
    Fedimintd::new(env!("FEDIMINT_BUILD_CODE_VERSION"), Some("vendor-xyz-1"))?
        // use `.with_default_modules()` to avoid having
        // to import these manually
        .with_module_kind(WalletInit)
        .with_module_kind(MintInit)
        .with_module_kind(LightningInit)
        .run()
        .await
}

Fields

server_gens: ServerModuleInitRegistry

server_gen_params: ServerModuleConfigGenParamsRegistry

code_version_hash: String

code_version_str: String

opts: ServerOpts

bitcoind_rpc: BitcoinRpcConfig

Implementations

impl Fedimintd

pub fn new( code_version_hash: &str, code_version_vendor_suffix: Option<&str>, ) -> Result<Fedimintd>

Builds a new fedimintd

Arguments

• code_version_hash - The git hash of the code that the fedimintd binary is being built from. This is used mostly for information purposes (fedimintd version-hash). See fedimint-build crate for easy way to obtain it.

• code_version_vendor_suffix - An optional suffix that will be appended to the internal fedimint release version, to distinguish binaries built by different vendors, usually with a different set of modules. Currently DKG will enforce that the combined code_version is the same between all peers.

pub fn with_module_kind<T>(self, gen: T) -> Self

where T: ServerModuleInit + 'static + Send + Sync,

Attach a server module kind to the Fedimintd instance

This makes fedimintd support additional module types (aka. kinds)

pub fn version_hash(&self) -> &str

Get the version hash this fedimintd will report for diagnostic purposes

pub fn with_module_instance<P>(self, kind: ModuleKind, params: P) -> Self

where P: ModuleInitParams,

Attach additional module instance with parameters

Note: The kind needs to be added with Self::with_module_kind if it’s not the default one.

pub fn with_default_modules(self) -> Result<Self>

Attach default server modules to Fedimintd instance

pub async fn run(self) -> !

Block thread and run a Fedimintd server

fn get_server_api_versions(&self) -> ServerApiVersionsSummary

fn get_server_db_versions(&self) -> ServerDbVersionsSummary