Fedimint Web Sdk

Appearance

FedimintWallet Overview ​

The FedimintWallet class serves as the main entry point for the library. It orchestrates the various services and the WorkerClient.

Architecture

Properties ​

balance ​

balance: BalanceService

Defined in ​

FedimintWallet.ts:18

federation ​

federation: FederationService

Defined in ​

FedimintWallet.ts:21

lightning ​

lightning: LightningService

Defined in ​

FedimintWallet.ts:20

mint ​

mint: MintService

Defined in ​

FedimintWallet.ts:19

recovery ​

recovery: RecoveryService

Defined in ​

FedimintWallet.ts:22

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 ​

FedimintWallet.ts:134

initialize() ​

initialize(): Promise<void>

Returns ​

Promise<void>

Defined in ​

FedimintWallet.ts:85

isOpen() ​

isOpen(): boolean

Returns ​

boolean

Defined in ​

FedimintWallet.ts:140

joinFederation() ​

joinFederation(inviteCode, clientName): Promise<void>

Parameters ​

• inviteCode: string

• clientName: string = DEFAULT_CLIENT_NAME

Returns ​

Promise<void>

Defined in ​

FedimintWallet.ts:110

open() ​

open(clientName): Promise<any>

Parameters ​

• clientName: string = DEFAULT_CLIENT_NAME

Returns ​

Promise<any>

Defined in ​

FedimintWallet.ts:96

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 ​

FedimintWallet.ts:148

waitForOpen() ​

waitForOpen(): Promise<null | void>

Returns ​

Promise<null | void>

Defined in ​

FedimintWallet.ts:91