14358372723

Committed 09 Apr 2025 01:26PM UTC coverage: 56.696% (-12.3%) from 69.037%

Build # 14358372723

Build Type

Pull #9696

github

Committed by

web-flow

Commit Message

Merge e2837e400 into 867d27d68

Pull Request Pull Request #9696: Add `development_guidelines.md` for both human and machine

Run Details

107055 of 188823 relevant lines covered (56.7%)

22721.56 hits per line

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

60.0

/lnwire/update_fulfill_htlc.go

package lnwire

import (
        "bytes"
        "io"
)

// UpdateFulfillHTLC is sent by Alice to Bob when she wishes to settle a
// particular HTLC referenced by its HTLCKey within a specific active channel
// referenced by ChannelPoint.  A subsequent CommitSig message will be sent by
// Alice to "lock-in" the removal of the specified HTLC, possible containing a
// batch signature covering several settled HTLC's.
type UpdateFulfillHTLC struct {
        // ChanID references an active channel which holds the HTLC to be
        // settled.
        ChanID ChannelID

        // ID denotes the exact HTLC stage within the receiving node's
        // commitment transaction to be removed.
        ID uint64

        // PaymentPreimage is the R-value preimage required to fully settle an
        // HTLC.
        PaymentPreimage [32]byte

        // CustomRecords maps TLV types to byte slices, storing arbitrary data
        // intended for inclusion in the ExtraData field.
        CustomRecords CustomRecords

        // ExtraData is the set of data that was appended to this message to
        // fill out the full maximum transport message size. These fields can
        // be used to specify optional data such as custom TLV fields.
        ExtraData ExtraOpaqueData
}

// NewUpdateFulfillHTLC returns a new empty UpdateFulfillHTLC.
func NewUpdateFulfillHTLC(chanID ChannelID, id uint64,
        preimage [32]byte) *UpdateFulfillHTLC {

        return &UpdateFulfillHTLC{
                ChanID:          chanID,
                ID:              id,
                PaymentPreimage: preimage,
        }
}

// A compile time check to ensure UpdateFulfillHTLC implements the
// lnwire.Message interface.
var _ Message = (*UpdateFulfillHTLC)(nil)

// A compile time check to ensure UpdateFulfillHTLC implements the
// lnwire.SizeableMessage interface.
var _ SizeableMessage = (*UpdateFulfillHTLC)(nil)

// Decode deserializes a serialized UpdateFulfillHTLC message stored in the
// passed io.Reader observing the specified protocol version.
//
// This is part of the lnwire.Message interface.
func (c *UpdateFulfillHTLC) Decode(r io.Reader, pver uint32) error {
        // msgExtraData is a temporary variable used to read the message extra
        // data field from the reader.
        var msgExtraData ExtraOpaqueData

        if err := ReadElements(r,
                &c.ChanID,
                &c.ID,
                c.PaymentPreimage[:],
                &msgExtraData,
        ); err != nil {
                return err
        }

        // Extract custom records from the extra data field.
        customRecords, _, extraData, err := ParseAndExtractCustomRecords(
                msgExtraData,
        )
        if err != nil {
                return err
        }

        c.CustomRecords = customRecords
        c.ExtraData = extraData

        return nil
}

// Encode serializes the target UpdateFulfillHTLC into the passed io.Writer
// observing the protocol version specified.
//
// This is part of the lnwire.Message interface.
func (c *UpdateFulfillHTLC) Encode(w *bytes.Buffer, pver uint32) error {
        if err := WriteChannelID(w, c.ChanID); err != nil {
                return err
        }

        if err := WriteUint64(w, c.ID); err != nil {
                return err
        }

        if err := WriteBytes(w, c.PaymentPreimage[:]); err != nil {
                return err
        }

        // Combine the custom records and the extra data, then encode the
        // result as a byte slice.
        extraData, err := MergeAndEncode(nil, c.ExtraData, c.CustomRecords)
        if err != nil {
                return err
        }

        return WriteBytes(w, extraData)
}

// MsgType returns the integer uniquely identifying this message type on the
// wire.
//
// This is part of the lnwire.Message interface.
func (c *UpdateFulfillHTLC) MsgType() MessageType {
        return MsgUpdateFulfillHTLC
}

// SerializedSize returns the serialized size of the message in bytes.
//
// This is part of the lnwire.SizeableMessage interface.
func (c *UpdateFulfillHTLC) SerializedSize() (uint32, error) {
        return MessageSerializedSize(c)
}

// TargetChanID returns the channel id of the link for which this message is
// intended.
//
// NOTE: Part of peer.LinkUpdater interface.
func (c *UpdateFulfillHTLC) TargetChanID() ChannelID {
        return c.ChanID
}

1	package lnwire
2
3	import (
4	"bytes"
5	"io"
6	)
7
8	// UpdateFulfillHTLC is sent by Alice to Bob when she wishes to settle a
9	// particular HTLC referenced by its HTLCKey within a specific active channel
10	// referenced by ChannelPoint. A subsequent CommitSig message will be sent by
11	// Alice to "lock-in" the removal of the specified HTLC, possible containing a
12	// batch signature covering several settled HTLC's.
13	type UpdateFulfillHTLC struct {
14	// ChanID references an active channel which holds the HTLC to be
15	// settled.
16	ChanID ChannelID
17
18	// ID denotes the exact HTLC stage within the receiving node's
19	// commitment transaction to be removed.
20	ID uint64
21
22	// PaymentPreimage is the R-value preimage required to fully settle an
23	// HTLC.
24	PaymentPreimage [32]byte
25
26	// CustomRecords maps TLV types to byte slices, storing arbitrary data
27	// intended for inclusion in the ExtraData field.
28	CustomRecords CustomRecords
29
30	// ExtraData is the set of data that was appended to this message to
31	// fill out the full maximum transport message size. These fields can
32	// be used to specify optional data such as custom TLV fields.
33	ExtraData ExtraOpaqueData
34	}
35
36	// NewUpdateFulfillHTLC returns a new empty UpdateFulfillHTLC.
37	func NewUpdateFulfillHTLC(chanID ChannelID, id uint64,
38	preimage [32]byte) *UpdateFulfillHTLC {	×
39		×
40	return &UpdateFulfillHTLC{	×
41	ChanID: chanID,	×
42	ID: id,	×
43	PaymentPreimage: preimage,	×
44	}	×
45	}	×
46
47	// A compile time check to ensure UpdateFulfillHTLC implements the
48	// lnwire.Message interface.
49	var _ Message = (*UpdateFulfillHTLC)(nil)
50
51	// A compile time check to ensure UpdateFulfillHTLC implements the
52	// lnwire.SizeableMessage interface.
53	var _ SizeableMessage = (*UpdateFulfillHTLC)(nil)
54
55	// Decode deserializes a serialized UpdateFulfillHTLC message stored in the
56	// passed io.Reader observing the specified protocol version.
57	//
58	// This is part of the lnwire.Message interface.
59	func (c *UpdateFulfillHTLC) Decode(r io.Reader, pver uint32) error {	1,059✔
60	// msgExtraData is a temporary variable used to read the message extra	1,059✔
61	// data field from the reader.	1,059✔
62	var msgExtraData ExtraOpaqueData	1,059✔
63		1,059✔
64	if err := ReadElements(r,	1,059✔
65	&c.ChanID,	1,059✔
66	&c.ID,	1,059✔
67	c.PaymentPreimage[:],	1,059✔
68	&msgExtraData,	1,059✔
69	); err != nil {	1,063✔
70	return err	4✔
71	}	4✔
72
73	// Extract custom records from the extra data field.
74	customRecords, _, extraData, err := ParseAndExtractCustomRecords(	1,055✔
75	msgExtraData,	1,055✔
76	)	1,055✔
77	if err != nil {	1,068✔
78	return err	13✔
79	}	13✔
80
81	c.CustomRecords = customRecords	1,042✔
82	c.ExtraData = extraData	1,042✔
83		1,042✔
84	return nil	1,042✔
85	}
86
87	// Encode serializes the target UpdateFulfillHTLC into the passed io.Writer
88	// observing the protocol version specified.
89	//
90	// This is part of the lnwire.Message interface.
91	func (c UpdateFulfillHTLC) Encode(w bytes.Buffer, pver uint32) error {	1,501✔
92	if err := WriteChannelID(w, c.ChanID); err != nil {	1,501✔
93	return err	×
94	}	×
95
96	if err := WriteUint64(w, c.ID); err != nil {	1,501✔
97	return err	×
98	}	×
99
100	if err := WriteBytes(w, c.PaymentPreimage[:]); err != nil {	1,501✔
101	return err	×
102	}	×
103
104	// Combine the custom records and the extra data, then encode the
105	// result as a byte slice.
106	extraData, err := MergeAndEncode(nil, c.ExtraData, c.CustomRecords)	1,501✔
107	if err != nil {	1,501✔
108	return err	×
109	}	×
110
111	return WriteBytes(w, extraData)	1,501✔
112	}
113
114	// MsgType returns the integer uniquely identifying this message type on the
115	// wire.
116	//
117	// This is part of the lnwire.Message interface.
118	func (c *UpdateFulfillHTLC) MsgType() MessageType {	2,211✔
119	return MsgUpdateFulfillHTLC	2,211✔
120	}	2,211✔
121
122	// SerializedSize returns the serialized size of the message in bytes.
123	//
124	// This is part of the lnwire.SizeableMessage interface.
125	func (c *UpdateFulfillHTLC) SerializedSize() (uint32, error) {	×
126	return MessageSerializedSize(c)	×
127	}	×
128
129	// TargetChanID returns the channel id of the link for which this message is
130	// intended.
131	//
132	// NOTE: Part of peer.LinkUpdater interface.
133	func (c *UpdateFulfillHTLC) TargetChanID() ChannelID {	×
134	return c.ChanID	×
135	}	×

lightningnetwork / lnd / 14358372723

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