From b76be736b83bec79ead3e650daead31aef45da41 Mon Sep 17 00:00:00 2001
From: Chris Stewart <stewart.chris1234@gmail.com>
Date: Thu, 7 Jan 2021 07:40:30 -0600
Subject: [PATCH] Rename wallet.getSyncHeight() ->
 wallet.getSyncDescriptorOpt(). We don't just use height in the descriptor,
 the hash is just as valuable for connecting to chains (#2479)

---
 .../scala/org/bitcoins/server/BitcoindRpcBackendUtil.scala  | 2 +-
 .../scala/org/bitcoins/wallet/BitcoindBackendTest.scala     | 2 +-
 .../test/scala/org/bitcoins/wallet/ProcessBlockTest.scala   | 6 +++---
 wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala      | 4 ++--
 .../bitcoins/wallet/models/WalletStateDescriptorDAO.scala   | 4 ++--
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/app/server/src/main/scala/org/bitcoins/server/BitcoindRpcBackendUtil.scala b/app/server/src/main/scala/org/bitcoins/server/BitcoindRpcBackendUtil.scala
index e04d1f591b..444b767773 100644
--- a/app/server/src/main/scala/org/bitcoins/server/BitcoindRpcBackendUtil.scala
+++ b/app/server/src/main/scala/org/bitcoins/server/BitcoindRpcBackendUtil.scala
@@ -54,7 +54,7 @@ object BitcoindRpcBackendUtil extends BitcoinSLogger {
 
     for {
       bitcoindHeight <- bitcoind.getBlockCount
-      walletStateOpt <- wallet.getSyncHeight()
+      walletStateOpt <- wallet.getSyncDescriptorOpt()
       _ <- walletStateOpt match {
         case None =>
           for {
diff --git a/wallet-test/src/test/scala/org/bitcoins/wallet/BitcoindBackendTest.scala b/wallet-test/src/test/scala/org/bitcoins/wallet/BitcoindBackendTest.scala
index e2475300c3..a1fae26d83 100644
--- a/wallet-test/src/test/scala/org/bitcoins/wallet/BitcoindBackendTest.scala
+++ b/wallet-test/src/test/scala/org/bitcoins/wallet/BitcoindBackendTest.scala
@@ -72,7 +72,7 @@ class BitcoindBackendTest extends BitcoinSAsyncTest with EmbeddedPg {
 
       height <- bitcoind.getBlockCount
       bestHash <- bitcoind.getBestBlockHash
-      syncHeightOpt <- wallet.getSyncHeight()
+      syncHeightOpt <- wallet.getSyncDescriptorOpt()
     } yield {
       assert(balance == amountToSend)
       assert(syncHeightOpt.contains(SyncHeightDescriptor(bestHash, height)))
diff --git a/wallet-test/src/test/scala/org/bitcoins/wallet/ProcessBlockTest.scala b/wallet-test/src/test/scala/org/bitcoins/wallet/ProcessBlockTest.scala
index 82fa6c5ba1..b1d7393a44 100644
--- a/wallet-test/src/test/scala/org/bitcoins/wallet/ProcessBlockTest.scala
+++ b/wallet-test/src/test/scala/org/bitcoins/wallet/ProcessBlockTest.scala
@@ -35,7 +35,7 @@ class ProcessBlockTest extends BitcoinSWalletTest {
 
       height <- bitcoind.getBlockCount
       bestHash <- bitcoind.getBestBlockHash
-      syncHeightOpt <- wallet.getSyncHeight()
+      syncHeightOpt <- wallet.getSyncDescriptorOpt()
     } yield {
       assert(utxos.size == 1)
       assert(utxos.head.output.scriptPubKey == addr.scriptPubKey)
@@ -63,7 +63,7 @@ class ProcessBlockTest extends BitcoinSWalletTest {
 
       height <- bitcoind.getBlockCount
       bestHash <- bitcoind.getBestBlockHash
-      syncHeightOpt <- wallet.getSyncHeight()
+      syncHeightOpt <- wallet.getSyncDescriptorOpt()
     } yield {
       assert(utxos.size == 100)
       assert(balance == Bitcoins(50))
@@ -91,7 +91,7 @@ class ProcessBlockTest extends BitcoinSWalletTest {
 
       height <- bitcoind.getBlockCount
       bestHash <- bitcoind.getBestBlockHash
-      syncHeightOpt <- wallet.getSyncHeight()
+      syncHeightOpt <- wallet.getSyncDescriptorOpt()
     } yield {
       assert(utxos.size == 100)
       assert(balance == Bitcoins(50))
diff --git a/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala b/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala
index 4a5ceffcf5..5839331650 100644
--- a/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala
+++ b/wallet/src/main/scala/org/bitcoins/wallet/Wallet.scala
@@ -157,8 +157,8 @@ abstract class Wallet
     }
   }
 
-  def getSyncHeight(): Future[Option[SyncHeightDescriptor]] = {
-    stateDescriptorDAO.getSyncHeightOpt()
+  def getSyncDescriptorOpt(): Future[Option[SyncHeightDescriptor]] = {
+    stateDescriptorDAO.getSyncDescriptorOpt()
   }
 
   override def processCompactFilters(
diff --git a/wallet/src/main/scala/org/bitcoins/wallet/models/WalletStateDescriptorDAO.scala b/wallet/src/main/scala/org/bitcoins/wallet/models/WalletStateDescriptorDAO.scala
index a278ffd6ba..fea4c2c83e 100644
--- a/wallet/src/main/scala/org/bitcoins/wallet/models/WalletStateDescriptorDAO.scala
+++ b/wallet/src/main/scala/org/bitcoins/wallet/models/WalletStateDescriptorDAO.scala
@@ -55,7 +55,7 @@ case class WalletStateDescriptorDAO()(implicit
     Seq] =
     findByPrimaryKeys(ts.map(_.tpe))
 
-  def getSyncHeightOpt(): Future[Option[SyncHeightDescriptor]] = {
+  def getSyncDescriptorOpt(): Future[Option[SyncHeightDescriptor]] = {
     read(SyncHeight).map {
       case Some(db) =>
         val desc = SyncHeightDescriptor.fromString(db.descriptor.toString)
@@ -67,7 +67,7 @@ case class WalletStateDescriptorDAO()(implicit
   def updateSyncHeight(
       hash: DoubleSha256DigestBE,
       height: Int): Future[WalletStateDescriptorDb] = {
-    getSyncHeightOpt().flatMap {
+    getSyncDescriptorOpt().flatMap {
       case Some(old) =>
         if (old.height > height) {
           Future.successful(WalletStateDescriptorDb(SyncHeight, old))