MWEB Light Client

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"
 	}

blockmanager.go

@@ -18,12 +18,14 @@ import (
 	"github.com/ltcsuite/ltcd/ltcutil"
 	"github.com/ltcsuite/ltcd/ltcutil/gcs"
 	"github.com/ltcsuite/ltcd/ltcutil/gcs/builder"
+	"github.com/ltcsuite/ltcd/ltcutil/mweb"
 	"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/mwebdb"
 	"github.com/ltcsuite/neutrino/query"
 )
 
@@ -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)
+}

cache/go.mod

@@ -2,12 +2,13 @@ module github.com/ltcsuite/neutrino/cache
 
 go 1.18
 
-require github.com/stretchr/testify v1.8.1
+require github.com/stretchr/testify v1.8.3
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/kr/pretty v0.3.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rogpeppe/go-internal v1.12.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
-
-replace github.com/ltcsuite/neutrino/cache => ./cache

cache/go.sum

@@ -1,17 +1,12 @@
-github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/kr/pretty v0.3.0 h1:WgNl7dwNpEZ6jJ9k1snq4pZsg7DOEN8hP9Xw0Tsjwk0=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
-gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
+github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

go.mod

@@ -3,43 +3,15 @@ module github.com/ltcsuite/neutrino
 require (
 	github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f
 	github.com/davecgh/go-spew v1.1.1
-	github.com/ltcsuite/lnd/queue v1.1.0
-	github.com/ltcsuite/ltcd v0.23.5
-	github.com/ltcsuite/ltcd/btcec/v2 v2.3.2
-	github.com/ltcsuite/ltcd/chaincfg/chainhash v1.0.2
-	github.com/ltcsuite/ltcd/ltcutil v1.1.3
-	github.com/ltcsuite/ltcwallet/wallet/txauthor v1.2.3
-	github.com/ltcsuite/ltcwallet/wallet/txrules v1.2.0 // indirect
-	github.com/ltcsuite/ltcwallet/wallet/txsizes v1.2.3 // indirect
-	github.com/ltcsuite/ltcwallet/walletdb v1.3.5
-	github.com/ltcsuite/ltcwallet/wtxmgr v1.5.0
-	github.com/ltcsuite/neutrino/cache v1.1.0
-	github.com/stretchr/testify v1.8.2
+	github.com/stretchr/testify v1.8.3
 )
 
 require (
-	github.com/aead/siphash v1.0.1 // indirect
-	github.com/btcsuite/go-socks v0.0.0-20170105172521-4720035b7bfd // indirect
-	github.com/btcsuite/websocket v0.0.0-20150119174127-31079b680792 // indirect
-	github.com/decred/dcrd/crypto/blake256 v1.0.0 // indirect
-	github.com/decred/dcrd/dcrec/secp256k1/v4 v4.0.1 // indirect
-	github.com/decred/dcrd/lru v1.1.1 // indirect
-	github.com/kkdai/bstream v1.0.0 // indirect
-	github.com/klauspost/cpuid/v2 v2.0.9 // indirect
-	github.com/ltcsuite/lnd/clock v1.1.0 // indirect
-	github.com/ltcsuite/lnd/ticker v1.1.0 // indirect
+	github.com/kr/pretty v0.3.0 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	go.etcd.io/bbolt v1.3.6 // indirect
-	golang.org/x/crypto v0.7.0 // indirect
-	golang.org/x/sys v0.8.0 // indirect
+	github.com/rogpeppe/go-internal v1.12.0 // indirect
+	gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
-	lukechampine.com/blake3 v1.2.1 // indirect
 )
 
 go 1.18
-
-replace github.com/ltcsuite/neutrino/cache => ./cache
-
-replace github.com/ltcsuite/ltcwallet/wallet/txauthor => ../ltcwallet/wallet/txauthor
-
-replace github.com/ltcsuite/ltcwallet/wallet/txsizes => ../ltcwallet/wallet/txsizes