Change NewRouter to have ReplayLog parameter.

This decouples the construction of the Router from the implementation
of the ReplayLog. Also changes all tests to use MemoryReplayLog
instead of DecayedReplayLog.

Author: Jim Posen

bench_test.go

@@ -61,7 +61,7 @@ func BenchmarkProcessPacket(b *testing.B) {
 	}
 	b.ReportAllocs()
 	path[0].log.Start()
-	defer shutdown("0", path[0].log)
+	defer path[0].log.Stop()
 	b.StartTimer()
 
 	var (
@@ -75,12 +75,12 @@ func BenchmarkProcessPacket(b *testing.B) {
 
 		b.StopTimer()
 		router := path[0]
-		shutdown("0", router.log)
+		router.log.Stop()
 		path[0] = &Router{
 			nodeID:   router.nodeID,
 			nodeAddr: router.nodeAddr,
 			onionKey: router.onionKey,
-			log:      NewDecayedLog("0", nil),
+			log:      NewMemoryReplayLog(),
 		}
 		path[0].log.Start()
 		b.StartTimer()

cmd/main.go

@@ -22,12 +22,6 @@ func main() {
 
 	assocData := bytes.Repeat([]byte{'B'}, 32)
 
-	tempDir, err := ioutil.TempDir("", "onion-test")
-	defer os.Remove(tempDir)
-	if err != nil {
-		panic(err)
-	}
-
 	if len(args) == 1 {
 		fmt.Printf("Usage: %s (generate|decode) <private-keys>\n", args[0])
 	} else if args[1] == "generate" {
@@ -85,7 +79,8 @@ func main() {
 		}
 
 		privkey, _ := btcec.PrivKeyFromBytes(btcec.S256(), binKey)
-		s := sphinx.NewRouter(tempDir, privkey, &chaincfg.TestNet3Params, nil)
+		s := sphinx.NewRouter(privkey, &chaincfg.TestNet3Params,
+			sphinx.NewMemoryReplayLog())
 
 		var packet sphinx.OnionPacket
 		err = packet.Decode(bytes.NewBuffer(binMsg))

decayedlog_test.go

@@ -1,6 +1,7 @@
 package sphinx
 
 import (
+	"os"
 	"testing"
 	"time"
 
@@ -99,6 +100,13 @@ func startup(notifier bool) (ReplayLog, *mockNotifier, *HashPrefix, error) {
 	return log, chainNotifier, hashedSecret, nil
 }
 
+// shutdown deletes the temporary directory that the test database uses
+// and handles closing the database.
+func shutdown(dir string, d ReplayLog) {
+	d.Stop()
+	os.RemoveAll(dir)
+}
+
 // TestDecayedLogGarbageCollector tests the ability of the garbage collector
 // to delete expired cltv values every time a block is received. Expired cltv
 // values are cltv values that are < current block height.

replaylog.go

@@ -7,7 +7,7 @@ import (
 
 const (
 	// HashPrefixSize is the size in bytes of the keys we will be storing
-	// in the DecayedLog. It represents the first 20 bytes of a truncated
+	// in the ReplayLog. It represents the first 20 bytes of a truncated
 	// sha-256 hash of a secret generated by ECDH.
 	HashPrefixSize = 20
 )

sphinx.go

@@ -11,7 +11,6 @@ import (
 	"math/big"
 
 	"github.com/aead/chacha20"
-	"github.com/lightningnetwork/lnd/chainntnfs"
 	"github.com/roasbeef/btcd/btcec"
 	"github.com/roasbeef/btcd/chaincfg"
 	"github.com/roasbeef/btcutil"
@@ -631,8 +630,8 @@ type Router struct {
 
 // NewRouter creates a new instance of a Sphinx onion Router given the node's
 // currently advertised onion private key, and the target Bitcoin network.
-func NewRouter(dbPath string, nodeKey *btcec.PrivateKey, net *chaincfg.Params,
-	chainNotifier chainntnfs.ChainNotifier) *Router {
+func NewRouter(nodeKey *btcec.PrivateKey, net *chaincfg.Params, log ReplayLog,
+) *Router {
 	var nodeID [addressSize]byte
 	copy(nodeID[:], btcutil.Hash160(nodeKey.PubKey().SerializeCompressed()))
 
@@ -650,19 +649,17 @@ func NewRouter(dbPath string, nodeKey *btcec.PrivateKey, net *chaincfg.Params,
 			},
 			D: nodeKey.D,
 		},
-		// TODO(roasbeef): replace instead with bloom filter?
-		// * https://moderncrypto.org/mail-archive/messaging/2015/001911.html
-		log: NewDecayedLog(dbPath, chainNotifier),
+		log: log,
 	}
 }
 
-// Start starts / opens the DecayedLog's channeldb and its accompanying
+// Start starts / opens the ReplayLog's channeldb and its accompanying
 // garbage collector goroutine.
 func (r *Router) Start() error {
 	return r.log.Start()
 }
 
-// Stop stops / closes the DecayedLog's channeldb and its accompanying
+// Stop stops / closes the ReplayLog's channeldb and its accompanying
 // garbage collector goroutine.
 func (r *Router) Stop() {
 	r.log.Stop()

sphinx_test.go

@@ -4,9 +4,7 @@ import (
 	"bytes"
 	"encoding/hex"
 	"fmt"
-	"os"
 	"reflect"
-	"strconv"
 	"testing"
 
 	"github.com/davecgh/go-spew/spew"
@@ -99,9 +97,8 @@ func newTestRoute(numHops int) ([]*Router, *[]HopData, *OnionPacket, error) {
 				" random key for sphinx node: %v", err)
 		}
 
-		dbPath := strconv.Itoa(i)
-
-		nodes[i] = NewRouter(dbPath, privKey, &chaincfg.MainNetParams, nil)
+		nodes[i] = NewRouter(privKey, &chaincfg.MainNetParams,
+			NewMemoryReplayLog())
 	}
 
 	// Gather all the pub keys in the path.
@@ -181,13 +178,6 @@ func TestBolt4Packet(t *testing.T) {
 	}
 }
 
-// shutdown deletes the temporary directory that the test database uses
-// and handles closing the database.
-func shutdown(dir string, d ReplayLog) {
-	d.Stop()
-	os.RemoveAll(dir)
-}
-
 func TestSphinxCorrectness(t *testing.T) {
 	nodes, hopDatas, fwdMsg, err := newTestRoute(NumMaxHops)
 	if err != nil {
@@ -197,10 +187,9 @@ func TestSphinxCorrectness(t *testing.T) {
 	// Now simulate the message propagating through the mix net eventually
 	// reaching the final destination.
 	for i := 0; i < len(nodes); i++ {
-		// Start each node's DecayedLog and defer shutdown
-		tempDir := strconv.Itoa(i)
+		// Start each node's ReplayLog and defer shutdown
 		nodes[i].log.Start()
-		defer shutdown(tempDir, nodes[i].log)
+		defer nodes[i].log.Stop()
 
 		hop := nodes[i]
 
@@ -262,9 +251,9 @@ func TestSphinxSingleHop(t *testing.T) {
 		t.Fatalf("unable to create test route: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	// Simulating a direct single-hop payment, send the sphinx packet to
 	// the destination node, making it process the packet fully.
@@ -289,9 +278,9 @@ func TestSphinxNodeRelpay(t *testing.T) {
 		t.Fatalf("unable to create test route: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	// Allow the node to process the initial packet, this should proceed
 	// without any failures.
@@ -314,9 +303,9 @@ func TestSphinxNodeRelpaySameBatch(t *testing.T) {
 		t.Fatalf("unable to create test route: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	tx := nodes[0].BeginTxn([]byte("0"), 2)
 
@@ -360,9 +349,9 @@ func TestSphinxNodeRelpayLaterBatch(t *testing.T) {
 		t.Fatalf("unable to create test route: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	tx := nodes[0].BeginTxn([]byte("0"), 1)
 
@@ -397,17 +386,17 @@ func TestSphinxNodeRelpayLaterBatch(t *testing.T) {
 	}
 }
 
-func TestSphinxNodeRelpayBatchIdempotency(t *testing.T) {
+func TestSphinxNodeReplayBatchIdempotency(t *testing.T) {
 	// We'd like to ensure that the sphinx node itself rejects all replayed
 	// packets which share the same shared secret.
 	nodes, _, fwdMsg, err := newTestRoute(NumMaxHops)
 	if err != nil {
 		t.Fatalf("unable to create test route: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	tx := nodes[0].BeginTxn([]byte("0"), 1)
 
@@ -456,9 +445,9 @@ func TestSphinxAssocData(t *testing.T) {
 		t.Fatalf("unable to create random onion packet: %v", err)
 	}
 
-	// Start the DecayedLog and defer shutdown
+	// Start the ReplayLog and defer shutdown
 	nodes[0].log.Start()
-	defer shutdown("0", nodes[0].log)
+	defer nodes[0].log.Stop()
 
 	_, err = nodes[0].ProcessOnionPacket(fwdMsg, []byte("somethingelse"), 1)
 	if err == nil {