sphinx: remove unused members of Router

By removing the unused members of the Router, we can remove the network
parameter from NewRouter which will make it easier to instantiate the
Router in other packages.

Author: ellemouton

bench_test.go

@@ -88,8 +88,6 @@ func BenchmarkProcessPacket(b *testing.B) {
 		router := path[0]
 		router.log.Stop()
 		path[0] = &Router{
-			nodeID:   router.nodeID,
-			nodeAddr: router.nodeAddr,
 			onionKey: router.onionKey,
 			log:      NewMemoryReplayLog(),
 		}

cmd/main.go

@@ -9,7 +9,6 @@ import (
 	"os"
 
 	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/btcsuite/btcd/chaincfg"
 	sphinx "github.com/lightningnetwork/lightning-onion"
 	"github.com/urfave/cli"
 )
@@ -300,7 +299,7 @@ func peel(ctx *cli.Context) error {
 
 	s := sphinx.NewRouter(
 		&sphinx.PrivKeyECDH{PrivKey: sessionKey},
-		&chaincfg.TestNet3Params, sphinx.NewMemoryReplayLog(),
+		sphinx.NewMemoryReplayLog(),
 	)
 	s.Start()
 	defer s.Stop()

path_test.go

@@ -8,7 +8,6 @@ import (
 	"testing"
 
 	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/btcsuite/btcd/chaincfg"
 	"github.com/stretchr/testify/require"
 )
 
@@ -149,8 +148,7 @@ func TestOnionRouteBlinding(t *testing.T) {
 		blindingPoint *btcec.PublicKey) *ProcessedPacket {
 
 		r := NewRouter(
-			&PrivKeyECDH{PrivKey: key}, &chaincfg.MainNetParams,
-			NewMemoryReplayLog(),
+			&PrivKeyECDH{PrivKey: key}, NewMemoryReplayLog(),
 		)
 
 		require.NoError(t, r.Start())

sphinx.go

@@ -9,8 +9,6 @@ import (
 	"sync"
 
 	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/btcsuite/btcd/btcutil"
-	"github.com/btcsuite/btcd/chaincfg"
 )
 
 const (
@@ -484,26 +482,14 @@ type ProcessedPacket struct {
 // of processing incoming Sphinx onion packets thereby "peeling" a layer off
 // the onion encryption which the packet is wrapped with.
 type Router struct {
-	nodeID   [AddressSize]byte
-	nodeAddr *btcutil.AddressPubKeyHash
-
 	onionKey SingleKeyECDH
-
-	log ReplayLog
+	log      ReplayLog
 }
 
 // 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(nodeKey SingleKeyECDH, net *chaincfg.Params, log ReplayLog) *Router {
-	var nodeID [AddressSize]byte
-	copy(nodeID[:], btcutil.Hash160(nodeKey.PubKey().SerializeCompressed()))
-
-	// Safe to ignore the error here, nodeID is 20 bytes.
-	nodeAddr, _ := btcutil.NewAddressPubKeyHash(nodeID[:], net)
-
+func NewRouter(nodeKey SingleKeyECDH, log ReplayLog) *Router {
 	return &Router{
-		nodeID:   nodeID,
-		nodeAddr: nodeAddr,
 		onionKey: nodeKey,
 		log:      log,
 	}

sphinx_test.go

@@ -11,7 +11,6 @@ import (
 	"testing"
 
 	"github.com/btcsuite/btcd/btcec/v2"
-	"github.com/btcsuite/btcd/chaincfg"
 	"github.com/davecgh/go-spew/spew"
 	"github.com/stretchr/testify/require"
 )
@@ -52,8 +51,7 @@ func newTestRoute(numHops int) ([]*Router, *PaymentPath, *[]HopData, *OnionPacke
 		}
 
 		nodes[i] = NewRouter(
-			&PrivKeyECDH{PrivKey: privKey}, &chaincfg.MainNetParams,
-			NewMemoryReplayLog(),
+			&PrivKeyECDH{PrivKey: privKey}, NewMemoryReplayLog(),
 		)
 	}
 
@@ -219,12 +217,7 @@ func TestSphinxCorrectness(t *testing.T) {
 			// The next hop should have been parsed as node[i+1].
 			parsedNextHop := onionPacket.ForwardingInstructions.NextAddress[:]
 			expected := bytes.Repeat([]byte{byte(i)}, AddressSize)
-			if !bytes.Equal(parsedNextHop, expected) {
-				t.Fatalf("Processing error, next hop parsed incorrectly."+
-					" next hop should be %v, was instead parsed as %v",
-					hex.EncodeToString(nodes[i+1].nodeID[:]),
-					hex.EncodeToString(parsedNextHop))
-			}
+			require.Equal(t, expected, parsedNextHop)
 
 			fwdMsg = onionPacket.NextPacket
 		}
@@ -303,14 +296,14 @@ func TestSphinxNodeRelpaySameBatch(t *testing.T) {
 
 	// Allow the node to process the initial packet, this should proceed
 	// without any failures.
-	if err := tx.ProcessOnionPacket(0, fwdMsg, nil, 1, nil); err != nil {
+	if err := tx.ProcessOnionPacket(0, fwdMsg, nil, 1); err != nil {
 		t.Fatalf("unable to process sphinx packet: %v", err)
 	}
 
 	// Now, force the node to process the packet a second time, this call
 	// should not fail, even though the batch has internally recorded this
 	// as a duplicate.
-	err = tx.ProcessOnionPacket(1, fwdMsg, nil, 1, nil)
+	err = tx.ProcessOnionPacket(1, fwdMsg, nil, 1)
 	if err != nil {
 		t.Fatalf("adding duplicate sphinx packet to batch should not "+
 			"result in an error, instead got: %v", err)
@@ -349,7 +342,7 @@ func TestSphinxNodeRelpayLaterBatch(t *testing.T) {
 
 	// Allow the node to process the initial packet, this should proceed
 	// without any failures.
-	err = tx.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1, nil)
+	err = tx.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1)
 	if err != nil {
 		t.Fatalf("unable to process sphinx packet: %v", err)
 	}
@@ -363,7 +356,7 @@ func TestSphinxNodeRelpayLaterBatch(t *testing.T) {
 
 	// Now, force the node to process the packet a second time, this should
 	// fail with a detected replay error.
-	err = tx2.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1, nil)
+	err = tx2.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1)
 	if err != nil {
 		t.Fatalf("sphinx packet replay should not have been rejected, "+
 			"instead error is %v", err)
@@ -395,7 +388,7 @@ func TestSphinxNodeReplayBatchIdempotency(t *testing.T) {
 
 	// Allow the node to process the initial packet, this should proceed
 	// without any failures.
-	err = tx.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1, nil)
+	err = tx.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1)
 	if err != nil {
 		t.Fatalf("unable to process sphinx packet: %v", err)
 	}
@@ -409,7 +402,7 @@ func TestSphinxNodeReplayBatchIdempotency(t *testing.T) {
 
 	// Now, force the node to process the packet a second time, this should
 	// not fail with a detected replay error.
-	err = tx2.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1, nil)
+	err = tx2.ProcessOnionPacket(uint16(0), fwdMsg, nil, 1)
 	if err != nil {
 		t.Fatalf("sphinx packet replay should not have been rejected, "+
 			"instead error is %v", err)
@@ -499,8 +492,7 @@ func newEOBRoute(numHops uint32,
 		}
 
 		nodes[i] = NewRouter(
-			&PrivKeyECDH{PrivKey: privKey}, &chaincfg.MainNetParams,
-			NewMemoryReplayLog(),
+			&PrivKeyECDH{PrivKey: privKey}, NewMemoryReplayLog(),
 		)
 	}