User settings
The SDK exposes a set of user settings that are shared across all SDK instances, even from different partners.
Available user settings API docs
The following user settings are available:
- Spark private mode: Spark supports opt-in wallet privacy. When enabled, the wallet's Bitcoin payments and balance will not be accessible through public indexers like Sparkscan. The SDK enables this by default for new wallets, and we highly recommend keeping it enabled. However, some applications may require the wallet to be visible to the public.
Note: Spark private mode only applies to Bitcoin payments. Token payments are not affected by the private mode and will still be publicly available.
Getting the current user settings API docs
Rust
let userSettings = sdk.get_user_settings().await?;
info!("User settings: {:?}", userSettings);Swift
let userSettings = try await sdk.getUserSettings()
print("User settings: \(userSettings)")
Kotlin
try {
val userSettings = sdk.getUserSettings()
println("User settings: $userSettings")
} catch (e: Exception) {
// handle error
}
C#
var userSettings = await sdk.GetUserSettings();
Console.WriteLine($"User settings: {userSettings}");
Javascript
const userSettings = await sdk.getUserSettings()
console.log(`User settings: ${JSON.stringify(userSettings)}`)
React Native
const userSettings = await sdk.getUserSettings()
console.log(`User settings: ${JSON.stringify(userSettings)}`)
Flutter
final userSettings = await sdk.getUserSettings();
print('User settings: $userSettings');
Python
try:
user_settings = await sdk.get_user_settings()
print(f"User settings: {user_settings}")
except Exception as error:
logging.error(error)
raise
Go
userSettings, err := sdk.GetUserSettings()
if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
return err
}
log.Printf("User settings: %v", userSettings)
Updating the user settings API docs
Rust
let sparkPrivateModeEnabled = true;
sdk.update_user_settings(UpdateUserSettingsRequest {
spark_private_mode_enabled: Some(sparkPrivateModeEnabled),
}).await?;Swift
let sparkPrivateModeEnabled = true
try await sdk.updateUserSettings(
request: UpdateUserSettingsRequest(
sparkPrivateModeEnabled: sparkPrivateModeEnabled
))
Kotlin
try {
val sparkPrivateModeEnabled = true
sdk.updateUserSettings(UpdateUserSettingsRequest(sparkPrivateModeEnabled))
} catch (e: Exception) {
// handle error
}
C#
var sparkPrivateModeEnabled = true;
await sdk.UpdateUserSettings(
request: new UpdateUserSettingsRequest(
sparkPrivateModeEnabled: sparkPrivateModeEnabled
)
);
Javascript
const sparkPrivateModeEnabled = true
await sdk.updateUserSettings({
sparkPrivateModeEnabled
})
React Native
const sparkPrivateModeEnabled = true
await sdk.updateUserSettings({
sparkPrivateModeEnabled
})
Flutter
final bool sparkPrivateModeEnabled = true;
await sdk.updateUserSettings(
request: UpdateUserSettingsRequest(
sparkPrivateModeEnabled: sparkPrivateModeEnabled));
Python
try:
spark_private_mode_enabled = True
await sdk.update_user_settings(
request=UpdateUserSettingsRequest(
spark_private_mode_enabled=spark_private_mode_enabled
)
)
except Exception as error:
logging.error(error)
raise
Go
sparkPrivateModeEnabled := true
err := sdk.UpdateUserSettings(breez_sdk_spark.UpdateUserSettingsRequest{
SparkPrivateModeEnabled: &sparkPrivateModeEnabled,
})
if sdkErr := err.(*breez_sdk_spark.SdkError); sdkErr != nil {
return err
}