WalletSaveStateProvider
Midnight.js API Reference v2.0.2
Midnight.js API Reference / @midnight-ntwrk/midnight-js-testing / WalletSaveStateProvider
Class: WalletSaveStateProvider
Provider class for saving and loading wallet state to/from compressed files
Constructorsβ
Constructorβ
new WalletSaveStateProvider(
logger,seed,directoryPath?,filename?):WalletSaveStateProvider
Creates a new WalletSaveStateProvider instance
Parametersβ
loggerβ
Logger
Logger instance for recording operations
seedβ
string
directoryPath?β
string = DEFAULT_WALLET_STATE_DIRECTORY
Directory path for wallet state files
filename?β
string = ...
Filename for the wallet state file
Returnsβ
WalletSaveStateProvider
Propertiesβ
directoryPathβ
directoryPath:
string
Absolute path to the directory containing wallet state files
filePathβ
filePath:
string
Full path including filename for the wallet state file
loggerβ
logger:
Logger
Logger instance for recording operations
Methodsβ
load()β
load():
Promise<string>
Loads and decompresses the wallet state from a file
Returnsβ
Promise<string>
A promise that resolves with the decompressed wallet state as a string
Throwsβ
If there is an error reading or decompressing the file
save()β
save(
wallet):Promise<void>
Saves the wallet state to a compressed file
Parametersβ
walletβ
Wallet
The wallet instance to save state from
Returnsβ
Promise<void>
A promise that resolves when the save is complete