package lnwire import ( "bytes" "io" "github.com/btcsuite/btcd/btcec/v2" "github.com/btcsuite/btcd/btcutil" "github.com/lightningnetwork/lnd/fn/v2" "github.com/lightningnetwork/lnd/lnwallet/chainfee" "github.com/lightningnetwork/lnd/tlv" ) const ( // DPDustLimitSatoshis is the TLV type number that identifies the record // for DynPropose.DustLimit. DPDustLimitSatoshis tlv.Type = 0 // DPMaxHtlcValueInFlightMsat is the TLV type number that identifies the // record for DynPropose.MaxValueInFlight. DPMaxHtlcValueInFlightMsat tlv.Type = 1 // DPChannelReserveSatoshis is the TLV type number that identifies the // for DynPropose.ChannelReserve. DPChannelReserveSatoshis tlv.Type = 2 // DPToSelfDelay is the TLV type number that identifies the record for // DynPropose.CsvDelay. DPToSelfDelay tlv.Type = 3 // DPMaxAcceptedHtlcs is the TLV type number that identifies the record // for DynPropose.MaxAcceptedHTLCs. DPMaxAcceptedHtlcs tlv.Type = 4 // DPFundingPubkey is the TLV type number that identifies the record for // DynPropose.FundingKey. DPFundingPubkey tlv.Type = 5 // DPChannelType is the TLV type number that identifies the record for // DynPropose.ChannelType. DPChannelType tlv.Type = 6 // DPKickoffFeerate is the TLV type number that identifies the record // for DynPropose.KickoffFeerate. DPKickoffFeerate tlv.Type = 7 ) // DynPropose is a message that is sent during a dynamic commitments negotiation // process. It is sent by both parties to propose new channel parameters. type DynPropose struct { // ChanID identifies the channel whose parameters we are trying to // re-negotiate. ChanID ChannelID // Initiator is a byte that identifies whether this message was sent as // the initiator of a dynamic commitment negotiation or the responder // of a dynamic commitment negotiation. bool true indicates it is the // initiator Initiator bool // DustLimit, if not nil, proposes a change to the dust_limit_satoshis // for the sender's commitment transaction. DustLimit fn.Option[btcutil.Amount] // MaxValueInFlight, if not nil, proposes a change to the // max_htlc_value_in_flight_msat limit of the sender. MaxValueInFlight fn.Option[MilliSatoshi] // ChannelReserve, if not nil, proposes a change to the // channel_reserve_satoshis requirement of the recipient. ChannelReserve fn.Option[btcutil.Amount] // CsvDelay, if not nil, proposes a change to the to_self_delay // requirement of the recipient. CsvDelay fn.Option[uint16] // MaxAcceptedHTLCs, if not nil, proposes a change to the // max_accepted_htlcs limit of the sender. MaxAcceptedHTLCs fn.Option[uint16] // FundingKey, if not nil, proposes a change to the funding_pubkey // parameter of the sender. FundingKey fn.Option[btcec.PublicKey] // ChannelType, if not nil, proposes a change to the channel_type // parameter. ChannelType fn.Option[ChannelType] // KickoffFeerate proposes the fee rate in satoshis per kw that it // is offering for a ChannelType conversion that requires a kickoff // transaction. KickoffFeerate fn.Option[chainfee.SatPerKWeight] // 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. // // NOTE: Since the fields in this structure are part of the TLV stream, // ExtraData will contain all TLV records _except_ the ones that are // present in earlier parts of this structure. ExtraData ExtraOpaqueData } // A compile time check to ensure DynPropose implements the lnwire.Message // interface. var _ Message = (*DynPropose)(nil) // Encode serializes the target DynPropose into the passed io.Writer. // Serialization will observe the rules defined by the passed protocol version. // // This is a part of the lnwire.Message interface. func (dp *DynPropose) Encode(w *bytes.Buffer, _ uint32) error { var tlvRecords []tlv.Record dp.DustLimit.WhenSome(func(dl btcutil.Amount) { protoSats := uint64(dl) tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPDustLimitSatoshis, &protoSats, ), ) }) dp.MaxValueInFlight.WhenSome(func(max MilliSatoshi) { protoSats := uint64(max) tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPMaxHtlcValueInFlightMsat, &protoSats, ), ) }) dp.ChannelReserve.WhenSome(func(min btcutil.Amount) { channelReserve := uint64(min) tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPChannelReserveSatoshis, &channelReserve, ), ) }) dp.CsvDelay.WhenSome(func(wait uint16) { tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPToSelfDelay, &wait, ), ) }) dp.MaxAcceptedHTLCs.WhenSome(func(max uint16) { tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPMaxAcceptedHtlcs, &max, ), ) }) dp.FundingKey.WhenSome(func(key btcec.PublicKey) { keyScratch := &key tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPFundingPubkey, &keyScratch, ), ) }) dp.ChannelType.WhenSome(func(ty ChannelType) { tlvRecords = append( tlvRecords, tlv.MakeDynamicRecord( DPChannelType, &ty, ty.featureBitLen, channelTypeEncoder, channelTypeDecoder, ), ) }) dp.KickoffFeerate.WhenSome(func(kickoffFeerate chainfee.SatPerKWeight) { protoSats := uint32(kickoffFeerate) tlvRecords = append( tlvRecords, tlv.MakePrimitiveRecord( DPKickoffFeerate, &protoSats, ), ) }) tlv.SortRecords(tlvRecords) tlvStream, err := tlv.NewStream(tlvRecords...) if err != nil { return err } var extraBytesWriter bytes.Buffer if err := tlvStream.Encode(&extraBytesWriter); err != nil { return err } dp.ExtraData = ExtraOpaqueData(extraBytesWriter.Bytes()) if err := WriteChannelID(w, dp.ChanID); err != nil { return err } if err := WriteBool(w, dp.Initiator); err != nil { return err } return WriteBytes(w, dp.ExtraData) } // Decode deserializes the serialized DynPropose stored in the passed io.Reader // into the target DynPropose using the deserialization rules defined by the // passed protocol version. // // This is a part of the lnwire.Message interface. func (dp *DynPropose) Decode(r io.Reader, _ uint32) error { // Parse out the only required field. if err := ReadElements(r, &dp.ChanID, &dp.Initiator); err != nil { return err } // Parse out TLV stream. var tlvRecords ExtraOpaqueData if err := ReadElements(r, &tlvRecords); err != nil { return err } // Prepare receiving buffers to be filled by TLV extraction. var dustLimitScratch uint64 dustLimit := tlv.MakePrimitiveRecord( DPDustLimitSatoshis, &dustLimitScratch, ) var maxValueScratch uint64 maxValue := tlv.MakePrimitiveRecord( DPMaxHtlcValueInFlightMsat, &maxValueScratch, ) var reserveScratch uint64 reserve := tlv.MakePrimitiveRecord( DPChannelReserveSatoshis, &reserveScratch, ) var csvDelayScratch uint16 csvDelay := tlv.MakePrimitiveRecord(DPToSelfDelay, &csvDelayScratch) var maxHtlcsScratch uint16 maxHtlcs := tlv.MakePrimitiveRecord( DPMaxAcceptedHtlcs, &maxHtlcsScratch, ) var fundingKeyScratch *btcec.PublicKey fundingKey := tlv.MakePrimitiveRecord( DPFundingPubkey, &fundingKeyScratch, ) var chanTypeScratch ChannelType chanType := tlv.MakeDynamicRecord( DPChannelType, &chanTypeScratch, chanTypeScratch.featureBitLen, channelTypeEncoder, channelTypeDecoder, ) var kickoffFeerateScratch uint32 kickoffFeerate := tlv.MakePrimitiveRecord( DPKickoffFeerate, &kickoffFeerateScratch, ) // Create set of Records to read TLV bytestream into. records := []tlv.Record{ dustLimit, maxValue, reserve, csvDelay, maxHtlcs, fundingKey, chanType, kickoffFeerate, } tlv.SortRecords(records) // Read TLV stream into record set. extraBytesReader := bytes.NewReader(tlvRecords) tlvStream, err := tlv.NewStream(records...) if err != nil { return err } typeMap, err := tlvStream.DecodeWithParsedTypesP2P(extraBytesReader) if err != nil { return err } // Check the results of the TLV Stream decoding and appropriately set // message fields. if val, ok := typeMap[DPDustLimitSatoshis]; ok && val == nil { dp.DustLimit = fn.Some(btcutil.Amount(dustLimitScratch)) } if val, ok := typeMap[DPMaxHtlcValueInFlightMsat]; ok && val == nil { dp.MaxValueInFlight = fn.Some(MilliSatoshi(maxValueScratch)) } if val, ok := typeMap[DPChannelReserveSatoshis]; ok && val == nil { dp.ChannelReserve = fn.Some(btcutil.Amount(reserveScratch)) } if val, ok := typeMap[DPToSelfDelay]; ok && val == nil { dp.CsvDelay = fn.Some(csvDelayScratch) } if val, ok := typeMap[DPMaxAcceptedHtlcs]; ok && val == nil { dp.MaxAcceptedHTLCs = fn.Some(maxHtlcsScratch) } if val, ok := typeMap[DPFundingPubkey]; ok && val == nil { dp.FundingKey = fn.Some(*fundingKeyScratch) } if val, ok := typeMap[DPChannelType]; ok && val == nil { dp.ChannelType = fn.Some(chanTypeScratch) } if val, ok := typeMap[DPKickoffFeerate]; ok && val == nil { dp.KickoffFeerate = fn.Some( chainfee.SatPerKWeight(kickoffFeerateScratch), ) } if len(tlvRecords) != 0 { dp.ExtraData = tlvRecords } return nil } // MsgType returns the MessageType code which uniquely identifies this message // as a DynPropose on the wire. // // This is part of the lnwire.Message interface. func (dp *DynPropose) MsgType() MessageType { return MsgDynPropose }