Re-exports§
pub use fedimint_mint_common as common;
Modules§
- api
- API client impl for mint-specific requests
- backup
- client_
db - Database keys used throughout the mint client module
- config
- endpoint_
constants - event
- output
- State machines for mint outputs
Structs§
- Backup
Request - Blind
Nonce Noncebut blinded by the user key- Insufficient
Balance Error - Mint
Client Context - Mint
Client Init - Mint
Client Module - The
MintClientModuleis responsible for handling e-cash minting operations. It interacts with the mint server to issue, reissue, and validate e-cash notes. - Mint
Common Init - Mint
Input V0 - Mint
Module Types - Mint
Operation Meta - Mint
Output Blind Signature - Result of Federation members confirming
MintOutputby contributing partial signatures viaMintConsensusItem - Mint
Output Outcome V0 - Mint
Output V0 - Mint
Restore State Machine - Old and no longer used, will be deleted in the future
- Nonce
- Unique ID of a mint note.
- Note
- An verifiable one time use IOU from the mint.
- Note
Index - An index used to deterministically derive
Notes - OOBNote
V2 - OOBNotes
- An encapsulation of
FederationIdand e-cash notes in the form ofTieredMulti<SpendableNote>for the purpose of spending e-cash out-of-band. Also used for validating and reissuing such out-of-band notes. - OOBNotes
V2 - Select
Notes With Atleast Amount - Select notes with total amount of at least
request_amount. If more than requested amount of notes are returned it was because exact change couldn’t be made, and the next smallest amount will be returned. - Select
Notes With Exact Amount - Select notes with total amount of exactly
request_amount. If the amount cannot be represented with the available denominations an error is returned, this does not mean that the balance is too low. - Signed
Backup Request - SpendOOB
Refund - Spendable
Note - A
Notewith associated secret key that allows to proof ownership (spend it) - Spendable
Note Undecoded - A version of
SpendableNotethat didn’t decode thesignatureyet - Unknown
Mint Input Variant Error - Unknown
Mint Output Outcome Variant Error - Unknown
Mint Output Variant Error
Enums§
- Mint
Client State Machines - Mint
Consensus Item - The mint module currently doesn’t define any consensus items and generally throws an error on encountering one. To allow old clients to still decode blocks in the future, should we decide to add consensus items, this has to be an enum with only a default variant.
- Mint
Input - Mint
Input Error - Mint
Operation Meta Variant - Mint
Output - Mint
Output Error - Mint
Output Outcome - Reissue
External Notes Error - Reissue
External Notes State - The high-level state of a reissue operation started with
MintClientModule::reissue_external_notes. - SpendOOB
State - The high-level state of a raw e-cash spend operation started with
MintClientModule::spend_notes_with_selector.
Constants§
- DEFAULT_
MAX_ NOTES_ PER_ DENOMINATION - By default, the maximum notes per denomination when change-making for users
- KIND
- MODULE_
CONSENSUS_ VERSION
Traits§
- Notes
Selector - Defines a strategy for selecting e-cash notes given a specific target amount and fee per note transaction input.
Functions§
- represent_
amount - Determines the denominations to use when representing an amount
- spendable_
notes_ to_ operation_ id