INDY-925: Reworked wallet migration mechanism (hyperledger#437)

* INDY-925: Client migration for multi-network

- Removed client migration actions which had become useless.

Signed-off-by: Nikita Spivachuk <[email protected]>

* INDY-925: Reworked wallet migration mechanism

- Reworked the wallet migration mechanism to be able to process nested wallets.

Signed-off-by: Nikita Spivachuk <[email protected]>

Author: spivachuk

ledger/genesis_txn/genesis_txn_file_util.py

@@ -13,13 +13,6 @@ def genesis_txn_path(base_dir, transaction_file):
     return os.path.join(base_dir, genesis_txn_file(transaction_file))
 
 
-def update_genesis_txn_file_name_if_outdated(base_dir, transaction_file):
-    old_named_path = os.path.join(base_dir, transaction_file)
-    new_named_path = os.path.join(base_dir, genesis_txn_file(transaction_file))
-    if not os.path.exists(new_named_path) and os.path.isfile(old_named_path):
-        os.rename(old_named_path, new_named_path)
-
-
 def create_genesis_txn_init_ledger(data_dir, txn_file):
     from ledger.genesis_txn.genesis_txn_initiator_from_file import GenesisTxnInitiatorFromFile
     initiator = GenesisTxnInitiatorFromFile(data_dir, txn_file)

plenum/cli/cli.py

@@ -7,8 +7,7 @@
 
 from jsonpickle import json
 from ledger.compact_merkle_tree import CompactMerkleTree
-from ledger.genesis_txn.genesis_txn_file_util import create_genesis_txn_init_ledger, \
-    update_genesis_txn_file_name_if_outdated
+from ledger.genesis_txn.genesis_txn_file_util import create_genesis_txn_init_ledger
 from ledger.genesis_txn.genesis_txn_initiator_from_file import GenesisTxnInitiatorFromFile
 from ledger.ledger import Ledger
 from plenum.cli.command import helpCmd, statusNodeCmd, statusClientCmd, \
@@ -69,7 +68,7 @@
     firstValue, randomString, bootstrapClientKeys, \
     getFriendlyIdentifier, \
     normalizedWalletFileName, getWalletFilePath, \
-    getLastSavedWalletFileName, updateWalletsBaseDirNameIfOutdated
+    getLastSavedWalletFileName
 from stp_core.common.log import \
     getlogger, Logger
 from plenum.server.node import Node
@@ -259,8 +258,6 @@ def __init__(self, looper, basedirpath: str, ledger_base_dir: str, nodeReg=None,
         tp = loadPlugins(self.basedirpath)
         self.logger.debug("total plugins loaded in cli: {}".format(tp))
 
-        updateWalletsBaseDirNameIfOutdated(self.config)
-
         self.restoreLastActiveWallet()
 
         self.checkIfCmdHandlerAndCmdMappingExists()

plenum/client/pool_manager.py

@@ -1,8 +1,6 @@
 import collections
 import json
 
-from ledger.genesis_txn.genesis_txn_file_util import \
-    update_genesis_txn_file_name_if_outdated
 from ledger.util import F
 from stp_core.network.exceptions import RemoteNotFound
 
@@ -25,8 +23,6 @@ def __init__(self):
         self._ledgerFile = None
         TxnStackManager.__init__(self, self.name, self.basedirpath,
                                  isNode=False)
-        update_genesis_txn_file_name_if_outdated(self.basedirpath,
-                                                 self.ledgerFile)
         _, cliNodeReg, nodeKeys = self.parseLedgerForHaAndKeys(self.ledger)
         self.nodeReg = cliNodeReg
         self.addRemoteKeysFromLedger(nodeKeys)

plenum/client/wallet.py

@@ -6,9 +6,6 @@
 
 import jsonpickle
 from jsonpickle import JSONBackend
-from jsonpickle import tags
-from jsonpickle.unpickler import loadclass
-from jsonpickle.util import importable_name
 from libnacl import crypto_secretbox_open, randombytes, \
     crypto_secretbox_NONCEBYTES, crypto_secretbox
 from plenum.common.constants import CURRENT_PROTOCOL_VERSION
@@ -41,17 +38,6 @@ def decrypt(self, key) -> 'Wallet':
     ("lastReqId", int)])
 
 
-def getClassVersionKey(cls):
-    """
-    Gets the wallet class version key for use in a serialized representation
-    of the wallet.
-
-    :param cls: the wallet class
-    :return: the class version key
-    """
-    return 'classver/{}'.format(importable_name(cls))
-
-
 class Wallet:
     def __init__(self,
                  name: str=None,
@@ -418,28 +404,21 @@ def loadWallet(self, fpath):
         return wallet
 
 
+WALLET_RAW_MIGRATORS = []
+
+
 class WalletCompatibilityBackend(JSONBackend):
     """
     Jsonpickle backend providing conversion of raw representations
     (nested dictionaries/lists structure) of wallets from previous versions
     to the current version.
     """
 
-    def _getUpToDateClassName(self, pickledClassName):
-        return pickledClassName.replace('sovrin_client', 'indy_client')
-
     def decode(self, string):
         raw = super().decode(string)
         # Note that backend.decode may be called not only for the whole object
         # representation but also for representations of non-string keys of
         # dictionaries.
-        # Here we assume that if the string represents a class instance and
-        # this class contains makeRawCompatible method then this class is
-        # a wallet class supporting backward compatibility
-        if isinstance(raw, dict) and tags.OBJECT in raw:
-            clsName = raw[tags.OBJECT]
-            cls = loadclass(self._getUpToDateClassName(clsName))
-            if hasattr(cls, 'makeRawCompatible') \
-                    and callable(getattr(cls, 'makeRawCompatible')):
-                cls.makeRawCompatible(raw)
+        for migrator in WALLET_RAW_MIGRATORS:
+            migrator(raw)
         return raw

plenum/common/util.py

@@ -560,21 +560,6 @@ def getLastModifiedTime(file):
     return basename(newest)
 
 
-def updateWalletsBaseDirNameIfOutdated(config):
-    """
-    Renames the wallets base directory if it has the outdated name.
-
-    :param config: the application configuration
-    """
-    if config.walletsDir == 'wallets':  # if the parameter is not overridden
-        oldNamedPath = os.path.expanduser(os.path.join(config.baseDir,
-                                                       'keyrings'))
-        newNamedPath = os.path.expanduser(os.path.join(config.baseDir,
-                                                       'wallets'))
-        if not os.path.exists(newNamedPath) and os.path.isdir(oldNamedPath):
-            os.rename(oldNamedPath, newNamedPath)
-
-
 def pop_keys(mapping: Dict, cond: Callable):
     rem = []
     for k in mapping: