From 85defc3ec39de5e3100e9a0ba45d10dcc364dbc2 Mon Sep 17 00:00:00 2001
From: Olaoluwa Osuntokun <laolu32@gmail.com>
Date: Thu, 8 Dec 2016 18:29:55 -0800
Subject: [PATCH] lnwallet: add new method IsSynced to the WalletController
 interface
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This commit adds a new method to the WalletController interface:
IsSynced. The role of the function is to query the local wallet about
if it thinks it has fully synced to the tip of the current main chain.
This function can be useful within U.I’s to block off certain
functionality until the wallet is fully synced to the main chain.
---
 lnwallet/btcwallet/btcwallet.go | 37 +++++++++++++++++++++++++++++++++
 lnwallet/interface.go           |  8 +++++--
 2 files changed, 43 insertions(+), 2 deletions(-)

diff --git a/lnwallet/btcwallet/btcwallet.go b/lnwallet/btcwallet/btcwallet.go
index 215e8c20..e41d5fb8 100644
--- a/lnwallet/btcwallet/btcwallet.go
+++ b/lnwallet/btcwallet/btcwallet.go
@@ -6,6 +6,7 @@ import (
 	"fmt"
 	"math"
 	"sync"
+	"time"
 
 	"github.com/lightningnetwork/lnd/lnwallet"
 	"github.com/roasbeef/btcd/btcec"
@@ -610,3 +611,39 @@ func (b *BtcWallet) SubscribeTransactions() (lnwallet.TransactionSubscription, e
 
 	return txClient, nil
 }
+
+// IsSynced returns a boolean indicating if from the PoV of the wallet,
+// it has fully synced to the current best block in the main chain.
+//
+// This is a part of the WalletController interface.
+func (b *BtcWallet) IsSynced() (bool, error) {
+	// Grab the best chain state the wallet is currently aware of.
+	syncState := b.wallet.Manager.SyncedTo()
+
+	// Next, query the btcd node to grab the info about the tip of the main
+	// chain.
+	bestHash, bestHeight, err := b.rpc.GetBestBlock()
+	if err != nil {
+		return false, err
+	}
+
+	// If the wallet hasn't yet fully synced to the node's best chain tip,
+	// then we're not yet fully synced.
+	if syncState.Height < bestHeight {
+		return false, nil
+	}
+
+	// If the wallet is on par with the current best chain tip, then we
+	// still may not yet be synced as the btcd node may still be catching
+	// up to the main chain. So we'll grab the block header in order to
+	// make a guess based on the current time stamp.
+	blockHeader, err := b.rpc.GetBlockHeader(bestHash)
+	if err != nil {
+		return false, err
+	}
+
+	// If the timestamp no the best header is more than 2 hours in the
+	// past, then we're not yet synced.
+	minus24Hours := time.Now().Add(-2 * time.Hour)
+	return !blockHeader.Timestamp.Before(minus24Hours), nil
+}
diff --git a/lnwallet/interface.go b/lnwallet/interface.go
index 8ffc49a2..6a114f3b 100644
--- a/lnwallet/interface.go
+++ b/lnwallet/interface.go
@@ -174,13 +174,17 @@ type WalletController interface {
 	// related to the wallet are seen within the network, or found in
 	// blocks.
 	//
-	// NOTE: a non-nil error shuold be returned if notifications aren't
+	// NOTE: a non-nil error should be returned if notifications aren't
 	// supported.
 	//
 	// TODO(roasbeef): make distinct interface?
 	SubscribeTransactions() (TransactionSubscription, error)
 
-	// Start initializes the wallet, making any neccessary connections,
+	// IsSynced returns a boolean indicating if from the PoV of the wallet,
+	// it has fully synced to the current best block in the main chain.
+	IsSynced() (bool, error)
+
+	// Start initializes the wallet, making any necessary connections,
 	// starting up required goroutines etc.
 	Start() error