MWEB Light Client

Makefile

@@ -1,7 +1,7 @@
-PKG := github.com/ltcsuite/neutrino
+PKG := github.com/ltcmweb/neutrino
 TOOLS_DIR := tools
 
-LTCD_PKG := github.com/ltcsuite/ltcd
+LTCD_PKG := github.com/ltcmweb/ltcd
 LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
 GOACC_PKG := github.com/ory/go-acc
 GOIMPORTS_PKG := github.com/rinchsan/gosimports/cmd/gosimports

bamboozle_unit_test.go

@@ -7,14 +7,14 @@ import (
 	"sort"
 	"testing"
 
-	"github.com/ltcsuite/ltcd/chaincfg"
-	"github.com/ltcsuite/ltcd/chaincfg/chainhash"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs/builder"
-	"github.com/ltcsuite/ltcd/txscript"
-	"github.com/ltcsuite/ltcd/wire"
+	"github.com/ltcmweb/ltcd/chaincfg"
+	"github.com/ltcmweb/ltcd/chaincfg/chainhash"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs/builder"
+	"github.com/ltcmweb/ltcd/txscript"
+	"github.com/ltcmweb/ltcd/wire"
+	"github.com/ltcmweb/neutrino/headerfs"
 	"github.com/ltcsuite/ltcwallet/walletdb"
-	"github.com/ltcsuite/neutrino/headerfs"
 )
 
 func decodeHashNoError(str string) *chainhash.Hash {

banman/reason.go

@@ -23,6 +23,14 @@ const (
 
 	// InvalidBlock signals that a peer served us a bad block.
 	InvalidBlock Reason = 5
+
+	// InvalidMwebHeader signals that a peer served us an invalid
+	// mweb header message.
+	InvalidMwebHeader Reason = 20
+
+	// InvalidMwebUtxos signals that a peer served us an invalid
+	// mweb utxos message.
+	InvalidMwebUtxos Reason = 21
 )
 
 // String returns a human-readable description for the reason a peer was banned.
@@ -43,6 +51,12 @@ func (r Reason) String() string {
 	case InvalidBlock:
 		return "peer served an invalid block"
 
+	case InvalidMwebHeader:
+		return "peer served invalid mweb header message"
+
+	case InvalidMwebUtxos:
+		return "peer served invalid mweb utxos message"
+
 	default:
 		return "unknown reason"
 	}

banman/store_test.go

@@ -8,9 +8,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/ltcmweb/neutrino/banman"
 	"github.com/ltcsuite/ltcwallet/walletdb"
 	_ "github.com/ltcsuite/ltcwallet/walletdb/bdb"
-	"github.com/ltcsuite/neutrino/banman"
 )
 
 // createTestBanStore creates a test Store backed by a boltdb instance.

batch_spend_reporter.go

@@ -1,8 +1,8 @@
 package neutrino
 
 import (
-	"github.com/ltcsuite/ltcd/chaincfg/chainhash"
-	"github.com/ltcsuite/ltcd/wire"
+	"github.com/ltcmweb/ltcd/chaincfg/chainhash"
+	"github.com/ltcmweb/ltcd/wire"
 )
 
 // batchSpendReporter orchestrates the delivery of spend reports to

blockmanager.go

@@ -12,19 +12,21 @@ import (
 	"sync/atomic"
 	"time"
 
-	"github.com/ltcsuite/ltcd/blockchain"
-	"github.com/ltcsuite/ltcd/chaincfg"
-	"github.com/ltcsuite/ltcd/chaincfg/chainhash"
-	"github.com/ltcsuite/ltcd/ltcutil"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs/builder"
-	"github.com/ltcsuite/ltcd/wire"
-	"github.com/ltcsuite/neutrino/banman"
-	"github.com/ltcsuite/neutrino/blockntfns"
-	"github.com/ltcsuite/neutrino/chainsync"
-	"github.com/ltcsuite/neutrino/headerfs"
-	"github.com/ltcsuite/neutrino/headerlist"
-	"github.com/ltcsuite/neutrino/query"
+	"github.com/ltcmweb/ltcd/blockchain"
+	"github.com/ltcmweb/ltcd/chaincfg"
+	"github.com/ltcmweb/ltcd/chaincfg/chainhash"
+	"github.com/ltcmweb/ltcd/ltcutil"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs/builder"
+	"github.com/ltcmweb/ltcd/ltcutil/mweb"
+	"github.com/ltcmweb/ltcd/wire"
+	"github.com/ltcmweb/neutrino/banman"
+	"github.com/ltcmweb/neutrino/blockntfns"
+	"github.com/ltcmweb/neutrino/chainsync"
+	"github.com/ltcmweb/neutrino/headerfs"
+	"github.com/ltcmweb/neutrino/headerlist"
+	"github.com/ltcmweb/neutrino/mwebdb"
+	"github.com/ltcmweb/neutrino/query"
 )
 
 const (
@@ -72,6 +74,13 @@ type donePeerMsg struct {
 	peer *ServerPeer
 }
 
+// txMsg packages a bitcoin tx message and the peer it came from together
+// so the block handler has access to that information.
+type txMsg struct {
+	tx   *ltcutil.Tx
+	peer *ServerPeer
+}
+
 // blockManagerCfg holds options and dependencies needed by the blockManager
 // during operation.
 type blockManagerCfg struct {
@@ -86,6 +95,9 @@ type blockManagerCfg struct {
 	// compact filters are persistently stored.
 	RegFilterHeaders *headerfs.FilterHeaderStore
 
+	// MwebCoins is the store where mweb coins are persistently stored.
+	MwebCoins mwebdb.CoinDatabase
+
 	// TimeSource is used to access a time estimate based on the clocks of
 	// the connected peers.
 	TimeSource blockchain.MedianTimeSource
@@ -109,6 +121,8 @@ type blockManagerCfg struct {
 		checkResponse func(sp *ServerPeer, resp wire.Message,
 			quit chan<- struct{}, peerQuit chan<- struct{}),
 		options ...QueryOption)
+
+	mempool *Mempool
 }
 
 // blockManager provides a concurrency safe block manager for handling all
@@ -206,6 +220,12 @@ type blockManager struct { // nolint:maligned
 	minRetargetTimespan int64 // target timespan / adjustment factor
 	maxRetargetTimespan int64 // target timespan * adjustment factor
 	blocksPerRetarget   int32 // target timespan / target time per block
+
+	requestedTxns map[chainhash.Hash]struct{}
+
+	mwebUtxosCallbacksMtx sync.Mutex
+	mwebUtxosCallbacks    []func(*mweb.Leafset, []*wire.MwebNetUtxo)
+	mwebRollbackSignal    *sync.Cond
 }
 
 // newBlockManager returns a new bitcoin block manager.  Use Start to begin
@@ -235,13 +255,15 @@ func newBlockManager(cfg *blockManagerCfg) (*blockManager, error) {
 		blocksPerRetarget:   int32(targetTimespan / targetTimePerBlock),
 		minRetargetTimespan: targetTimespan / adjustmentFactor,
 		maxRetargetTimespan: targetTimespan * adjustmentFactor,
+		requestedTxns:       make(map[chainhash.Hash]struct{}),
 	}
 
 	// Next we'll create the two signals that goroutines will use to wait
 	// on a particular header chain height before starting their normal
 	// duties.
 	bm.newHeadersSignal = sync.NewCond(&bm.newHeadersMtx)
 	bm.newFilterHeadersSignal = sync.NewCond(&bm.newFilterHeadersMtx)
+	bm.mwebRollbackSignal = sync.NewCond(&bm.mwebUtxosCallbacksMtx)
 
 	// We fetch the genesis header to use for verifying the first received
 	// interval.
@@ -290,7 +312,7 @@ func (b *blockManager) Start() {
 	}
 
 	log.Trace("Starting block manager")
-	b.wg.Add(2)
+	b.wg.Add(3)
 	go b.blockHandler()
 	go func() {
 		defer b.wg.Done()
@@ -302,10 +324,12 @@ func (b *blockManager) Start() {
 		select {
 		case <-b.cfg.firstPeerSignal:
 		case <-b.quit:
+			b.wg.Done()
 			return
 		}
 
 		log.Debug("Peer connected, starting cfHandler.")
+		go b.mwebHandler()
 		b.cfHandler()
 	}()
 }
@@ -335,6 +359,7 @@ func (b *blockManager) Stop() error {
 
 			b.newHeadersSignal.Broadcast()
 			b.newFilterHeadersSignal.Broadcast()
+			b.mwebRollbackSignal.Broadcast()
 		}
 	}()
 
@@ -1282,6 +1307,11 @@ func (b *blockManager) rollBackToHeight(height uint32) error {
 		return err
 	}
 
+	err = b.cfg.MwebCoins.PutRollbackHeight(height)
+	if err != nil {
+		return err
+	}
+
 	for uint32(bs.Height) > height {
 		header, headerHeight, err := b.cfg.BlockHeaders.FetchHeader(&bs.Hash)
 		if err != nil {
@@ -1994,6 +2024,9 @@ out:
 			case *invMsg:
 				b.handleInvMsg(msg)
 
+			case *txMsg:
+				b.handleTxMsg(msg)
+
 			case *headersMsg:
 				b.handleHeadersMsg(msg)
 
@@ -2260,13 +2293,51 @@ func (b *blockManager) QueueInv(inv *wire.MsgInv, sp *ServerPeer) {
 	}
 }
 
+// QueueTx adds the passed transaction message and peer to the block handling
+// queue. Responds to the done channel argument after the tx message is
+// processed.
+func (b *blockManager) QueueTx(tx *ltcutil.Tx, sp *ServerPeer) {
+	// No channel handling here because peers do not need to block on inv
+	// messages.
+	if atomic.LoadInt32(&b.shutdown) != 0 {
+		return
+	}
+
+	select {
+	case b.peerChan <- &txMsg{tx: tx, peer: sp}:
+	case <-b.quit:
+		return
+	}
+}
+
 // handleInvMsg handles inv messages from all peers.
 // We examine the inventory advertised by the remote peer and act accordingly.
 func (b *blockManager) handleInvMsg(imsg *invMsg) {
+	invVects := imsg.inv.InvList
+	if b.BlockHeadersSynced() {
+		gdmsg := wire.NewMsgGetData()
+		for _, iv := range invVects {
+			if iv.Type == wire.InvTypeTx {
+				if b.cfg.mempool.HaveTransaction(&iv.Hash) {
+					continue
+				}
+				if _, exists := b.requestedTxns[iv.Hash]; !exists {
+					b.requestedTxns[iv.Hash] = struct{}{}
+					gdmsg.AddInvVect(&wire.InvVect{
+						Type: wire.InvTypeMwebTx,
+						Hash: iv.Hash,
+					})
+				}
+			}
+		}
+		if len(gdmsg.InvList) > 0 {
+			imsg.peer.QueueMessage(gdmsg, nil)
+		}
+	}
+
 	// Attempt to find the final block in the inventory list.  There may
 	// not be one.
 	lastBlock := -1
-	invVects := imsg.inv.InvList
 	for i := len(invVects) - 1; i >= 0; i-- {
 		if invVects[i].Type == wire.InvTypeBlock {
 			lastBlock = i
@@ -2344,6 +2415,17 @@ func (b *blockManager) handleInvMsg(imsg *invMsg) {
 	}
 }
 
+// handleTxMsg handles transaction messages from all peers.
+func (b *blockManager) handleTxMsg(tmsg *txMsg) {
+	txHash := tmsg.tx.Hash()
+	if _, exists := b.requestedTxns[*txHash]; !exists {
+		log.Warnf("Peer %s sent us a transaction we didn't request", tmsg.peer.Addr())
+		return
+	}
+	b.cfg.mempool.AddTransaction(tmsg.tx)
+	delete(b.requestedTxns, *txHash)
+}
+
 // QueueHeaders adds the passed headers message and peer to the block handling
 // queue.
 func (b *blockManager) QueueHeaders(headers *wire.MsgHeaders, sp *ServerPeer) {
@@ -2729,6 +2811,12 @@ func (b *blockManager) handleHeadersMsg(hmsg *headersMsg) {
 	b.headerTipHash = *finalHash
 	b.newHeadersMtx.Unlock()
 	b.newHeadersSignal.Broadcast()
+
+	// Clear the mempool to free up memory. This may mean we might receive
+	// transactions we've previously downloaded but this is rather unlikely.
+	if b.cfg.mempool != nil {
+		b.cfg.mempool.Clear()
+	}
 }
 
 // areHeadersConnected returns true if the passed block headers are connected to
@@ -3044,3 +3132,13 @@ func (l *lightHeaderCtx) RelativeAncestorCtx(
 		ancestorHeight, ancestor, l.store, l.headerList,
 	)
 }
+
+// RegisterMwebUtxosCallback will register a callback that will fire when
+// new mweb utxos are received.
+func (b *blockManager) RegisterMwebUtxosCallback(
+	onMwebUtxos func(*mweb.Leafset, []*wire.MwebNetUtxo)) {
+
+	b.mwebUtxosCallbacksMtx.Lock()
+	defer b.mwebUtxosCallbacksMtx.Unlock()
+	b.mwebUtxosCallbacks = append(b.mwebUtxosCallbacks, onMwebUtxos)
+}

blockmanager_test.go

@@ -9,20 +9,20 @@ import (
 	"testing"
 	"time"
 
-	"github.com/ltcsuite/ltcd/blockchain"
-	"github.com/ltcsuite/ltcd/chaincfg"
-	"github.com/ltcsuite/ltcd/chaincfg/chainhash"
-	"github.com/ltcsuite/ltcd/integration/rpctest"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs"
-	"github.com/ltcsuite/ltcd/ltcutil/gcs/builder"
-	"github.com/ltcsuite/ltcd/peer"
-	"github.com/ltcsuite/ltcd/txscript"
-	"github.com/ltcsuite/ltcd/wire"
+	"github.com/ltcmweb/ltcd/blockchain"
+	"github.com/ltcmweb/ltcd/chaincfg"
+	"github.com/ltcmweb/ltcd/chaincfg/chainhash"
+	"github.com/ltcmweb/ltcd/integration/rpctest"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs"
+	"github.com/ltcmweb/ltcd/ltcutil/gcs/builder"
+	"github.com/ltcmweb/ltcd/peer"
+	"github.com/ltcmweb/ltcd/txscript"
+	"github.com/ltcmweb/ltcd/wire"
+	"github.com/ltcmweb/neutrino/banman"
+	"github.com/ltcmweb/neutrino/blockntfns"
+	"github.com/ltcmweb/neutrino/headerfs"
+	"github.com/ltcmweb/neutrino/query"
 	"github.com/ltcsuite/ltcwallet/walletdb"
-	"github.com/ltcsuite/neutrino/banman"
-	"github.com/ltcsuite/neutrino/blockntfns"
-	"github.com/ltcsuite/neutrino/headerfs"
-	"github.com/ltcsuite/neutrino/query"
 	"github.com/stretchr/testify/require"
 )
 

blockntfns/manager_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 	"time"
 
-	"github.com/ltcsuite/ltcd/wire"
-	"github.com/ltcsuite/neutrino/blockntfns"
+	"github.com/ltcmweb/ltcd/wire"
+	"github.com/ltcmweb/neutrino/blockntfns"
 )
 
 var emptyHeader wire.BlockHeader

blockntfns/notification.go

@@ -3,7 +3,7 @@ package blockntfns
 import (
 	"fmt"
 
-	"github.com/ltcsuite/ltcd/wire"
+	"github.com/ltcmweb/ltcd/wire"
 )
 
 // BlockNtfn is an interface that coalesces all the different types of block