15782265189

Committed 20 Jun 2025 03:23PM UTC coverage: 68.14% (-0.003%) from 68.143%

Build # 15782265189

Build Type

Pull #9958

github

Committed by

web-flow

Commit Message

Merge ae1a1d1ba into 7857d2c6a

Pull Request Pull Request #9958: improve CloseChannel docs

Run Details

134478 of 197355 relevant lines covered (68.14%)

22170.18 hits per line

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

74.42

/lnwire/funding_signed.go

package lnwire

import (
        "bytes"
        "io"

        "github.com/lightningnetwork/lnd/tlv"
)

// FundingSigned is sent from Bob (the responder) to Alice (the initiator)
// after receiving the funding outpoint and her signature for Bob's version of
// the commitment transaction.
type FundingSigned struct {
        // ChannelPoint is the particular active channel that this
        // FundingSigned is bound to.
        ChanID ChannelID

        // CommitSig is Bob's signature for Alice's version of the commitment
        // transaction.
        CommitSig Sig

        // PartialSig is used to transmit a musig2 extended partial signature
        // that also carries along the public nonce of the signer.
        //
        // NOTE: This field is only populated if a musig2 taproot channel is
        // being signed for. In this case, the above Sig type MUST be blank.
        PartialSig OptPartialSigWithNonceTLV

        // 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
}

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

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

// Encode serializes the target FundingSigned into the passed io.Writer
// implementation. Serialization will observe the rules defined by the passed
// protocol version.
//
// This is part of the lnwire.Message interface.
func (f *FundingSigned) Encode(w *bytes.Buffer, pver uint32) error {
        recordProducers := make([]tlv.RecordProducer, 0, 1)
        f.PartialSig.WhenSome(func(sig PartialSigWithNonceTLV) {
                recordProducers = append(recordProducers, &sig)
        })
        err := EncodeMessageExtraData(&f.ExtraData, recordProducers...)
        if err != nil {
                return err
        }

        if err := WriteChannelID(w, f.ChanID); err != nil {
                return err
        }

        if err := WriteSig(w, f.CommitSig); err != nil {
                return err
        }

        return WriteBytes(w, f.ExtraData)
}

// Decode deserializes the serialized FundingSigned stored in the passed
// io.Reader into the target FundingSigned using the deserialization rules
// defined by the passed protocol version.
//
// This is part of the lnwire.Message interface.
func (f *FundingSigned) Decode(r io.Reader, pver uint32) error {
        err := ReadElements(r, &f.ChanID, &f.CommitSig)
        if err != nil {
                return err
        }

        var tlvRecords ExtraOpaqueData
        if err := ReadElements(r, &tlvRecords); err != nil {
                return err
        }

        partialSig := f.PartialSig.Zero()
        typeMap, err := tlvRecords.ExtractRecords(&partialSig)
        if err != nil {
                return err
        }

        // Set the corresponding TLV types if they were included in the stream.
        if val, ok := typeMap[f.PartialSig.TlvType()]; ok && val == nil {
                f.PartialSig = tlv.SomeRecordT(partialSig)
        }

        if len(tlvRecords) != 0 {
                f.ExtraData = tlvRecords
        }

        return nil
}

// MsgType returns the uint32 code which uniquely identifies this message as a
// FundingSigned on the wire.
//
// This is part of the lnwire.Message interface.
func (f *FundingSigned) MsgType() MessageType {
        return MsgFundingSigned
}

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

1	package lnwire
2
3	import (
4	"bytes"
5	"io"
6
7	"github.com/lightningnetwork/lnd/tlv"
8	)
9
10	// FundingSigned is sent from Bob (the responder) to Alice (the initiator)
11	// after receiving the funding outpoint and her signature for Bob's version of
12	// the commitment transaction.
13	type FundingSigned struct {
14	// ChannelPoint is the particular active channel that this
15	// FundingSigned is bound to.
16	ChanID ChannelID
17
18	// CommitSig is Bob's signature for Alice's version of the commitment
19	// transaction.
20	CommitSig Sig
21
22	// PartialSig is used to transmit a musig2 extended partial signature
23	// that also carries along the public nonce of the signer.
24	//
25	// NOTE: This field is only populated if a musig2 taproot channel is
26	// being signed for. In this case, the above Sig type MUST be blank.
27	PartialSig OptPartialSigWithNonceTLV
28
29	// ExtraData is the set of data that was appended to this message to
30	// fill out the full maximum transport message size. These fields can
31	// be used to specify optional data such as custom TLV fields.
32	ExtraData ExtraOpaqueData
33	}
34
35	// A compile time check to ensure FundingSigned implements the lnwire.Message
36	// interface.
37	var _ Message = (*FundingSigned)(nil)
38
39	// A compile time check to ensure FundingSigned implements the
40	// lnwire.SizeableMessage interface.
41	var _ SizeableMessage = (*FundingSigned)(nil)
42
43	// Encode serializes the target FundingSigned into the passed io.Writer
44	// implementation. Serialization will observe the rules defined by the passed
45	// protocol version.
46	//
47	// This is part of the lnwire.Message interface.
48	func (f FundingSigned) Encode(w bytes.Buffer, pver uint32) error {	113✔
49	recordProducers := make([]tlv.RecordProducer, 0, 1)	113✔
50	f.PartialSig.WhenSome(func(sig PartialSigWithNonceTLV) {	155✔
51	recordProducers = append(recordProducers, &sig)	42✔
52	})	42✔
53	err := EncodeMessageExtraData(&f.ExtraData, recordProducers...)	113✔
54	if err != nil {	113✔
55	return err	×
56	}	×
57
58	if err := WriteChannelID(w, f.ChanID); err != nil {	113✔
59	return err	×
60	}	×
61
62	if err := WriteSig(w, f.CommitSig); err != nil {	113✔
63	return err	×
64	}	×
65
66	return WriteBytes(w, f.ExtraData)	113✔
67	}
68
69	// Decode deserializes the serialized FundingSigned stored in the passed
70	// io.Reader into the target FundingSigned using the deserialization rules
71	// defined by the passed protocol version.
72	//
73	// This is part of the lnwire.Message interface.
74	func (f *FundingSigned) Decode(r io.Reader, pver uint32) error {	171✔
75	err := ReadElements(r, &f.ChanID, &f.CommitSig)	171✔
76	if err != nil {	175✔
77	return err	4✔
78	}	4✔
79
80	var tlvRecords ExtraOpaqueData	167✔
81	if err := ReadElements(r, &tlvRecords); err != nil {	167✔
82	return err	×
83	}	×
84
85	partialSig := f.PartialSig.Zero()	167✔
86	typeMap, err := tlvRecords.ExtractRecords(&partialSig)	167✔
87	if err != nil {	211✔
88	return err	44✔
89	}	44✔
90
91	// Set the corresponding TLV types if they were included in the stream.
92	if val, ok := typeMap[f.PartialSig.TlvType()]; ok && val == nil {	167✔
93	f.PartialSig = tlv.SomeRecordT(partialSig)	44✔
94	}	44✔
95
96	if len(tlvRecords) != 0 {	174✔
97	f.ExtraData = tlvRecords	51✔
98	}	51✔
99
100	return nil	123✔
101	}
102
103	// MsgType returns the uint32 code which uniquely identifies this message as a
104	// FundingSigned on the wire.
105	//
106	// This is part of the lnwire.Message interface.
107	func (f *FundingSigned) MsgType() MessageType {	113✔
108	return MsgFundingSigned	113✔
109	}	113✔
110
111	// SerializedSize returns the serialized size of the message in bytes.
112	//
113	// This is part of the lnwire.SizeableMessage interface.
114	func (f *FundingSigned) SerializedSize() (uint32, error) {	×
115	return MessageSerializedSize(f)	×
116	}	×

lightningnetwork / lnd / 15782265189

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