itest: add coverage for experimental endorsement

Author: carlaKC

itest/list_on_test.go

@@ -642,4 +642,8 @@ var allTestCases = []*lntest.TestCase{
 		Name:     "sweep commit output and anchor",
 		TestFunc: testSweepCommitOutputAndAnchor,
 	},
+	{
+		Name:     "experimental endorsement",
+		TestFunc: testExperimentalEndorsement,
+	},
 }

itest/lnd_experimental_endorsement.go

@@ -0,0 +1,124 @@
+package itest
+
+import (
+	"math"
+
+	"github.com/btcsuite/btcd/btcutil"
+	"github.com/lightningnetwork/lnd/lnrpc"
+	"github.com/lightningnetwork/lnd/lnrpc/routerrpc"
+	"github.com/lightningnetwork/lnd/lntest"
+	"github.com/lightningnetwork/lnd/lntest/rpc"
+	"github.com/lightningnetwork/lnd/lntest/wait"
+	"github.com/lightningnetwork/lnd/lntypes"
+	"github.com/lightningnetwork/lnd/lnwire"
+	"github.com/stretchr/testify/require"
+)
+
+// testExperimentalEndorsement tests setting of positive and negative
+// experimental endorsement signals.
+func testExperimentalEndorsement(ht *lntest.HarnessTest) {
+	testEndorsement(ht, true)
+	testEndorsement(ht, false)
+}
+
+// testEndorsement sets up a 5 hop network and tests propagation of
+// experimental endorsement signals.
+func testEndorsement(ht *lntest.HarnessTest, aliceEndorse bool) {
+	alice, bob := ht.Alice, ht.Bob
+	carol := ht.NewNode(
+		"carol", []string{"--protocol.no-experimental-endorsement"},
+	)
+	dave := ht.NewNode("dave", nil)
+	eve := ht.NewNode("eve", nil)
+
+	ht.EnsureConnected(alice, bob)
+	ht.EnsureConnected(bob, carol)
+	ht.EnsureConnected(carol, dave)
+	ht.EnsureConnected(dave, eve)
+
+	ht.FundCoins(btcutil.SatoshiPerBitcoin, carol)
+	ht.FundCoins(btcutil.SatoshiPerBitcoin, dave)
+	// Open and wait for channels.
+	const chanAmt = btcutil.Amount(300000)
+	p := lntest.OpenChannelParams{Amt: chanAmt}
+	reqs := []*lntest.OpenChannelRequest{
+		{Local: alice, Remote: bob, Param: p},
+		{Local: bob, Remote: carol, Param: p},
+		{Local: carol, Remote: dave, Param: p},
+		{Local: dave, Remote: eve, Param: p},
+	}
+	resp := ht.OpenMultiChannelsAsync(reqs)
+	cpAB, cpBC, cpCD, cpDE := resp[0], resp[1], resp[2], resp[3]
+
+	// Make sure Alice is aware of Bob=>Carol=>Dave=>Eve channels.
+	ht.AssertTopologyChannelOpen(alice, cpBC)
+	ht.AssertTopologyChannelOpen(alice, cpCD)
+	ht.AssertTopologyChannelOpen(alice, cpDE)
+
+	bobIntercept, cancelBob := bob.RPC.HtlcInterceptor()
+	defer cancelBob()
+
+	carolIntercept, cancelCarol := carol.RPC.HtlcInterceptor()
+	defer cancelCarol()
+
+	daveIntercept, cancelDave := dave.RPC.HtlcInterceptor()
+	defer cancelDave()
+
+	req := &lnrpc.Invoice{ValueMsat: 1000}
+	addResponse := eve.RPC.AddInvoice(req)
+	invoice := eve.RPC.LookupInvoice(addResponse.RHash)
+
+	sendReq := &routerrpc.SendPaymentRequest{
+		PaymentRequest: invoice.PaymentRequest,
+		TimeoutSeconds: int32(wait.PaymentTimeout.Seconds()),
+		FeeLimitMsat:   math.MaxInt64,
+	}
+
+	expectedValue := []byte{0}
+	if aliceEndorse {
+		expectedValue = []byte{7}
+		t := uint64(lnwire.ExperimentalEndorsementType)
+		sendReq.FirstHopCustomRecords = map[uint64][]byte{
+			t: expectedValue,
+		}
+	}
+
+	_ = alice.RPC.SendPayment(sendReq)
+
+	// Validate that our signal (positive or zero) propagates until carol
+	// and then is dropped because she has disabled the feature.
+	validateEndorsedAndResume(ht, bobIntercept, 1, expectedValue)
+	validateEndorsedAndResume(ht, carolIntercept, 1, expectedValue)
+	validateEndorsedAndResume(ht, daveIntercept, 0, nil)
+
+	var preimage lntypes.Preimage
+	copy(preimage[:], invoice.RPreimage)
+	ht.AssertPaymentStatus(alice, preimage, lnrpc.Payment_SUCCEEDED)
+
+	ht.CloseChannel(alice, cpAB)
+	ht.CloseChannel(bob, cpBC)
+	ht.CloseChannel(carol, cpCD)
+}
+
+func validateEndorsedAndResume(ht *lntest.HarnessTest,
+	interceptor rpc.InterceptorClient, expectedRecords int,
+	expectedValue []byte) {
+
+	packet := ht.ReceiveHtlcInterceptor(interceptor)
+
+	require.Len(ht, packet.IncomingHtlcWireCustomRecords, expectedRecords)
+
+	if expectedRecords == 1 {
+		t := uint64(lnwire.ExperimentalEndorsementType)
+		value, ok := packet.IncomingHtlcWireCustomRecords[t]
+		require.True(ht, ok)
+
+		require.Equal(ht, expectedValue, value)
+	}
+
+	err := interceptor.Send(&routerrpc.ForwardHtlcInterceptResponse{
+		IncomingCircuitKey: packet.IncomingCircuitKey,
+		Action:             routerrpc.ResolveHoldForwardAction_RESUME,
+	})
+	require.NoError(ht, err)
+}

itest/lnd_forward_interceptor_test.go

@@ -14,6 +14,7 @@ import (
 	"github.com/lightningnetwork/lnd/lntest/node"
 	"github.com/lightningnetwork/lnd/lntest/wait"
 	"github.com/lightningnetwork/lnd/lntypes"
+	"github.com/lightningnetwork/lnd/lnwire"
 	"github.com/lightningnetwork/lnd/routing/route"
 	"github.com/stretchr/testify/require"
 	"google.golang.org/grpc/codes"
@@ -532,7 +533,8 @@ func testForwardInterceptorWireRecords(ht *lntest.HarnessTest) {
 	// pending payment.
 	packet := ht.ReceiveHtlcInterceptor(bobInterceptor)
 
-	require.Len(ht, packet.IncomingHtlcWireCustomRecords, 1)
+	// We expect the custom record and an endorsement signal.
+	require.Len(ht, packet.IncomingHtlcWireCustomRecords, 2)
 
 	val, ok := packet.IncomingHtlcWireCustomRecords[65537]
 	require.True(ht, ok, "expected custom record")
@@ -549,9 +551,14 @@ func testForwardInterceptorWireRecords(ht *lntest.HarnessTest) {
 	require.NoError(ht, err, "failed to send request")
 
 	// Assert that the Alice -> Bob custom records in update_add_htlc are
-	// not propagated on the Bob -> Carol link.
+	// not propagated on the Bob -> Carol link, but we do get our
+	// experimental endorsement signal.
 	packet = ht.ReceiveHtlcInterceptor(carolInterceptor)
-	require.Len(ht, packet.IncomingHtlcWireCustomRecords, 0)
+	require.Len(ht, packet.IncomingHtlcWireCustomRecords, 1)
+
+	t := uint64(lnwire.ExperimentalEndorsementType)
+	_, ok = packet.IncomingHtlcWireCustomRecords[t]
+	require.True(ht, ok)
 
 	// Just resume the payment on Carol.
 	err = carolInterceptor.Send(&routerrpc.ForwardHtlcInterceptResponse{