Static Channel Backup

A static channel backup is automatically saved by the Breez SDK in the background. More specifically, the static backup is updated each time a new channel is opened.

The static channel backup can be used as a last resort to recover funds in case the Greenlight node becomes inaccessible. Recovering the funds is currently not part of the Breez SDK. In order to recover the funds, the user can initialize a new core lightning node with its HSM secret using their seed. Then trigger a channel recovery through the recoverchannel method provided by CLN.

In order to use the recoverchannel method, the user needs to provide the static channel backup file. It can be retrieved from the SDK's working directory as follows:

Rust

let backup_data = BreezServices::static_backup(StaticBackupRequest {
    working_dir: "<working directory>".into(),
})?;

Swift

let backupData = try? staticBackup(req:StaticBackupRequest(workingDir: "<working directory>"))

Kotlin

try {
    val backupData = staticBackup(StaticBackupRequest("<working directory>"))
} catch (e: Exception) {
    // handle error
}

React Native

const backupData = await staticBackup({ workingDir: '<working directory>' })

Dart

StaticBackupRequest req = StaticBackupRequest(workingDir: workingDir);
StaticBackupResponse resp = await BreezSDK().staticBackup(req: req);

Python

req = breez_sdk.StaticBackupRequest(working_dir=working_dir)
backup_data = breez_sdk.static_backup(req)

workingDir := "<working directory>"
if staticBackupResponse, err := breez_sdk.StaticBackup(breez_sdk.StaticBackupRequest{WorkingDir: workingDir}); err == nil {
    log.Printf("%#v", staticBackupResponse)
}

try
{
    var backupData = BreezSdkMethods.StaticBackup(
        new StaticBackupRequest("<working directory>"));
}
catch (Exception)
{
    // Handle error
}