Merge pull request #22 from jimpo/replay-log

Remove DecayedLog and move to lnd.

Author: Roasbeef

batch.go

@@ -10,12 +10,18 @@ var ErrAlreadyCommitted = errors.New("cannot add to batch after committing")
 // the replay log. After construction is completed, it can be added to the log
 // using the PutBatch method.
 type Batch struct {
-	// isCommitted denotes whether or not this batch has been successfully
+	// IsCommitted denotes whether or not this batch has been successfully
 	// written to disk.
-	isCommitted bool
+	IsCommitted bool
 
-	// id is a unique, caller chosen identifier for this batch.
-	id []byte
+	// ID is a unique, caller chosen identifier for this batch.
+	ID []byte
+
+	// ReplaySet contains the sequence numbers of all entries that were
+	// detected as replays. The set is finalized upon writing the batch to
+	// disk, and merges replays detected by the replay cache and on-disk
+	// replay log.
+	ReplaySet *ReplaySet
 
 	// entries stores the set of all potential entries that might get
 	// written to the replay log. Some entries may be skipped after
@@ -26,12 +32,6 @@ type Batch struct {
 	// prefix of entries already added to this batch. This allows a quick
 	// mechanism for intra-batch duplicate detection.
 	replayCache map[HashPrefix]struct{}
-
-	// replaySet contains the sequence numbers of all entries that were
-	// detected as replays. The set is finalized upon writing the batch to
-	// disk, and merges replays detected by the replay cache and on-disk
-	// replay log.
-	replaySet *ReplaySet
 }
 
 // NewBatch initializes an object for constructing a set of entries to
@@ -40,10 +40,10 @@ type Batch struct {
 // idempotent result.
 func NewBatch(id []byte) *Batch {
 	return &Batch{
-		id:          id,
+		ID:          id,
+		ReplaySet:   NewReplaySet(),
 		entries:     make(map[uint16]batchEntry),
 		replayCache: make(map[HashPrefix]struct{}),
-		replaySet:   NewReplaySet(),
 	}
 }
 
@@ -53,14 +53,14 @@ func NewBatch(id []byte) *Batch {
 // is ultimately reported via the batch's ReplaySet after committing to disk.
 func (b *Batch) Put(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error {
 	// Abort if this batch was already written to disk.
-	if b.isCommitted {
+	if b.IsCommitted {
 		return ErrAlreadyCommitted
 	}
 
 	// Check to see if this hash prefix is already included in this batch.
 	// If so, we will opportunistically mark this index as replayed.
 	if _, ok := b.replayCache[*hashPrefix]; ok {
-		b.replaySet.Add(seqNum)
+		b.ReplaySet.Add(seqNum)
 		return nil
 	}
 
@@ -81,6 +81,17 @@ func (b *Batch) Put(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error {
 	return nil
 }
 
+// ForEach iterates through each entry in the batch and calls the provided
+// function with the sequence number and entry contents as arguments.
+func (b *Batch) ForEach(fn func(seqNum uint16, hashPrefix *HashPrefix, cltv uint32) error) error {
+	for seqNum, entry := range b.entries {
+		if err := fn(seqNum, &entry.hashPrefix, entry.cltv); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
 // batchEntry is a tuple of a secret's hash prefix and the corresponding CLTV at
 // which the onion blob from which the secret was derived expires.
 type batchEntry struct {

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))