Expand description
Federation configuration
Modules§
- serde_
binary_ human_ readable - serde_
commit 🔒 - Handling the Group serialization with a wrapper
Structs§
- Client
Config - Total client config
- Client
Config V0 - Total client config v0 (<0.4.0). Does not contain broadcast public keys.
- Client
Module Config - Config for the client-side of a particular Federation module
- Config
GenModule Params - Type erased
ModuleInitParams
used to generate theServerModuleConfig
during config gen - Empty
GenParams - Empty struct for if there are no params
- Federation
Id - The federation id is a copy of the authentication threshold public key of the federation
- Federation
IdPrefix - Prefix of the
FederationId
, useful for UX improvements - Global
Client Config - Federation-wide client config
- Global
Client Config V0 - Federation-wide client config
- Json
Client Config - Client config that cannot be cryptographically verified but is easier to parse by external tools
- Json
With Kind serde_json::Value
that must containkind: String
field- Module
Init Registry - PeerUrl
- Server
Module Config - Config for the server-side of a particular Federation module
- Server
Module Consensus Config
Enums§
- DkgMessage
- DkgPeer
Message - Things that a
distributed_gen
config can send between peers - Supported
DkgMessage enum
version ofSupportedDkgMessage
Constants§
- ALEPH_
BFT_ UNIT_ BYTE_ LIMIT - This limits the RAM consumption of a AlephBFT Unit to roughly 50kB
- META_
FEDERATION_ NAME_ KEY - Key under which the federation name can be sent to client in the
meta
part of the config
Traits§
- DkgGroup
- Defines a group (e.g. G1 or G2) that we can generate keys for
- ISupported
DkgMessage - Supported (by Fedimint’s code)
DkgMessage<T>
types - Module
Init Params - SGroup
- Typed
Server Module Config - Module (server side) config, typed
- Typed
Server Module Consensus Config - Consensus-critical part of a server side module config
Functions§
Type Aliases§
- Common
Module Init Registry - Server
Module Config GenParams Registry - Registry that contains the config gen params for all modules