docs(storage): document plaintext save caveat on WalletStore.Save
The password parameter accepts null, which saves the wallet in plaintext. The XML doc comment now makes explicit that this is only acceptable when the user has explicitly opted out of encryption with a UI warning shown.
This commit is contained in:
1 parent
2ddc0f920c
commit
5d061c6f21
1 file changed
+2
@@ -25,6 +25,8 @@ public static class WalletStore
|
||||
return WalletDocument.FromJson(content);
|
||||
}
|
||||
|
||||
/// <param name="password">Null saves in plaintext. Only omit when the user has
|
||||
/// explicitly opted out of encryption (UI must show a clear warning).</param>
|
||||
public static void Save(WalletDocument doc, string path, string? password = null)
|
||||
{
|
||||
var content = doc.ToJson();
|
||||
|
||||
Reference in new issue
Block a user