Skip to content

Commit

Permalink
Merge #12166: [docs] Clarify -walletdir usage
Browse files Browse the repository at this point in the history
97c3cad [docs] Clarify -walletdir usage (John Newbery)

Pull request description:

  After discussion with @ryanofsky around #11687 , I think this documentation is a bit clearer for how the new `-walletdir` argument works.

Tree-SHA512: f279cab82524dbc0d75e6f9891f0e228ec4c8d0df3e16f351057fa243ddd263ff786f05383fd00a09b89edcc07dab211be5b64387f77271edf8af0177bcf667d
  • Loading branch information
laanwj committed Jan 18, 2018
2 parents 10d10d7 + 97c3cad commit e839d65
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions doc/release-notes.md
Expand Up @@ -75,19 +75,27 @@ There is a checkbox to mark the transaction as final.
The RPC default remains unchanged: to use RBF, launch with `-walletrbf=1` or
use the `replaceable` argument for individual transactions.

Custom wallet directories
---------------------
The ability to specify a directory other than the default data directory in which to store
wallets has been added. An existing directory can be specified using the `-walletdir=<dir>`
argument. Wallets loaded via `-wallet` arguments must be in this wallet directory. Care should be taken
when choosing a wallet directory location, as if it becomes unavailable during operation,
funds may be lost.

Default wallet directory change
--------------------------
On new installations (if the data directory doesn't exist), wallets will now be stored in a
new `wallets/` subdirectory inside the data directory. If this `wallets/` subdirectory
doesn't exist (i.e. on existing nodes), the current datadir root is used instead, as it was.
Wallets directory configuration (`-walletdir`)
----------------------------------------------

Bitcoin Core now has more flexibility in where the wallets directory can be
located. Previously wallet database files were stored at the top level of the
bitcoin data directory. The behavior is now:

- For new installations (where the data directory doesn't already exist),
wallets will now be stored in a new `wallets/` subdirectory inside the data
directory by default.
- For existing nodes (where the data directory already exists), wallets will be
stored in the data directory root by default. If a `wallets/` subdirectory
already exists in the data directory root, then wallets will be stored in the
`wallets/` subdirectory by default.
- The location of the wallets directory can be overridden by specifying a
`-walletdir=<path>` option where `<path>` can be an absolute path or a
relative path (relative to the current working directory). `<path>` can
also be a path to symlink to a directory.

Care should be taken when choosing the wallets directory location, as if it
becomes unavailable during operation, funds may be lost.

Low-level RPC changes
----------------------
Expand Down

0 comments on commit e839d65

Please sign in to comment.