multi: pass UpdateAddHtlc message custom records to invoice modifier

Author: ffranr

contractcourt/htlc_incoming_contest_resolver.go

@@ -308,7 +308,7 @@ func (h *htlcIncomingContestResolver) Resolve(
 
 		resolution, err := h.Registry.NotifyExitHopHtlc(
 			h.htlc.RHash, h.htlc.Amt, h.htlcExpiry, currentHeight,
-			circuitKey, hodlQueue.ChanIn(), payload,
+			circuitKey, hodlQueue.ChanIn(), nil, payload,
 		)
 		if err != nil {
 			return nil, err

contractcourt/interfaces.go

@@ -30,6 +30,7 @@ type Registry interface {
 	NotifyExitHopHtlc(payHash lntypes.Hash, paidAmount lnwire.MilliSatoshi,
 		expiry uint32, currentHeight int32,
 		circuitKey models.CircuitKey, hodlChan chan<- interface{},
+		wireCustomRecords lnwire.CustomRecords,
 		payload invoices.Payload) (invoices.HtlcResolution, error)
 
 	// HodlUnsubscribeAll unsubscribes from all htlc resolutions.

contractcourt/mock_registry_test.go

@@ -26,6 +26,7 @@ type mockRegistry struct {
 func (r *mockRegistry) NotifyExitHopHtlc(payHash lntypes.Hash,
 	paidAmount lnwire.MilliSatoshi, expiry uint32, currentHeight int32,
 	circuitKey models.CircuitKey, hodlChan chan<- interface{},
+	wireCustomRecords lnwire.CustomRecords,
 	payload invoices.Payload) (invoices.HtlcResolution, error) {
 
 	r.notifyChan <- notifyExitHopData{

htlcswitch/interfaces.go

@@ -32,6 +32,7 @@ type InvoiceDatabase interface {
 	NotifyExitHopHtlc(payHash lntypes.Hash, paidAmount lnwire.MilliSatoshi,
 		expiry uint32, currentHeight int32,
 		circuitKey models.CircuitKey, hodlChan chan<- interface{},
+		wireCustomRecords lnwire.CustomRecords,
 		payload invoices.Payload) (invoices.HtlcResolution, error)
 
 	// CancelInvoice attempts to cancel the invoice corresponding to the

htlcswitch/link.go

@@ -3584,7 +3584,7 @@ func (l *channelLink) processExitHop(pd *lnwallet.PaymentDescriptor,
 
 	event, err := l.cfg.Registry.NotifyExitHopHtlc(
 		invoiceHash, pd.Amount, pd.Timeout, int32(heightNow),
-		circuitKey, l.hodlQueue.ChanIn(), payload,
+		circuitKey, l.hodlQueue.ChanIn(), pd.CustomRecords, payload,
 	)
 	if err != nil {
 		return err

htlcswitch/mock.go

@@ -1046,11 +1046,12 @@ func (i *mockInvoiceRegistry) SettleHodlInvoice(
 func (i *mockInvoiceRegistry) NotifyExitHopHtlc(rhash lntypes.Hash,
 	amt lnwire.MilliSatoshi, expiry uint32, currentHeight int32,
 	circuitKey models.CircuitKey, hodlChan chan<- interface{},
+	wireCustomRecords lnwire.CustomRecords,
 	payload invoices.Payload) (invoices.HtlcResolution, error) {
 
 	event, err := i.registry.NotifyExitHopHtlc(
-		rhash, amt, expiry, currentHeight, circuitKey, hodlChan,
-		payload,
+		rhash, amt, expiry, currentHeight, circuitKey,
+		hodlChan, wireCustomRecords, payload,
 	)
 	if err != nil {
 		return nil, err

invoices/invoiceregistry.go

@@ -892,6 +892,7 @@ func (i *InvoiceRegistry) processAMP(ctx invoiceUpdateCtx) error {
 func (i *InvoiceRegistry) NotifyExitHopHtlc(rHash lntypes.Hash,
 	amtPaid lnwire.MilliSatoshi, expiry uint32, currentHeight int32,
 	circuitKey CircuitKey, hodlChan chan<- interface{},
+	wireCustomRecords lnwire.CustomRecords,
 	payload Payload) (HtlcResolution, error) {
 
 	// Create the update context containing the relevant details of the
@@ -903,6 +904,7 @@ func (i *InvoiceRegistry) NotifyExitHopHtlc(rHash lntypes.Hash,
 		expiry:               expiry,
 		currentHeight:        currentHeight,
 		finalCltvRejectDelta: i.cfg.FinalCltvRejectDelta,
+		wireCustomRecords:    wireCustomRecords,
 		customRecords:        payload.CustomRecords(),
 		mpp:                  payload.MultiPath(),
 		amp:                  payload.AMPRecord(),
@@ -1007,6 +1009,7 @@ func (i *InvoiceRegistry) notifyExitHopHtlcLocked(
 		// the interceptor's client an opportunity to manipulate the
 		// settlement process.
 		clientReq := HtlcModifyRequest{
+			WireCustomRecords:  ctx.wireCustomRecords,
 			ExitHtlcCircuitKey: ctx.circuitKey,
 			ExitHtlcAmt:        ctx.amtPaid,
 			ExitHtlcExpiry:     ctx.expiry,

invoices/invoiceregistry_test.go

@@ -245,7 +245,8 @@ func testSettleInvoice(t *testing.T,
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value,
 		uint32(testCurrentHeight)+testInvoiceCltvDelta-1,
-		testCurrentHeight, getCircuitKey(10), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(10), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -261,7 +262,7 @@ func testSettleInvoice(t *testing.T,
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
 		testCurrentHeight, getCircuitKey(0), hodlChan,
-		testPayload,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -302,7 +303,8 @@ func testSettleInvoice(t *testing.T,
 	// behaviour after a restart.
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	require.NoError(t, err, "unexpected NotifyExitHopHtlc error")
 	require.NotNil(t, resolution)
@@ -316,7 +318,8 @@ func testSettleInvoice(t *testing.T,
 	// paid invoice that may open up a probe vector.
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid+600, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(1), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(1), hodlChan,
+		nil, testPayload,
 	)
 	require.NoError(t, err, "unexpected NotifyExitHopHtlc error")
 	require.NotNil(t, resolution)
@@ -331,7 +334,8 @@ func testSettleInvoice(t *testing.T,
 	// would have failed if it were the first payment.
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid-600, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(2), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(2), hodlChan,
+		nil, testPayload,
 	)
 	require.NoError(t, err, "unexpected NotifyExitHopHtlc error")
 	require.NotNil(t, resolution)
@@ -468,7 +472,8 @@ func testCancelInvoiceImpl(t *testing.T, gc bool,
 	hodlChan := make(chan interface{})
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoiceAmount, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatal("expected settlement of a canceled invoice to succeed")
@@ -577,7 +582,8 @@ func testSettleHoldInvoice(t *testing.T,
 	// should be possible.
 	resolution, err := registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -589,7 +595,8 @@ func testSettleHoldInvoice(t *testing.T,
 	// Test idempotency.
 	resolution, err = registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -602,7 +609,8 @@ func testSettleHoldInvoice(t *testing.T,
 	// is a replay.
 	resolution, err = registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight+10, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight+10, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -615,7 +623,7 @@ func testSettleHoldInvoice(t *testing.T,
 	// requirement. It should be rejected.
 	resolution, err = registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, 1, testCurrentHeight,
-		getCircuitKey(1), hodlChan, testPayload,
+		getCircuitKey(1), hodlChan, nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -719,7 +727,8 @@ func testCancelHoldInvoice(t *testing.T,
 	// should be possible.
 	resolution, err := registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -741,7 +750,8 @@ func testCancelHoldInvoice(t *testing.T,
 	// accept height.
 	resolution, err = registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amtPaid, testHtlcExpiry,
-		testCurrentHeight+1, getCircuitKey(0), hodlChan, testPayload,
+		testCurrentHeight+1, getCircuitKey(0), hodlChan,
+		nil, testPayload,
 	)
 	if err != nil {
 		t.Fatalf("expected settle to succeed but got %v", err)
@@ -770,7 +780,7 @@ func testUnknownInvoice(t *testing.T,
 	amt := lnwire.MilliSatoshi(100000)
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, amt, testHtlcExpiry, testCurrentHeight,
-		getCircuitKey(0), hodlChan, testPayload,
+		getCircuitKey(0), hodlChan, nil, testPayload,
 	)
 	if err != nil {
 		t.Fatal("unexpected error")
@@ -831,7 +841,7 @@ func testKeySendImpl(t *testing.T, keySendEnabled bool,
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		hash, amt, expiry,
 		testCurrentHeight, getCircuitKey(10), hodlChan,
-		invalidKeySendPayload,
+		nil, invalidKeySendPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -852,8 +862,8 @@ func testKeySendImpl(t *testing.T, keySendEnabled bool,
 	}
 
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
-		hash, amt, expiry,
-		testCurrentHeight, getCircuitKey(10), hodlChan, keySendPayload,
+		hash, amt, expiry, testCurrentHeight, getCircuitKey(10),
+		hodlChan, nil, keySendPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -881,8 +891,8 @@ func testKeySendImpl(t *testing.T, keySendEnabled bool,
 	// Replay the same keysend payment. We expect an identical resolution,
 	// but no event should be generated.
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
-		hash, amt, expiry,
-		testCurrentHeight, getCircuitKey(10), hodlChan, keySendPayload,
+		hash, amt, expiry, testCurrentHeight, getCircuitKey(10),
+		hodlChan, nil, keySendPayload,
 	)
 	require.Nil(t, err)
 	checkSettleResolution(t, resolution, preimage)
@@ -905,8 +915,8 @@ func testKeySendImpl(t *testing.T, keySendEnabled bool,
 	}
 
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
-		hash2, amt, expiry,
-		testCurrentHeight, getCircuitKey(20), hodlChan, keySendPayload2,
+		hash2, amt, expiry, testCurrentHeight, getCircuitKey(20),
+		hodlChan, nil, keySendPayload2,
 	)
 	require.Nil(t, err)
 
@@ -964,8 +974,8 @@ func testHoldKeysendImpl(t *testing.T, timeoutKeysend bool,
 	}
 
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
-		hash, amt, expiry,
-		testCurrentHeight, getCircuitKey(10), hodlChan, keysendPayload,
+		hash, amt, expiry, testCurrentHeight, getCircuitKey(10),
+		hodlChan, nil, keysendPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -1047,8 +1057,8 @@ func testMppPayment(t *testing.T,
 	hodlChan1 := make(chan interface{}, 1)
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2,
-		testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(10), hodlChan1, mppPayload,
+		testHtlcExpiry, testCurrentHeight, getCircuitKey(10),
+		hodlChan1, nil, mppPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -1075,8 +1085,8 @@ func testMppPayment(t *testing.T,
 	hodlChan2 := make(chan interface{}, 1)
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2,
-		testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(11), hodlChan2, mppPayload,
+		testHtlcExpiry, testCurrentHeight, getCircuitKey(11),
+		hodlChan2, nil, mppPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -1089,8 +1099,8 @@ func testMppPayment(t *testing.T,
 	hodlChan3 := make(chan interface{}, 1)
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2,
-		testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(12), hodlChan3, mppPayload,
+		testHtlcExpiry, testCurrentHeight, getCircuitKey(12),
+		hodlChan3, nil, mppPayload,
 	)
 	if err != nil {
 		t.Fatal(err)
@@ -1149,7 +1159,7 @@ func testMppPaymentWithOverpayment(t *testing.T,
 		resolution, err := ctx.registry.NotifyExitHopHtlc(
 			testInvoicePaymentHash, testInvoice.Terms.Value/2,
 			testHtlcExpiry, testCurrentHeight, getCircuitKey(11),
-			hodlChan1, mppPayload,
+			hodlChan1, nil, mppPayload,
 		)
 		if err != nil {
 			t.Fatal(err)
@@ -1164,7 +1174,7 @@ func testMppPaymentWithOverpayment(t *testing.T,
 			testInvoicePaymentHash,
 			testInvoice.Terms.Value/2+overpayment, testHtlcExpiry,
 			testCurrentHeight, getCircuitKey(12), hodlChan2,
-			mppPayload,
+			nil, mppPayload,
 		)
 		if err != nil {
 			t.Fatal(err)
@@ -1449,7 +1459,7 @@ func testHeightExpiryWithRegistryImpl(t *testing.T, numParts int, settle bool,
 		resolution, err := ctx.registry.NotifyExitHopHtlc(
 			testInvoicePaymentHash, htlcAmt, expiry,
 			testCurrentHeight, getCircuitKey(uint64(i)), hodlChan,
-			payLoad,
+			nil, payLoad,
 		)
 		require.NoError(t, err)
 		require.Nil(t, resolution, "did not expect direct resolution")
@@ -1551,8 +1561,8 @@ func testMultipleSetHeightExpiry(t *testing.T,
 	hodlChan1 := make(chan interface{}, 1)
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2,
-		testHtlcExpiry,
-		testCurrentHeight, getCircuitKey(10), hodlChan1, mppPayload,
+		testHtlcExpiry, testCurrentHeight, getCircuitKey(10),
+		hodlChan1, nil, mppPayload,
 	)
 	require.NoError(t, err)
 	require.Nil(t, resolution, "did not expect direct resolution")
@@ -1581,7 +1591,8 @@ func testMultipleSetHeightExpiry(t *testing.T,
 	hodlChan2 := make(chan interface{}, 1)
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2, expiry,
-		testCurrentHeight, getCircuitKey(11), hodlChan2, mppPayload,
+		testCurrentHeight, getCircuitKey(11), hodlChan2,
+		nil, mppPayload,
 	)
 	require.NoError(t, err)
 	require.Nil(t, resolution, "did not expect direct resolution")
@@ -1590,7 +1601,8 @@ func testMultipleSetHeightExpiry(t *testing.T,
 	hodlChan3 := make(chan interface{}, 1)
 	resolution, err = ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, testInvoice.Terms.Value/2, expiry,
-		testCurrentHeight, getCircuitKey(12), hodlChan3, mppPayload,
+		testCurrentHeight, getCircuitKey(12), hodlChan3,
+		nil, mppPayload,
 	)
 	require.NoError(t, err)
 	require.Nil(t, resolution, "did not expect direct resolution")
@@ -1695,7 +1707,8 @@ func testSettleInvoicePaymentAddrRequired(t *testing.T,
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
 		testInvoicePaymentHash, invoice.Terms.Value,
 		uint32(testCurrentHeight)+testInvoiceCltvDelta-1,
-		testCurrentHeight, getCircuitKey(10), hodlChan, testPayload,
+		testCurrentHeight, getCircuitKey(10), hodlChan,
+		nil, testPayload,
 	)
 	require.NoError(t, err)
 
@@ -1784,9 +1797,9 @@ func testSettleInvoicePaymentAddrRequiredOptionalGrace(t *testing.T,
 	// no problem as we should allow these existing invoices to be settled.
 	hodlChan := make(chan interface{}, 1)
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
-		testInvoicePaymentHash, testInvoiceAmount,
-		testHtlcExpiry, testCurrentHeight,
-		getCircuitKey(10), hodlChan, testPayload,
+		testInvoicePaymentHash, testInvoiceAmount, testHtlcExpiry,
+		testCurrentHeight, getCircuitKey(10), hodlChan,
+		nil, testPayload,
 	)
 	require.NoError(t, err)
 
@@ -1848,8 +1861,8 @@ func testAMPWithoutMPPPayload(t *testing.T,
 
 	hodlChan := make(chan interface{}, 1)
 	resolution, err := ctx.registry.NotifyExitHopHtlc(
-		lntypes.Hash{}, shardAmt, expiry,
-		testCurrentHeight, getCircuitKey(uint64(10)), hodlChan,
+		lntypes.Hash{}, shardAmt, expiry, testCurrentHeight,
+		getCircuitKey(uint64(10)), hodlChan, nil,
 		payload,
 	)
 	require.NoError(t, err)
@@ -2017,8 +2030,8 @@ func testSpontaneousAmpPaymentImpl(
 		}
 
 		resolution, err := ctx.registry.NotifyExitHopHtlc(
-			child.Hash, shardAmt, expiry,
-			testCurrentHeight, getCircuitKey(uint64(i)), hodlChan,
+			child.Hash, shardAmt, expiry, testCurrentHeight,
+			getCircuitKey(uint64(i)), hodlChan, nil,
 			payload,
 		)
 		require.NoError(t, err)