wallet backup instructions

doc/wallet-backup.md

@@ -0,0 +1,85 @@
+# Wallet Backup Instructions
+
+## Overview
+
+Backing up your Zcash private keys is the best way to be proactive about preventing loss of access to your ZEC.
+
+Problems resulting from bugs in the code, user error, device failure, etc. may lead to losing access to your wallet (and as a result, the private keys of addresses which are required to spend from them).
+
+No matter what the cause of a corrupted or lost wallet could be, we highly recommend all users backup on a regular basis. Anytime a new address in the wallet is generated, we recommending making a new backup so all private keys for addresses in your wallet are safe.
+
+Note that a backup is a duplicate of data needed to spend ZEC so where you keep your backup(s) is another important consideration. You should not store backups where they would be equally or increasingly susceptible to loss or theft. 
+
+## Instructions for backing up your wallet and/or private keys
+
+These instructions are specific for the officially supported Zcash Linux client. For backing up with third-party wallets, please consult with user guides or support channels provided for those services.
+
+There are multiple ways to make sure you have at least one other copy of the private keys needed to spend ZEC and view shielded ZEC.
+
+For all methods, you will need to include an export directory setting in your config file (`zcash.conf` located in the data directory which is `~/.zcash/` unless it's been overridden with `datadir=` setting):
+
+`exportdir=/path/to/chosen/export/directory`
+
+You may chose any directory as the location for export & backup files. If the directory doesn't exist, it will be created.
+
+### Using `backupwallet`
+
+To create a backup of your wallet, use:
+
+`zcash-cli backupwallet <nameofbackup>`.
+
+The backup will be an exact copy of the current state of your wallet.dat file stored in the export directory you specified in the config file. The file path will also be returned.
+
+If you generate a new Zcash address, it will not be included in the backup file.
+
+If your original `wallet.dat` file becomes inaccessible for whatever reason, you can use your backup by placing it into your data directory and renaming it to `wallet.dat`.
+
+### Using `z_exportwallet` & `z_importwallet`
+
+If you prefer to have an export of your private keys in human readable format, you can use:
+
+`zcash-cli z_exportwallet <nameofbackup>`
+
+This will generate a text file in the export directory with all transparent and shielded private keys with their associated public addresses. It will also return the file path.
+
+To import keys into a wallet which were previously exported to a file, use:
+
+`zcash-cli z_importwallet <nameofbackup>`
+
+### Using `z_exportkey`, `z_importkey`, `dumpprivkey` & `importprivkey`
+
+If you prefer to export a single private key for a shielded address, you can use:
+
+`zcash-cli z_exportkey <z-address>`
+
+This will return the private key and will not create a new file.
+
+For exporting a single private key for a transparent address, you can use the command inherited from Bitcoin:
+
+`zcash-cli dumpprivkey <t-address>`
+
+This will return the private key and will not create a new file.
+
+To import a private key for a shielded address, use:
+
+`zcash-cli z_importkey <z-priv-key>`
+
+This will add the key to your wallet and rescan the wallet for associated transactions if it is not already part of the wallet.
+
+See the command's help documentation for instructions on fine-tuning the wallet rescan:
+
+`zcash-cli help z_importkey`
+
+To import a private key for a transparent address, use:
+
+`zcash-cli importprivkey <t-priv-key>`
+
+This has the same functionality as `z_importkey` but works with transparent addresses.
+
+See the command's help documentation for instructions on fine-tuning the wallet rescan:
+
+`zcash-cli help importprivkey`
+
+### Using `dumpwallet`
+
+This command inherited from Bitcoin is depreciated. If you use it, they will export private keys in a similar fashion as `z_exportwallet` but only for transparent addresses.