15155511119

Committed 21 May 2025 06:52AM UTC coverage: 57.389% (-11.6%) from 68.996%

Build # 15155511119

Build Type

Pull #9844

github

Committed by

web-flow

Commit Message

Merge 8658c8597 into c52a6ddeb

Pull Request Pull Request #9844: Refactor Payment PR 3

Run Details

346 of 493 new or added lines in 4 files covered. (70.18%)

30172 existing lines in 456 files now uncovered.

95441 of 166305 relevant lines covered (57.39%)

0.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.86

/invoices/update.go

package invoices

import (
        "bytes"
        "encoding/hex"
        "errors"

        "github.com/btcsuite/btcd/chaincfg/chainhash"
        "github.com/lightningnetwork/lnd/amp"
        "github.com/lightningnetwork/lnd/lntypes"
        "github.com/lightningnetwork/lnd/lnwire"
        "github.com/lightningnetwork/lnd/record"
)

// invoiceUpdateCtx is an object that describes the context for the invoice
// update to be carried out.
type invoiceUpdateCtx struct {
        hash                 lntypes.Hash
        circuitKey           CircuitKey
        amtPaid              lnwire.MilliSatoshi
        expiry               uint32
        currentHeight        int32
        finalCltvRejectDelta int32

        // wireCustomRecords are the custom records that were included with the
        // HTLC wire message.
        wireCustomRecords lnwire.CustomRecords

        // customRecords is a map of custom records that were included with the
        // HTLC onion payload.
        customRecords record.CustomSet

        mpp          *record.MPP
        amp          *record.AMP
        metadata     []byte
        pathID       *chainhash.Hash
        totalAmtMsat lnwire.MilliSatoshi
}

// invoiceRef returns an identifier that can be used to lookup or update the
// invoice this HTLC is targeting.
func (i *invoiceUpdateCtx) invoiceRef() InvoiceRef {
        switch {
        case i.pathID != nil:
                return InvoiceRefByHashAndAddr(i.hash, *i.pathID)

        case i.amp != nil && i.mpp != nil:
                payAddr := i.mpp.PaymentAddr()
                return InvoiceRefByAddr(payAddr)

        case i.mpp != nil:
                payAddr := i.mpp.PaymentAddr()
                return InvoiceRefByHashAndAddr(i.hash, payAddr)

        default:
                return InvoiceRefByHash(i.hash)
        }
}

// setID returns an identifier that identifies other possible HTLCs that this
// particular one is related to. If nil is returned this means the HTLC is an
// MPP or legacy payment, otherwise the HTLC belongs AMP payment.
func (i invoiceUpdateCtx) setID() *[32]byte {
        if i.amp != nil {
                setID := i.amp.SetID()
                return &setID
        }
        return nil
}

// log logs a message specific to this update context.
func (i *invoiceUpdateCtx) log(s string) {
        // Don't use %x in the log statement below, because it doesn't
        // distinguish between nil and empty metadata.
        metadata := "<nil>"
        if i.metadata != nil {
                metadata = hex.EncodeToString(i.metadata)
        }

        log.Debugf("Invoice%v: %v, amt=%v, expiry=%v, circuit=%v, mpp=%v, "+
                "amp=%v, metadata=%v", i.invoiceRef(), s, i.amtPaid, i.expiry,
                i.circuitKey, i.mpp, i.amp, metadata)
}

// failRes is a helper function which creates a failure resolution with
// the information contained in the invoiceUpdateCtx and the fail resolution
// result provided.
func (i invoiceUpdateCtx) failRes(outcome FailResolutionResult) *HtlcFailResolution {
        return NewFailResolution(i.circuitKey, i.currentHeight, outcome)
}

// settleRes is a helper function which creates a settle resolution with
// the information contained in the invoiceUpdateCtx and the preimage and
// the settle resolution result provided.
func (i invoiceUpdateCtx) settleRes(preimage lntypes.Preimage,
        outcome SettleResolutionResult) *HtlcSettleResolution {

        return NewSettleResolution(
                preimage, i.circuitKey, i.currentHeight, outcome,
        )
}

// acceptRes is a helper function which creates an accept resolution with
// the information contained in the invoiceUpdateCtx and the accept resolution
// result provided.
func (i invoiceUpdateCtx) acceptRes(
        outcome acceptResolutionResult) *htlcAcceptResolution {

        return newAcceptResolution(i.circuitKey, outcome)
}

// resolveReplayedHtlc returns the HTLC resolution for a replayed HTLC. The
// returned boolean indicates whether the HTLC was replayed or not.
func resolveReplayedHtlc(ctx *invoiceUpdateCtx, inv *Invoice) (bool,
        HtlcResolution, error) {

        // Don't update the invoice when this is a replayed htlc.
        htlc, replayedHTLC := inv.Htlcs[ctx.circuitKey]
        if !replayedHTLC {
                return false, nil, nil
        }

        switch htlc.State {
        case HtlcStateCanceled:
                return true, ctx.failRes(ResultReplayToCanceled), nil

        case HtlcStateAccepted:
                return true, ctx.acceptRes(resultReplayToAccepted), nil

        case HtlcStateSettled:
                pre := inv.Terms.PaymentPreimage

                // Terms.PaymentPreimage will be nil for AMP invoices.
                // Set it to the HTLCs AMP Preimage instead.
                if pre == nil {
                        pre = htlc.AMP.Preimage
                }

                return true, ctx.settleRes(
                        *pre,
                        ResultReplayToSettled,
                ), nil

        default:
                return true, nil, errors.New("unknown htlc state")
        }
}

// updateInvoice is a callback for DB.UpdateInvoice that contains the invoice
// settlement logic. It returns a HTLC resolution that indicates what the
// outcome of the update was.
//
// NOTE: Make sure replayed HTLCs are always considered before calling this
// function.
func updateInvoice(ctx *invoiceUpdateCtx, inv *Invoice) (
        *InvoiceUpdateDesc, HtlcResolution, error) {

        // If no MPP payload was provided, then we expect this to be a keysend,
        // or a payment to an invoice created before we started to require the
        // MPP payload.
        if ctx.mpp == nil && ctx.pathID == nil {
                return updateLegacy(ctx, inv)
        }

        return updateMpp(ctx, inv)
}

// updateMpp is a callback for DB.UpdateInvoice that contains the invoice
// settlement logic for mpp payments.
func updateMpp(ctx *invoiceUpdateCtx, inv *Invoice) (*InvoiceUpdateDesc,
        HtlcResolution, error) {

        // Reject HTLCs to AMP invoices if they are missing an AMP payload, and
        // HTLCs to MPP invoices if they have an AMP payload.
        switch {
        case inv.Terms.Features.RequiresFeature(lnwire.AMPRequired) &&
                ctx.amp == nil:

                return nil, ctx.failRes(ResultHtlcInvoiceTypeMismatch), nil

        case !inv.Terms.Features.RequiresFeature(lnwire.AMPRequired) &&
                ctx.amp != nil:

                return nil, ctx.failRes(ResultHtlcInvoiceTypeMismatch), nil
        }

        setID := ctx.setID()

        var (
                totalAmt    = ctx.totalAmtMsat
                paymentAddr []byte
        )
        // If an MPP record is present, then the payment address and total
        // payment amount is extracted from it. Otherwise, the pathID is used
        // to extract the payment address.
        if ctx.mpp != nil {
                totalAmt = ctx.mpp.TotalMsat()
                payAddr := ctx.mpp.PaymentAddr()
                paymentAddr = payAddr[:]
        } else {
                paymentAddr = ctx.pathID[:]
        }

        // For storage, we don't really care where the custom records came from.
        // So we merge them together and store them in the same field.
        customRecords := lnwire.CustomRecords(
                ctx.customRecords,
        ).MergedCopy(ctx.wireCustomRecords)

        // Start building the accept descriptor.
        acceptDesc := &HtlcAcceptDesc{
                Amt:           ctx.amtPaid,
                Expiry:        ctx.expiry,
                AcceptHeight:  ctx.currentHeight,
                MppTotalAmt:   totalAmt,
                CustomRecords: record.CustomSet(customRecords),
        }

        if ctx.amp != nil {
                acceptDesc.AMP = &InvoiceHtlcAMPData{
                        Record:   *ctx.amp,
                        Hash:     ctx.hash,
                        Preimage: nil,
                }
        }

        // Only accept payments to open invoices. This behaviour differs from
        // non-mpp payments that are accepted even after the invoice is settled.
        // Because non-mpp payments don't have a payment address, this is needed
        // to thwart probing.
        if inv.State != ContractOpen {
                return nil, ctx.failRes(ResultInvoiceNotOpen), nil
        }

        // Check the payment address that authorizes the payment.
        if !bytes.Equal(paymentAddr, inv.Terms.PaymentAddr[:]) {
                return nil, ctx.failRes(ResultAddressMismatch), nil
        }

        // Don't accept zero-valued sets.
        if totalAmt == 0 {
                return nil, ctx.failRes(ResultHtlcSetTotalTooLow), nil
        }

        // Check that the total amt of the htlc set is high enough. In case this
        // is a zero-valued invoice, it will always be enough.
        if totalAmt < inv.Terms.Value {
                return nil, ctx.failRes(ResultHtlcSetTotalTooLow), nil
        }

        htlcSet := inv.HTLCSet(setID, HtlcStateAccepted)

        // Check whether total amt matches other HTLCs in the set.
        var newSetTotal lnwire.MilliSatoshi
        for _, htlc := range htlcSet {
                if totalAmt != htlc.MppTotalAmt {
                        return nil, ctx.failRes(ResultHtlcSetTotalMismatch), nil
                }

                newSetTotal += htlc.Amt
        }

        // Add amount of new htlc.
        newSetTotal += ctx.amtPaid

        // The invoice is still open. Check the expiry.
        if ctx.expiry < uint32(ctx.currentHeight+ctx.finalCltvRejectDelta) {
                return nil, ctx.failRes(ResultExpiryTooSoon), nil
        }

        if ctx.expiry < uint32(ctx.currentHeight+inv.Terms.FinalCltvDelta) {
                return nil, ctx.failRes(ResultExpiryTooSoon), nil
        }

        if setID != nil && *setID == BlankPayAddr {
                return nil, ctx.failRes(ResultAmpError), nil
        }

        // Record HTLC in the invoice database.
        newHtlcs := map[CircuitKey]*HtlcAcceptDesc{
                ctx.circuitKey: acceptDesc,
        }

        update := InvoiceUpdateDesc{
                UpdateType: AddHTLCsUpdate,
                AddHtlcs:   newHtlcs,
        }

        // If the invoice cannot be settled yet, only record the htlc.
        setComplete := newSetTotal >= totalAmt
        if !setComplete {
                return &update, ctx.acceptRes(resultPartialAccepted), nil
        }

        // Check to see if we can settle or this is a hold invoice, and
        // we need to wait for the preimage.
        if inv.HodlInvoice {
                update.State = &InvoiceStateUpdateDesc{
                        NewState: ContractAccepted,
                }
                return &update, ctx.acceptRes(resultAccepted), nil
        }

        var (
                htlcPreimages map[CircuitKey]lntypes.Preimage
                htlcPreimage  lntypes.Preimage
        )
        if ctx.amp != nil {
                var failRes *HtlcFailResolution
                htlcPreimages, failRes = reconstructAMPPreimages(ctx, htlcSet)
                if failRes != nil {
                        update.UpdateType = CancelInvoiceUpdate
                        update.State = &InvoiceStateUpdateDesc{
                                NewState: ContractCanceled,
                                SetID:    setID,
                        }
                        return &update, failRes, nil
                }

                // The preimage for _this_ HTLC will be the one with context's
                // circuit key.
                htlcPreimage = htlcPreimages[ctx.circuitKey]
        } else {
                htlcPreimage = *inv.Terms.PaymentPreimage
        }

        update.State = &InvoiceStateUpdateDesc{
                NewState:      ContractSettled,
                Preimage:      inv.Terms.PaymentPreimage,
                HTLCPreimages: htlcPreimages,
                SetID:         setID,
        }

        return &update, ctx.settleRes(htlcPreimage, ResultSettled), nil
}

// HTLCSet is a map of CircuitKey to InvoiceHTLC.
type HTLCSet = map[CircuitKey]*InvoiceHTLC

// HTLCPreimages is a map of CircuitKey to preimage.
type HTLCPreimages = map[CircuitKey]lntypes.Preimage

// reconstructAMPPreimages reconstructs the root seed for an AMP HTLC set and
// verifies that all derived child hashes match the payment hashes of the HTLCs
// in the set. This method is meant to be called after receiving the full amount
// committed to via mpp_total_msat. This method will return a fail resolution if
// any of the child hashes fail to match their corresponding HTLCs.
func reconstructAMPPreimages(ctx *invoiceUpdateCtx,
        htlcSet HTLCSet) (HTLCPreimages, *HtlcFailResolution) {

        // Create a slice containing all the child descriptors to be used for
        // reconstruction. This should include all HTLCs currently in the HTLC
        // set, plus the incoming HTLC.
        childDescs := make([]amp.ChildDesc, 0, 1+len(htlcSet))

        // Add the new HTLC's child descriptor at index 0.
        childDescs = append(childDescs, amp.ChildDesc{
                Share: ctx.amp.RootShare(),
                Index: ctx.amp.ChildIndex(),
        })

        // Next, construct an index mapping the position in childDescs to a
        // circuit key for all preexisting HTLCs.
        indexToCircuitKey := make(map[int]CircuitKey)

        // Add the child descriptor for each HTLC in the HTLC set, recording
        // it's position within the slice.
        var htlcSetIndex int
        for circuitKey, htlc := range htlcSet {
                childDescs = append(childDescs, amp.ChildDesc{
                        Share: htlc.AMP.Record.RootShare(),
                        Index: htlc.AMP.Record.ChildIndex(),
                })
                indexToCircuitKey[htlcSetIndex] = circuitKey
                htlcSetIndex++
        }

        // Using the child descriptors, reconstruct the root seed and derive the
        // child hash/preimage pairs for each of the HTLCs.
        children := amp.ReconstructChildren(childDescs...)

        // Validate that the derived child preimages match the hash of each
        // HTLC's respective hash.
        if ctx.hash != children[0].Hash {
                return nil, ctx.failRes(ResultAmpReconstruction)
        }
        for idx, child := range children[1:] {
                circuitKey := indexToCircuitKey[idx]
                htlc := htlcSet[circuitKey]
                if htlc.AMP.Hash != child.Hash {
                        return nil, ctx.failRes(ResultAmpReconstruction)
                }
        }

        // Finally, construct the map of learned preimages indexed by circuit
        // key, so that they can be persisted along with each HTLC when updating
        // the invoice.
        htlcPreimages := make(map[CircuitKey]lntypes.Preimage)
        htlcPreimages[ctx.circuitKey] = children[0].Preimage
        for idx, child := range children[1:] {
                circuitKey := indexToCircuitKey[idx]
                htlcPreimages[circuitKey] = child.Preimage
        }

        return htlcPreimages, nil
}

// updateLegacy is a callback for DB.UpdateInvoice that contains the invoice
// settlement logic for legacy payments.
//
// NOTE: This function is only kept in place in order to be able to handle key
// send payments and any invoices we created in the past that are valid and
// still had the optional mpp bit set.
func updateLegacy(ctx *invoiceUpdateCtx,
        inv *Invoice) (*InvoiceUpdateDesc, HtlcResolution, error) {

        // If the invoice is already canceled, there is no further
        // checking to do.
        if inv.State == ContractCanceled {
                return nil, ctx.failRes(ResultInvoiceAlreadyCanceled), nil
        }

        // If an invoice amount is specified, check that enough is paid. Also
        // check this for duplicate payments if the invoice is already settled
        // or accepted. In case this is a zero-valued invoice, it will always be
        // enough.
        if ctx.amtPaid < inv.Terms.Value {
                return nil, ctx.failRes(ResultAmountTooLow), nil
        }

        // If the invoice had the required feature bit set at this point, then
        // if we're in this method it means that the remote party didn't supply
        // the expected payload. However if this is a keysend payment, then
        // we'll permit it to pass.
        _, isKeySend := ctx.customRecords[record.KeySendType]
        invoiceFeatures := inv.Terms.Features
        paymentAddrRequired := invoiceFeatures.RequiresFeature(
                lnwire.PaymentAddrRequired,
        )
        if !isKeySend && paymentAddrRequired {
                log.Warnf("Payment to pay_hash=%v doesn't include MPP "+
                        "payload, rejecting", ctx.hash)
                return nil, ctx.failRes(ResultAddressMismatch), nil
        }

        // Don't allow settling the invoice with an old style
        // htlc if we are already in the process of gathering an
        // mpp set.
        for _, htlc := range inv.HTLCSet(nil, HtlcStateAccepted) {
                if htlc.MppTotalAmt > 0 {
                        return nil, ctx.failRes(ResultMppInProgress), nil
                }
        }

        // The invoice is still open. Check the expiry.
        if ctx.expiry < uint32(ctx.currentHeight+ctx.finalCltvRejectDelta) {
                return nil, ctx.failRes(ResultExpiryTooSoon), nil
        }

        if ctx.expiry < uint32(ctx.currentHeight+inv.Terms.FinalCltvDelta) {
                return nil, ctx.failRes(ResultExpiryTooSoon), nil
        }

        // For storage, we don't really care where the custom records came from.
        // So we merge them together and store them in the same field.
        customRecords := lnwire.CustomRecords(
                ctx.customRecords,
        ).MergedCopy(ctx.wireCustomRecords)

        // Record HTLC in the invoice database.
        newHtlcs := map[CircuitKey]*HtlcAcceptDesc{
                ctx.circuitKey: {
                        Amt:           ctx.amtPaid,
                        Expiry:        ctx.expiry,
                        AcceptHeight:  ctx.currentHeight,
                        CustomRecords: record.CustomSet(customRecords),
                },
        }

        update := InvoiceUpdateDesc{
                AddHtlcs:   newHtlcs,
                UpdateType: AddHTLCsUpdate,
        }

        // Don't update invoice state if we are accepting a duplicate payment.
        // We do accept or settle the HTLC.
        switch inv.State {
        case ContractAccepted:
                return &update, ctx.acceptRes(resultDuplicateToAccepted), nil

        case ContractSettled:
                return &update, ctx.settleRes(
                        *inv.Terms.PaymentPreimage, ResultDuplicateToSettled,
                ), nil
        }

        // Check to see if we can settle or this is an hold invoice and we need
        // to wait for the preimage.
        if inv.HodlInvoice {
                update.State = &InvoiceStateUpdateDesc{
                        NewState: ContractAccepted,
                }

                return &update, ctx.acceptRes(resultAccepted), nil
        }

        update.State = &InvoiceStateUpdateDesc{
                NewState: ContractSettled,
                Preimage: inv.Terms.PaymentPreimage,
        }

        return &update, ctx.settleRes(
                *inv.Terms.PaymentPreimage, ResultSettled,
        ), nil
}

1	package invoices
2
3	import (
4	"bytes"
5	"encoding/hex"
6	"errors"
7
8	"github.com/btcsuite/btcd/chaincfg/chainhash"
9	"github.com/lightningnetwork/lnd/amp"
10	"github.com/lightningnetwork/lnd/lntypes"
11	"github.com/lightningnetwork/lnd/lnwire"
12	"github.com/lightningnetwork/lnd/record"
13	)
14
15	// invoiceUpdateCtx is an object that describes the context for the invoice
16	// update to be carried out.
17	type invoiceUpdateCtx struct {
18	hash lntypes.Hash
19	circuitKey CircuitKey
20	amtPaid lnwire.MilliSatoshi
21	expiry uint32
22	currentHeight int32
23	finalCltvRejectDelta int32
24
25	// wireCustomRecords are the custom records that were included with the
26	// HTLC wire message.
27	wireCustomRecords lnwire.CustomRecords
28
29	// customRecords is a map of custom records that were included with the
30	// HTLC onion payload.
31	customRecords record.CustomSet
32
33	mpp *record.MPP
34	amp *record.AMP
35	metadata []byte
36	pathID *chainhash.Hash
37	totalAmtMsat lnwire.MilliSatoshi
38	}
39
40	// invoiceRef returns an identifier that can be used to lookup or update the
41	// invoice this HTLC is targeting.
42	func (i *invoiceUpdateCtx) invoiceRef() InvoiceRef {	1✔
43	switch {	1✔
44	case i.pathID != nil:	1✔
45	return InvoiceRefByHashAndAddr(i.hash, *i.pathID)	1✔
46
47	case i.amp != nil && i.mpp != nil:	1✔
48	payAddr := i.mpp.PaymentAddr()	1✔
49	return InvoiceRefByAddr(payAddr)	1✔
50
51	case i.mpp != nil:	1✔
52	payAddr := i.mpp.PaymentAddr()	1✔
53	return InvoiceRefByHashAndAddr(i.hash, payAddr)	1✔
54
55	default:	1✔
56	return InvoiceRefByHash(i.hash)	1✔
57	}
58	}
59
60	// setID returns an identifier that identifies other possible HTLCs that this
61	// particular one is related to. If nil is returned this means the HTLC is an
62	// MPP or legacy payment, otherwise the HTLC belongs AMP payment.
63	func (i invoiceUpdateCtx) setID() *[32]byte {	1✔
64	if i.amp != nil {	2✔
65	setID := i.amp.SetID()	1✔
66	return &setID	1✔
67	}	1✔
68	return nil	1✔
69	}
70
71	// log logs a message specific to this update context.
72	func (i *invoiceUpdateCtx) log(s string) {	1✔
73	// Don't use %x in the log statement below, because it doesn't	1✔
74	// distinguish between nil and empty metadata.	1✔
75	metadata := "<nil>"	1✔
76	if i.metadata != nil {	1✔
77	metadata = hex.EncodeToString(i.metadata)	×
78	}	×
79
80	log.Debugf("Invoice%v: %v, amt=%v, expiry=%v, circuit=%v, mpp=%v, "+	1✔
81	"amp=%v, metadata=%v", i.invoiceRef(), s, i.amtPaid, i.expiry,	1✔
82	i.circuitKey, i.mpp, i.amp, metadata)	1✔
83	}
84
85	// failRes is a helper function which creates a failure resolution with
86	// the information contained in the invoiceUpdateCtx and the fail resolution
87	// result provided.
88	func (i invoiceUpdateCtx) failRes(outcome FailResolutionResult) *HtlcFailResolution {	1✔
89	return NewFailResolution(i.circuitKey, i.currentHeight, outcome)	1✔
90	}	1✔
91
92	// settleRes is a helper function which creates a settle resolution with
93	// the information contained in the invoiceUpdateCtx and the preimage and
94	// the settle resolution result provided.
95	func (i invoiceUpdateCtx) settleRes(preimage lntypes.Preimage,
96	outcome SettleResolutionResult) *HtlcSettleResolution {	1✔
97		1✔
98	return NewSettleResolution(	1✔
99	preimage, i.circuitKey, i.currentHeight, outcome,	1✔
100	)	1✔
101	}	1✔
102
103	// acceptRes is a helper function which creates an accept resolution with
104	// the information contained in the invoiceUpdateCtx and the accept resolution
105	// result provided.
106	func (i invoiceUpdateCtx) acceptRes(
107	outcome acceptResolutionResult) *htlcAcceptResolution {	1✔
108		1✔
109	return newAcceptResolution(i.circuitKey, outcome)	1✔
110	}	1✔
111
112	// resolveReplayedHtlc returns the HTLC resolution for a replayed HTLC. The
113	// returned boolean indicates whether the HTLC was replayed or not.
114	func resolveReplayedHtlc(ctx invoiceUpdateCtx, inv Invoice) (bool,
115	HtlcResolution, error) {	1✔
116		1✔
117	// Don't update the invoice when this is a replayed htlc.	1✔
118	htlc, replayedHTLC := inv.Htlcs[ctx.circuitKey]	1✔
119	if !replayedHTLC {	2✔
120	return false, nil, nil	1✔
121	}	1✔
122
123	switch htlc.State {	1✔
124	case HtlcStateCanceled:	1✔
125	return true, ctx.failRes(ResultReplayToCanceled), nil	1✔
126
127	case HtlcStateAccepted:	1✔
128	return true, ctx.acceptRes(resultReplayToAccepted), nil	1✔
129
130	case HtlcStateSettled:	1✔
131	pre := inv.Terms.PaymentPreimage	1✔
132		1✔
133	// Terms.PaymentPreimage will be nil for AMP invoices.	1✔
134	// Set it to the HTLCs AMP Preimage instead.	1✔
135	if pre == nil {	1✔
136	pre = htlc.AMP.Preimage	×
137	}	×
138
139	return true, ctx.settleRes(	1✔
140	*pre,	1✔
141	ResultReplayToSettled,	1✔
142	), nil	1✔
143
144	default:	×
145	return true, nil, errors.New("unknown htlc state")	×
146	}
147	}
148
149	// updateInvoice is a callback for DB.UpdateInvoice that contains the invoice
150	// settlement logic. It returns a HTLC resolution that indicates what the
151	// outcome of the update was.
152	//
153	// NOTE: Make sure replayed HTLCs are always considered before calling this
154	// function.
155	func updateInvoice(ctx invoiceUpdateCtx, inv Invoice) (
156	*InvoiceUpdateDesc, HtlcResolution, error) {	1✔
157		1✔
158	// If no MPP payload was provided, then we expect this to be a keysend,	1✔
159	// or a payment to an invoice created before we started to require the	1✔
160	// MPP payload.	1✔
161	if ctx.mpp == nil && ctx.pathID == nil {	2✔
162	return updateLegacy(ctx, inv)	1✔
163	}	1✔
164
165	return updateMpp(ctx, inv)	1✔
166	}
167
168	// updateMpp is a callback for DB.UpdateInvoice that contains the invoice
169	// settlement logic for mpp payments.
170	func updateMpp(ctx invoiceUpdateCtx, inv Invoice) (*InvoiceUpdateDesc,
171	HtlcResolution, error) {	1✔
172		1✔
173	// Reject HTLCs to AMP invoices if they are missing an AMP payload, and	1✔
174	// HTLCs to MPP invoices if they have an AMP payload.	1✔
175	switch {	1✔
176	case inv.Terms.Features.RequiresFeature(lnwire.AMPRequired) &&
177	ctx.amp == nil:	×
178		×
179	return nil, ctx.failRes(ResultHtlcInvoiceTypeMismatch), nil	×
180
181	case !inv.Terms.Features.RequiresFeature(lnwire.AMPRequired) &&
182	ctx.amp != nil:	×
183		×
184	return nil, ctx.failRes(ResultHtlcInvoiceTypeMismatch), nil	×
185	}
186
187	setID := ctx.setID()	1✔
188		1✔
189	var (	1✔
190	totalAmt = ctx.totalAmtMsat	1✔
191	paymentAddr []byte	1✔
192	)	1✔
193	// If an MPP record is present, then the payment address and total	1✔
194	// payment amount is extracted from it. Otherwise, the pathID is used	1✔
195	// to extract the payment address.	1✔
196	if ctx.mpp != nil {	2✔
197	totalAmt = ctx.mpp.TotalMsat()	1✔
198	payAddr := ctx.mpp.PaymentAddr()	1✔
199	paymentAddr = payAddr[:]	1✔
200	} else {	2✔
201	paymentAddr = ctx.pathID[:]	1✔
202	}	1✔
203
204	// For storage, we don't really care where the custom records came from.
205	// So we merge them together and store them in the same field.
206	customRecords := lnwire.CustomRecords(	1✔
207	ctx.customRecords,	1✔
208	).MergedCopy(ctx.wireCustomRecords)	1✔
209		1✔
210	// Start building the accept descriptor.	1✔
211	acceptDesc := &HtlcAcceptDesc{	1✔
212	Amt: ctx.amtPaid,	1✔
213	Expiry: ctx.expiry,	1✔
214	AcceptHeight: ctx.currentHeight,	1✔
215	MppTotalAmt: totalAmt,	1✔
216	CustomRecords: record.CustomSet(customRecords),	1✔
217	}	1✔
218		1✔
219	if ctx.amp != nil {	2✔
220	acceptDesc.AMP = &InvoiceHtlcAMPData{	1✔
221	Record: *ctx.amp,	1✔
222	Hash: ctx.hash,	1✔
223	Preimage: nil,	1✔
224	}	1✔
225	}	1✔
226
227	// Only accept payments to open invoices. This behaviour differs from
228	// non-mpp payments that are accepted even after the invoice is settled.
229	// Because non-mpp payments don't have a payment address, this is needed
230	// to thwart probing.
231	if inv.State != ContractOpen {	1✔
232	return nil, ctx.failRes(ResultInvoiceNotOpen), nil	×
233	}	×
234
235	// Check the payment address that authorizes the payment.
236	if !bytes.Equal(paymentAddr, inv.Terms.PaymentAddr[:]) {	2✔
237	return nil, ctx.failRes(ResultAddressMismatch), nil	1✔
238	}	1✔
239
240	// Don't accept zero-valued sets.
241	if totalAmt == 0 {	1✔
242	return nil, ctx.failRes(ResultHtlcSetTotalTooLow), nil	×
243	}	×
244
245	// Check that the total amt of the htlc set is high enough. In case this
246	// is a zero-valued invoice, it will always be enough.
247	if totalAmt < inv.Terms.Value {	1✔
248	return nil, ctx.failRes(ResultHtlcSetTotalTooLow), nil	×
249	}	×
250
251	htlcSet := inv.HTLCSet(setID, HtlcStateAccepted)	1✔
252		1✔
253	// Check whether total amt matches other HTLCs in the set.	1✔
254	var newSetTotal lnwire.MilliSatoshi	1✔
255	for _, htlc := range htlcSet {	2✔
256	if totalAmt != htlc.MppTotalAmt {	1✔
257	return nil, ctx.failRes(ResultHtlcSetTotalMismatch), nil	×
258	}	×
259
260	newSetTotal += htlc.Amt	1✔
261	}
262
263	// Add amount of new htlc.
264	newSetTotal += ctx.amtPaid	1✔
265		1✔
266	// The invoice is still open. Check the expiry.	1✔
267	if ctx.expiry < uint32(ctx.currentHeight+ctx.finalCltvRejectDelta) {	1✔
268	return nil, ctx.failRes(ResultExpiryTooSoon), nil	×
269	}	×
270
271	if ctx.expiry < uint32(ctx.currentHeight+inv.Terms.FinalCltvDelta) {	1✔
272	return nil, ctx.failRes(ResultExpiryTooSoon), nil	×
273	}	×
274
275	if setID != nil && *setID == BlankPayAddr {	1✔
276	return nil, ctx.failRes(ResultAmpError), nil	×
277	}	×
278
279	// Record HTLC in the invoice database.
280	newHtlcs := map[CircuitKey]*HtlcAcceptDesc{	1✔
281	ctx.circuitKey: acceptDesc,	1✔
282	}	1✔
283		1✔
284	update := InvoiceUpdateDesc{	1✔
285	UpdateType: AddHTLCsUpdate,	1✔
286	AddHtlcs: newHtlcs,	1✔
287	}	1✔
288		1✔
289	// If the invoice cannot be settled yet, only record the htlc.	1✔
290	setComplete := newSetTotal >= totalAmt	1✔
291	if !setComplete {	2✔
292	return &update, ctx.acceptRes(resultPartialAccepted), nil	1✔
293	}	1✔
294
295	// Check to see if we can settle or this is a hold invoice, and
296	// we need to wait for the preimage.
297	if inv.HodlInvoice {	2✔
298	update.State = &InvoiceStateUpdateDesc{	1✔
299	NewState: ContractAccepted,	1✔
300	}	1✔
301	return &update, ctx.acceptRes(resultAccepted), nil	1✔
302	}	1✔
303
304	var (	1✔
305	htlcPreimages map[CircuitKey]lntypes.Preimage	1✔
306	htlcPreimage lntypes.Preimage	1✔
307	)	1✔
308	if ctx.amp != nil {	2✔
309	var failRes *HtlcFailResolution	1✔
310	htlcPreimages, failRes = reconstructAMPPreimages(ctx, htlcSet)	1✔
311	if failRes != nil {	1✔
UNCOV 312	update.UpdateType = CancelInvoiceUpdate	×
UNCOV 313	update.State = &InvoiceStateUpdateDesc{	×
UNCOV 314	NewState: ContractCanceled,	×
UNCOV 315	SetID: setID,	×
UNCOV 316	}	×
UNCOV 317	return &update, failRes, nil	×
UNCOV 318	}	×
319
320	// The preimage for _this_ HTLC will be the one with context's
321	// circuit key.
322	htlcPreimage = htlcPreimages[ctx.circuitKey]	1✔
323	} else {	1✔
324	htlcPreimage = *inv.Terms.PaymentPreimage	1✔
325	}	1✔
326
327	update.State = &InvoiceStateUpdateDesc{	1✔
328	NewState: ContractSettled,	1✔
329	Preimage: inv.Terms.PaymentPreimage,	1✔
330	HTLCPreimages: htlcPreimages,	1✔
331	SetID: setID,	1✔
332	}	1✔
333		1✔
334	return &update, ctx.settleRes(htlcPreimage, ResultSettled), nil	1✔
335	}
336
337	// HTLCSet is a map of CircuitKey to InvoiceHTLC.
338	type HTLCSet = map[CircuitKey]*InvoiceHTLC
339
340	// HTLCPreimages is a map of CircuitKey to preimage.
341	type HTLCPreimages = map[CircuitKey]lntypes.Preimage
342
343	// reconstructAMPPreimages reconstructs the root seed for an AMP HTLC set and
344	// verifies that all derived child hashes match the payment hashes of the HTLCs
345	// in the set. This method is meant to be called after receiving the full amount
346	// committed to via mpp_total_msat. This method will return a fail resolution if
347	// any of the child hashes fail to match their corresponding HTLCs.
348	func reconstructAMPPreimages(ctx *invoiceUpdateCtx,
349	htlcSet HTLCSet) (HTLCPreimages, *HtlcFailResolution) {	1✔
350		1✔
351	// Create a slice containing all the child descriptors to be used for	1✔
352	// reconstruction. This should include all HTLCs currently in the HTLC	1✔
353	// set, plus the incoming HTLC.	1✔
354	childDescs := make([]amp.ChildDesc, 0, 1+len(htlcSet))	1✔
355		1✔
356	// Add the new HTLC's child descriptor at index 0.	1✔
357	childDescs = append(childDescs, amp.ChildDesc{	1✔
358	Share: ctx.amp.RootShare(),	1✔
359	Index: ctx.amp.ChildIndex(),	1✔
360	})	1✔
361		1✔
362	// Next, construct an index mapping the position in childDescs to a	1✔
363	// circuit key for all preexisting HTLCs.	1✔
364	indexToCircuitKey := make(map[int]CircuitKey)	1✔
365		1✔
366	// Add the child descriptor for each HTLC in the HTLC set, recording	1✔
367	// it's position within the slice.	1✔
368	var htlcSetIndex int	1✔
369	for circuitKey, htlc := range htlcSet {	2✔
370	childDescs = append(childDescs, amp.ChildDesc{	1✔
371	Share: htlc.AMP.Record.RootShare(),	1✔
372	Index: htlc.AMP.Record.ChildIndex(),	1✔
373	})	1✔
374	indexToCircuitKey[htlcSetIndex] = circuitKey	1✔
375	htlcSetIndex++	1✔
376	}	1✔
377
378	// Using the child descriptors, reconstruct the root seed and derive the
379	// child hash/preimage pairs for each of the HTLCs.
380	children := amp.ReconstructChildren(childDescs...)	1✔
381		1✔
382	// Validate that the derived child preimages match the hash of each	1✔
383	// HTLC's respective hash.	1✔
384	if ctx.hash != children[0].Hash {	1✔
UNCOV 385	return nil, ctx.failRes(ResultAmpReconstruction)	×
UNCOV 386	}	×
387	for idx, child := range children[1:] {	2✔
388	circuitKey := indexToCircuitKey[idx]	1✔
389	htlc := htlcSet[circuitKey]	1✔
390	if htlc.AMP.Hash != child.Hash {	1✔
391	return nil, ctx.failRes(ResultAmpReconstruction)	×
392	}	×
393	}
394
395	// Finally, construct the map of learned preimages indexed by circuit
396	// key, so that they can be persisted along with each HTLC when updating
397	// the invoice.
398	htlcPreimages := make(map[CircuitKey]lntypes.Preimage)	1✔
399	htlcPreimages[ctx.circuitKey] = children[0].Preimage	1✔
400	for idx, child := range children[1:] {	2✔
401	circuitKey := indexToCircuitKey[idx]	1✔
402	htlcPreimages[circuitKey] = child.Preimage	1✔
403	}	1✔
404
405	return htlcPreimages, nil	1✔
406	}
407
408	// updateLegacy is a callback for DB.UpdateInvoice that contains the invoice
409	// settlement logic for legacy payments.
410	//
411	// NOTE: This function is only kept in place in order to be able to handle key
412	// send payments and any invoices we created in the past that are valid and
413	// still had the optional mpp bit set.
414	func updateLegacy(ctx *invoiceUpdateCtx,
415	inv Invoice) (InvoiceUpdateDesc, HtlcResolution, error) {	1✔
416		1✔
417	// If the invoice is already canceled, there is no further	1✔
418	// checking to do.	1✔
419	if inv.State == ContractCanceled {	1✔
UNCOV 420	return nil, ctx.failRes(ResultInvoiceAlreadyCanceled), nil	×
UNCOV 421	}	×
422
423	// If an invoice amount is specified, check that enough is paid. Also
424	// check this for duplicate payments if the invoice is already settled
425	// or accepted. In case this is a zero-valued invoice, it will always be
426	// enough.
427	if ctx.amtPaid < inv.Terms.Value {	2✔
428	return nil, ctx.failRes(ResultAmountTooLow), nil	1✔
429	}	1✔
430
431	// If the invoice had the required feature bit set at this point, then
432	// if we're in this method it means that the remote party didn't supply
433	// the expected payload. However if this is a keysend payment, then
434	// we'll permit it to pass.
435	_, isKeySend := ctx.customRecords[record.KeySendType]	1✔
436	invoiceFeatures := inv.Terms.Features	1✔
437	paymentAddrRequired := invoiceFeatures.RequiresFeature(	1✔
438	lnwire.PaymentAddrRequired,	1✔
439	)	1✔
440	if !isKeySend && paymentAddrRequired {	1✔
UNCOV 441	log.Warnf("Payment to pay_hash=%v doesn't include MPP "+	×
UNCOV 442	"payload, rejecting", ctx.hash)	×
UNCOV 443	return nil, ctx.failRes(ResultAddressMismatch), nil	×
UNCOV 444	}	×
445
446	// Don't allow settling the invoice with an old style
447	// htlc if we are already in the process of gathering an
448	// mpp set.
449	for _, htlc := range inv.HTLCSet(nil, HtlcStateAccepted) {	1✔
UNCOV 450	if htlc.MppTotalAmt > 0 {	×
451	return nil, ctx.failRes(ResultMppInProgress), nil	×
452	}	×
453	}
454
455	// The invoice is still open. Check the expiry.
456	if ctx.expiry < uint32(ctx.currentHeight+ctx.finalCltvRejectDelta) {	1✔
UNCOV 457	return nil, ctx.failRes(ResultExpiryTooSoon), nil	×
UNCOV 458	}	×
459
460	if ctx.expiry < uint32(ctx.currentHeight+inv.Terms.FinalCltvDelta) {	1✔
UNCOV 461	return nil, ctx.failRes(ResultExpiryTooSoon), nil	×
UNCOV 462	}	×
463
464	// For storage, we don't really care where the custom records came from.
465	// So we merge them together and store them in the same field.
466	customRecords := lnwire.CustomRecords(	1✔
467	ctx.customRecords,	1✔
468	).MergedCopy(ctx.wireCustomRecords)	1✔
469		1✔
470	// Record HTLC in the invoice database.	1✔
471	newHtlcs := map[CircuitKey]*HtlcAcceptDesc{	1✔
472	ctx.circuitKey: {	1✔
473	Amt: ctx.amtPaid,	1✔
474	Expiry: ctx.expiry,	1✔
475	AcceptHeight: ctx.currentHeight,	1✔
476	CustomRecords: record.CustomSet(customRecords),	1✔
477	},	1✔
478	}	1✔
479		1✔
480	update := InvoiceUpdateDesc{	1✔
481	AddHtlcs: newHtlcs,	1✔
482	UpdateType: AddHTLCsUpdate,	1✔
483	}	1✔
484		1✔
485	// Don't update invoice state if we are accepting a duplicate payment.	1✔
486	// We do accept or settle the HTLC.	1✔
487	switch inv.State {	1✔
488	case ContractAccepted:	×
489	return &update, ctx.acceptRes(resultDuplicateToAccepted), nil	×
490
UNCOV 491	case ContractSettled:	×
UNCOV 492	return &update, ctx.settleRes(	×
UNCOV 493	*inv.Terms.PaymentPreimage, ResultDuplicateToSettled,	×
UNCOV 494	), nil	×
495	}
496
497	// Check to see if we can settle or this is an hold invoice and we need
498	// to wait for the preimage.
499	if inv.HodlInvoice {	1✔
UNCOV 500	update.State = &InvoiceStateUpdateDesc{	×
UNCOV 501	NewState: ContractAccepted,	×
UNCOV 502	}	×
UNCOV 503		×
UNCOV 504	return &update, ctx.acceptRes(resultAccepted), nil	×
UNCOV 505	}	×
506
507	update.State = &InvoiceStateUpdateDesc{	1✔
508	NewState: ContractSettled,	1✔
509	Preimage: inv.Terms.PaymentPreimage,	1✔
510	}	1✔
511		1✔
512	return &update, ctx.settleRes(	1✔
513	*inv.Terms.PaymentPreimage, ResultSettled,	1✔
514	), nil	1✔
515	}

lightningnetwork / lnd / 15155511119

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous