FedimintWallet Overview
The FedimintWallet class serves as the main entry point for the library. It orchestrates the various services and the TransportClient.
INFO
Check out the Getting Started guide to get started using the Fedimint Sdk.
Properties
balance
balance:
BalanceService
Defined in
federation
federation:
FederationService
Defined in
lightning
lightning:
LightningService
Defined in
mint
mint:
MintService
Defined in
recovery
recovery:
RecoveryService
Defined in
Methods
cleanup()
cleanup():
Promise<void>
This should ONLY be called when UNLOADING the wallet client. After this call, the FedimintWallet instance should be discarded.
Returns
Promise<void>
Defined in
initialize()
initialize():
Promise<void>
Returns
Promise<void>
Defined in
isOpen()
isOpen():
boolean
Returns
boolean
Defined in
parseInviteCode()
parseInviteCode(
inviteCode):Promise<ParsedInviteCode>
Parses an invite code without requiring an open wallet or joined federation.
Parameters
• inviteCode: string
Returns
Promise<ParsedInviteCode>
The parsed invite code data containing federation_id and url.
Defined in
parseBolt11Invoice()
parseBolt11Invoice(
invoiceStr):Promise<ParsedBolt11Invoice>
Parses a BOLT11 invoice without requiring an open wallet or joined federation.
Parameters
• invoiceStr: string
Returns
Promise<ParsedBolt11Invoice>
The parsed invoice data where amount is in satoshis.
Defined in
joinFederation()
joinFederation(
inviteCode,clientName):Promise<void>
Parameters
• inviteCode: string
• clientName: string = DEFAULT_CLIENT_NAME
Returns
Promise<void>
Defined in
previewFederation(inviteCode)
previewFederation(
inviteCode):Promise<PreviewFederation>
Retrieves federation details before joining a Federation. This allows you to inspect the federation's configuration, endpoints, modules, and metadata.
Parameters
• inviteCode: string
Returns
Promise<PreviewFederation>
Federation preview information containing:
config: Detailed JSON configuration including global settings, API endpoints, consensus version, and module configurationsfederation_id: The unique federation identifier
Defined in
parseOobNotes(notes)
parseOobNotes(
notes):Promise<ParsedNoteDetails>
Parses OOB notes and retrieves their details. It allows you to inspect the contents of OOB notes before redeeming them.
Parameters
• notes: string
Returns
Promise<ParsedNoteDetails>
The parsed note details containing total_amount, federation_id_prefix, federation_id, invite_code, and note_counts.
Defined in
open()
open(
clientName):Promise<any>
Parameters
• clientName: string = DEFAULT_CLIENT_NAME
Returns
Promise<any>
Defined in
setLogLevel()
setLogLevel(
level):void
Sets the log level for the library.
Parameters
• level: "debug" | "info" | "warn" | "error" | "none"
The desired log level ('DEBUG', 'INFO', 'WARN', 'ERROR', 'NONE').
Returns
void
Defined in
waitForOpen()
waitForOpen():
Promise<null|void>
Returns
Promise<null | void>