FedimintWallet Overview
The FedimintWallet class serves as the main entry point for the library. It orchestrates the various services and the WorkerClient.
INFO
Check out the Getting Started guide to get started using the Fedimint Web 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
joinFederation()
joinFederation(
inviteCode,clientName):Promise<void>
Parameters
• inviteCode: string
• clientName: string = DEFAULT_CLIENT_NAME
Returns
Promise<void>
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>