(android) Backup channels and payments db #561
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Android 12 has brought additional features to the backup mechanism and uses a different xml file. Also, instead of uploading the database files, we will upload an encrypted file that contains the database. This should be easier to do than a custom BackupAgent.
When restoring a wallet, the user can now restore a backup file if one is available to recover the payments history. This is done manually, by browsing the device's file system and selecting a file. The file is then decrypted, read, and the payments database it contains are restored in the phoenix internal db directory. This step is optional and can be skipped. If there already is a payments db in the internal db directory, this step is skipped automatically when restoring a wallet (will typically happen because of the cloud backup mechanism provided by google drive).
For now we'll keep the backup file local.
dpad85
force-pushed
the
android-local-backup
branch
from
9fa1634 to
63835f1
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a local, on-device backup mechanism for the payments and channels database, for Android. It will allow users to restore their payments history after uninstalling or resetting the wallet.
The channels and payments database are zipped and encrypted on disk in public folder. This backup file will not be erased when the app is uninstalled, and can thus can be restored manually when the user imports their wallet again in the future. It does not require new permissions, since we are using the Mediastore API to write the file, and importing the backup file is done manually by the user, using the Android file browsing framework.
This encrypted file can also be backed up using the auto Google Drive backup system, if available and enabled, which would avoid having to manually restore the local backup file.
This PR and description is a WIP.