i1722-avoid-wallet-rescan-after-init

src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletActor.scala

@@ -80,7 +80,7 @@ class ErgoWalletActor(settings: ErgoSettings,
     }
   }
 
-  private def emptyWallet: Receive = {
+  private def expectWalletReading: Receive = {
     case ReadWallet(state) =>
       val ws = settings.walletSettings
       // Try to read wallet from json file or test mnemonic provided in a config file
@@ -97,7 +97,7 @@ class ErgoWalletActor(settings: ErgoSettings,
       ergoWalletService.initWallet(state, settings, pass, mnemonicPassOpt) match {
         case Success((mnemonic, newState)) =>
           log.info("Wallet is initialized")
-          context.become(loadedWallet(newState))
+          context.become(loadedWallet(newState.copy(walletState = WalletPhase.Created)))
           self ! UnlockWallet(pass)
           sender() ! Success(mnemonic)
         case Failure(t) =>
@@ -111,7 +111,7 @@ class ErgoWalletActor(settings: ErgoSettings,
       ergoWalletService.restoreWallet(state, settings, mnemonic, mnemonicPassOpt, walletPass) match {
         case Success(newState) =>
           log.info("Wallet is restored")
-          context.become(loadedWallet(newState))
+          context.become(loadedWallet(newState.copy(walletState = WalletPhase.Restored)))
           self ! UnlockWallet(walletPass)
           sender() ! Success(())
         case Failure(t) =>
@@ -265,7 +265,8 @@ class ErgoWalletActor(settings: ErgoSettings,
     case ScanOnChain(newBlock) =>
       if (state.secretIsSet(settings.walletSettings.testMnemonic)) { // scan blocks only if wallet is initialized
         val nextBlockHeight = state.expectedNextBlockHeight(newBlock.height, settings.nodeSettings.isFullBlocksPruned)
-        if (nextBlockHeight == newBlock.height) {
+        // we want to scan a block either when it is its turn or when wallet is freshly created (no need to load the past)
+        if (nextBlockHeight == newBlock.height || (state.walletState == WalletPhase.Created && state.getWalletHeight == 0)) {
           log.info(s"Wallet is going to scan a block ${newBlock.id} on chain at height ${newBlock.height}")
           val newState =
             ergoWalletService.scanBlockUpdate(state, newBlock, settings.walletSettings.dustLimit) match {
@@ -279,7 +280,7 @@ class ErgoWalletActor(settings: ErgoSettings,
           context.become(loadedWallet(newState))
         } else if (nextBlockHeight < newBlock.height) {
           log.warn(s"Wallet: skipped blocks found starting from $nextBlockHeight, going back to scan them")
-          self ! ScanInThePast(nextBlockHeight, false)
+          self ! ScanInThePast(nextBlockHeight, rescan = false)
         } else {
           log.warn(s"Wallet: block in the past reported at ${newBlock.height}, blockId: ${newBlock.id}")
         }
@@ -488,7 +489,7 @@ class ErgoWalletActor(settings: ErgoSettings,
     sender() ! txsToSend
   }
 
-  override def receive: Receive = emptyWallet
+  override def receive: Receive = expectWalletReading
 
   private def wrapLegalExc[T](e: Throwable): Failure[T] =
     if (e.getMessage.startsWith("Illegal key size")) {
@@ -520,6 +521,17 @@ object ErgoWalletActor extends ScorexLogging {
     walletActorRef
   }
 
+  /** Wallet transitions either from Default -> Initialized or Default -> Restored */
+  trait WalletPhase
+  object WalletPhase {
+    /** Wallet is expecting either Creation or Restoration */
+    case object UnInitialized extends WalletPhase
+    /** New wallet initialized with generated mnemonic in this runtime */
+    case object Created extends WalletPhase
+    /** Wallet restored from existing mnemonic in this runtime */
+    case object Restored extends WalletPhase
+  }
+
   // Private signals the wallet actor sends to itself
   /**
     * A signal the wallet actor sends to itself to scan a block in the past

src/main/scala/org/ergoplatform/nodeView/wallet/ErgoWalletState.scala

@@ -6,6 +6,7 @@ import org.ergoplatform._
 import org.ergoplatform.nodeView.history.ErgoHistory.Height
 import org.ergoplatform.nodeView.mempool.ErgoMemPoolReader
 import org.ergoplatform.nodeView.state.{ErgoStateContext, ErgoStateReader, UtxoStateReader}
+import org.ergoplatform.nodeView.wallet.ErgoWalletActor.WalletPhase
 import org.ergoplatform.nodeView.wallet.ErgoWalletState.FilterFn
 import org.ergoplatform.nodeView.wallet.persistence.{OffChainRegistry, WalletRegistry, WalletStorage}
 import org.ergoplatform.settings.{ErgoSettings, Parameters}
@@ -27,6 +28,7 @@ case class ErgoWalletState(
     utxoStateReaderOpt: Option[UtxoStateReader],
     parameters: Parameters,
     maxInputsToUse: Int,
+    walletState: WalletPhase,
     error: Option[String] = None,
     rescanInProgress: Boolean
   ) extends ScorexLogging {
@@ -90,7 +92,11 @@ case class ErgoWalletState(
     }
   }
 
-  // Read a box from UTXO set if the node has it, otherwise, from the wallet
+  /**
+    * Read a box from UTXO set if the node has it, otherwise, from the wallet
+    * @param boxId of the box to read
+    * @return maybe ErgoBox
+    */
   def readBoxFromUtxoWithWalletFallback(boxId: BoxId): Option[ErgoBox] = {
     utxoStateReaderOpt match {
       case Some(utxoReader) =>
@@ -100,7 +106,10 @@ case class ErgoWalletState(
     }
   }
 
-  // expected height of a next block when the wallet is receiving a new block with the height blockHeight
+  /** Get expected height of a next block when the wallet is receiving a new block with the height blockHeight
+    * @param blockHeight height of the block being currently received
+    * @param isFullBlocksPruned whether node has all the full blocks and applies them sequentially
+    */
   def expectedNextBlockHeight(blockHeight: Height, isFullBlocksPruned: Boolean): Height = {
     val walletHeight = getWalletHeight
     if (!isFullBlocksPruned) {
@@ -153,6 +162,7 @@ object ErgoWalletState {
         utxoStateReaderOpt = None,
         parameters,
         maxInputsToUse,
+        walletState = WalletPhase.UnInitialized,
         rescanInProgress = false
       )
     }

src/test/scala/org/ergoplatform/nodeView/wallet/ErgoWalletServiceSpec.scala

@@ -5,6 +5,7 @@ import org.ergoplatform._
 import org.ergoplatform.db.DBSpec
 import org.ergoplatform.modifiers.mempool.{ErgoTransaction, UnconfirmedTransaction}
 import org.ergoplatform.nodeView.mempool.ErgoMemPoolReader
+import org.ergoplatform.nodeView.wallet.ErgoWalletActor.WalletPhase
 import org.ergoplatform.nodeView.wallet.WalletScanLogic.ScanResults
 import org.ergoplatform.nodeView.wallet.persistence.{OffChainRegistry, WalletRegistry, WalletStorage}
 import org.ergoplatform.nodeView.wallet.requests.{AssetIssueRequest, PaymentRequest}
@@ -20,6 +21,7 @@ import org.ergoplatform.wallet.boxes.{ErgoBoxSerializer, ReplaceCompactCollectBo
 import org.ergoplatform.wallet.crypto.ErgoSignature
 import org.ergoplatform.wallet.mnemonic.Mnemonic
 import org.ergoplatform.wallet.secrets.ExtendedSecretKey
+import org.ergoplatform.wallet.utils.FileUtils
 import org.scalacheck.Gen
 import org.scalatest.BeforeAndAfterAll
 import scorex.db.{LDBKVStore, LDBVersionedStore}
@@ -37,6 +39,7 @@ class ErgoWalletServiceSpec
     with ErgoWalletSupport
     with ErgoTransactionGenerators
     with DBSpec
+    with FileUtils
     with BeforeAndAfterAll {
 
   override val ergoSettings: ErgoSettings = settings
@@ -61,6 +64,7 @@ class ErgoWalletServiceSpec
       utxoStateReaderOpt = Option.empty,
       parameters,
       maxInputsToUse = 1000,
+      walletState = WalletPhase.UnInitialized,
       rescanInProgress = false
     )
   }
@@ -292,6 +296,8 @@ class ErgoWalletServiceSpec
   property("it should lock/unlock wallet") {
     withVersionedStore(2) { versionedStore =>
       withStore { store =>
+        deleteRecursive(WalletStorage.storageFolder(settings))
+        deleteRecursive(WalletRegistry.registryFolder(settings))
         val walletState = initialState(store, versionedStore)
         val walletService = new ErgoWalletServiceImpl(settings)
         val pass = Random.nextString(10)