doc/multiwallet-qt.md

   1 Multiwallet Qt Development and Integration Strategy
   2 ===================================================
   3
   4 In order to support loading of multiple wallets in bitcoin-qt, a few changes in the UI architecture will be needed.
   5 Fortunately, only four of the files in the existing project are affected by this change.
   6
   7 Two new classes have been implemented in two new .h/.cpp file pairs, with much of the functionality that was previously
   8 implemented in the BitcoinGUI class moved over to these new classes.
   9
  10 The two existing files most affected, by far, are bitcoingui.h and bitcoingui.cpp, as the BitcoinGUI class will require
  11 some major retrofitting.
  12
  13 Only requiring some minor changes is bitcoin.cpp.
  14
  15 Finally, two new headers and source files will have to be added to bitcoin-qt.pro.
  16
  17 Changes to class BitcoinGUI
  18 ---------------------------
  19 The principal change to the BitcoinGUI class concerns the QStackedWidget instance called centralWidget.
  20 This widget owns five page views: overviewPage, transactionsPage, addressBookPage, receiveCoinsPage, and sendCoinsPage.
  21
  22 A new class called *WalletView* inheriting from QStackedWidget has been written to handle all renderings and updates of
  23 these page views. In addition to owning these five page views, a WalletView also has a pointer to a WalletModel instance.
  24 This allows the construction of multiple WalletView objects, each rendering a distinct wallet.
  25
  26 A second class called *WalletFrame* inheriting from QFrame has been written as a container for embedding all wallet-related
  27 controls into BitcoinGUI. At present it contains the WalletView instances for the wallets and does little more than passing on messages
  28 from BitcoinGUI to the currently selected WalletView. It is a WalletFrame instance
  29 that takes the place of what used to be centralWidget in BitcoinGUI. The purpose of this class is to allow future
  30 refinements of the wallet controls with minimal need for further modifications to BitcoinGUI, thus greatly simplifying
  31 merges while reducing the risk of breaking top-level stuff.
  32
  33 Changes to bitcoin.cpp
  34 ----------------------
  35 bitcoin.cpp is the entry point into bitcoin-qt, and as such, will require some minor modifications to provide hooks for
  36 multiple wallet support. Most importantly will be the way it instantiates WalletModels and passes them to the
  37 singleton BitcoinGUI instance called window. Formerly, BitcoinGUI kept a pointer to a single instance of a WalletModel.
  38 The initial change required is very simple: rather than calling `window.setWalletModel(&walletModel);` we perform the
  39 following two steps:
  40
  41         window.addWallet("~Default", &walletModel);
  42         window.setCurrentWallet("~Default");
  43
  44 The string parameter is just an arbitrary name given to the default wallet. It's been prepended with a tilde to avoid name collisions in the future with additional wallets.
  45
  46 The shutdown call `window.setWalletModel(0)` has also been removed. In its place is now:
  47
  48 window.removeAllWallets();