multi: change rbf coop close from sat/vb to sat/kw

Author: MPins

itest/lnd_coop_close_rbf_test.go

@@ -30,19 +30,20 @@ func testCoopCloseRbf(ht *lntest.HarnessTest) {
 	// off the test.
 	//
 	// To start, we'll have Alice try to close the channel, with a fee rate
-	// of 5 sat/byte.
-	aliceFeeRate := chainfee.SatPerVByte(5)
+	// of 1250 sat/kw .
+	aliceFeeRate := chainfee.SatPerKWeight(1250)
 	aliceCloseStream, aliceCloseUpdate := ht.CloseChannelAssertPending(
 		alice, chanPoint, false,
 		lntest.WithCoopCloseFeeRate(aliceFeeRate),
 		lntest.WithLocalTxNotify(),
 	)
 
-	// Confirm that this new update was at 5 sat/vb.
+	// Confirm that this new update was at 1250 sat/kw.
 	alicePendingUpdate := aliceCloseUpdate.GetClosePending()
 	require.NotNil(ht, aliceCloseUpdate)
 	require.Equal(
-		ht, int64(aliceFeeRate), alicePendingUpdate.FeePerVbyte,
+		ht, int64(aliceFeeRate),
+		int64(alicePendingUpdate.FeePerKw),
 	)
 	require.True(ht, alicePendingUpdate.LocalCloseTx)
 
@@ -54,28 +55,38 @@ func testCoopCloseRbf(ht *lntest.HarnessTest) {
 		lntest.WithLocalTxNotify(),
 	)
 
-	// Confirm that this new update was at 10 sat/vb.
+	// Confirm that this new update was at 2500 sat/kw.
 	bobPendingUpdate := bobCloseUpdate.GetClosePending()
 	require.NotNil(ht, bobCloseUpdate)
-	require.Equal(ht, bobPendingUpdate.FeePerVbyte, int64(bobFeeRate))
+	require.Equal(
+		ht, int64(bobPendingUpdate.FeePerKw),
+		int64(bobFeeRate),
+	)
 	require.True(ht, bobPendingUpdate.LocalCloseTx)
 
 	var err error
 
 	// Alice should've also received a similar update that Bob has
-	// increased the closing fee rate to 10 sat/vb with his settled funds.
+	// increased the closing fee rate to 2500 sat/kw with his settled
+	// funds.
 	aliceCloseUpdate, err = ht.ReceiveCloseChannelUpdate(aliceCloseStream)
 	require.NoError(ht, err)
 	alicePendingUpdate = aliceCloseUpdate.GetClosePending()
 	require.NotNil(ht, aliceCloseUpdate)
-	require.Equal(ht, alicePendingUpdate.FeePerVbyte, int64(bobFeeRate))
+	// Using InDelta as fee rate calc might differ due to weight estimation
+	// versuns actual tx weight.
+	require.InDelta(
+		ht, int64(alicePendingUpdate.FeePerKw),
+		int64(bobFeeRate),
+		15,
+	)
 	require.False(ht, alicePendingUpdate.LocalCloseTx)
 
 	// We'll now attempt to make a fee update that increases Alice's fee
-	// rate by 6 sat/vb, which should be rejected as it is too small of an
-	// increase for the RBF rules. The RPC API however will return the new
-	// fee. We'll skip the mempool check here as it won't make it in.
-	aliceRejectedFeeRate := aliceFeeRate + 1
+	// rate by 1500 sat/kw, which should be rejected as it is too small of
+	// an increase for the RBF rules. The RPC API however will return the
+	// new fee. We'll skip the mempool check here as it won't make it in.
+	aliceRejectedFeeRate := aliceFeeRate + 250
 	_, aliceCloseUpdate = ht.CloseChannelAssertPending(
 		alice, chanPoint, false,
 		lntest.WithCoopCloseFeeRate(aliceRejectedFeeRate),
@@ -84,7 +95,7 @@ func testCoopCloseRbf(ht *lntest.HarnessTest) {
 	alicePendingUpdate = aliceCloseUpdate.GetClosePending()
 	require.NotNil(ht, aliceCloseUpdate)
 	require.Equal(
-		ht, alicePendingUpdate.FeePerVbyte,
+		ht, int64(alicePendingUpdate.FeePerKw),
 		int64(aliceRejectedFeeRate),
 	)
 	require.True(ht, alicePendingUpdate.LocalCloseTx)
@@ -108,7 +119,7 @@ func testCoopCloseRbf(ht *lntest.HarnessTest) {
 	ht.DisconnectNodes(alice, bob)
 	ht.ConnectNodes(alice, bob)
 
-	// Next, we'll have Alice double that fee rate again to 20 sat/vb.
+	// Next, we'll have Alice double that fee rate again to 5000 sat/kw.
 	aliceFeeRate = bobFeeRate * 2
 	aliceCloseStream, aliceCloseUpdate = ht.CloseChannelAssertPending(
 		alice, chanPoint, false,
@@ -119,7 +130,8 @@ func testCoopCloseRbf(ht *lntest.HarnessTest) {
 	alicePendingUpdate = aliceCloseUpdate.GetClosePending()
 	require.NotNil(ht, aliceCloseUpdate)
 	require.Equal(
-		ht, alicePendingUpdate.FeePerVbyte, int64(aliceFeeRate),
+		ht, int64(alicePendingUpdate.FeePerKw),
+		int64(aliceFeeRate),
 	)
 	require.True(ht, alicePendingUpdate.LocalCloseTx)
 

lnrpc/lightning.pb.go

@@ -2209,6 +2209,7 @@ message PendingUpdate {
     uint32 output_index = 2;
     int64 fee_per_vbyte = 3;
     bool local_close_tx = 4;
+    uint64 fee_per_kw = 5;
 }
 
 message InstantUpdate {

lnrpc/lightning.proto

@@ -7075,6 +7075,10 @@
         },
         "local_close_tx": {
           "type": "boolean"
+        },
+        "fee_per_kw": {
+          "type": "string",
+          "format": "uint64"
         }
       }
     },

lnrpc/lightning.swagger.json

@@ -1228,7 +1228,7 @@ func (h *HarnessTest) OpenChannelAssertErr(srcNode, destNode *node.HarnessNode,
 
 // closeChannelOpts holds the options for closing a channel.
 type closeChannelOpts struct {
-	feeRate fn.Option[chainfee.SatPerVByte]
+	feeRate fn.Option[chainfee.SatPerKWeight]
 
 	// localTxOnly is a boolean indicating if we should only attempt to
 	// consume close pending notifications for the local transaction.
@@ -1249,7 +1249,7 @@ type CloseChanOpt func(*closeChannelOpts)
 
 // WithCoopCloseFeeRate is a functional option to set the fee rate for a coop
 // close attempt.
-func WithCoopCloseFeeRate(rate chainfee.SatPerVByte) CloseChanOpt {
+func WithCoopCloseFeeRate(rate chainfee.SatPerKWeight) CloseChanOpt {
 	return func(o *closeChannelOpts) {
 		o.feeRate = fn.Some(rate)
 	}
@@ -1307,8 +1307,8 @@ func (h *HarnessTest) CloseChannelAssertPending(hn *node.HarnessNode,
 		NoWait:       true,
 	}
 
-	closeOpts.feeRate.WhenSome(func(feeRate chainfee.SatPerVByte) {
-		closeReq.SatPerVbyte = uint64(feeRate)
+	closeOpts.feeRate.WhenSome(func(feeRate chainfee.SatPerKWeight) {
+		closeReq.SatPerKw = uint64(feeRate)
 	})
 
 	var (
@@ -1348,9 +1348,9 @@ func (h *HarnessTest) CloseChannelAssertPending(hn *node.HarnessNode,
 			continue
 		}
 
-		notifyRate := pendingClose.ClosePending.FeePerVbyte
+		notifyRate := pendingClose.ClosePending.FeePerKw
 		if closeOpts.localTxOnly &&
-			notifyRate != int64(closeReq.SatPerVbyte) {
+			notifyRate != closeReq.SatPerKw {
 
 			continue
 		}

lntest/harness.go

@@ -100,7 +100,7 @@ type SendShutdown struct {
 
 	// IdealFeeRate is the ideal fee rate we'd like to use for the closing
 	// attempt.
-	IdealFeeRate chainfee.SatPerVByte
+	IdealFeeRate chainfee.SatPerKWeight
 }
 
 // protocolSealed indicates that this struct is a ProtocolEvent instance.
@@ -182,7 +182,7 @@ func (c *ChannelFlushed) protocolSealed() {}
 //   - toState: LocalOfferSent
 type SendOfferEvent struct {
 	// TargetFeeRate is the fee rate we'll use for the closing transaction.
-	TargetFeeRate chainfee.SatPerVByte
+	TargetFeeRate chainfee.SatPerKWeight
 }
 
 // protocolSealed indicates that this struct is a ProtocolEvent instance.
@@ -304,7 +304,7 @@ type Environment struct {
 	// DefaultFeeRate is the fee we'll use for the closing transaction if
 	// the user didn't specify an ideal fee rate. This may happen if the
 	// remote party is the one that initiates the co-op close.
-	DefaultFeeRate chainfee.SatPerVByte
+	DefaultFeeRate chainfee.SatPerKWeight
 
 	// ThawHeight is the height at which the channel will be thawed. If
 	// this is None, then co-op close can occur at any moment.
@@ -453,7 +453,7 @@ type ShutdownPending struct {
 
 	// IdealFeeRate is the ideal fee rate we'd like to use for the closing
 	// attempt.
-	IdealFeeRate fn.Option[chainfee.SatPerVByte]
+	IdealFeeRate fn.Option[chainfee.SatPerKWeight]
 
 	// EarlyRemoteOffer is the offer we received from the remote party
 	// before we received their shutdown message. We'll stash it to process
@@ -498,7 +498,7 @@ type ChannelFlushing struct {
 	// IdealFeeRate is the ideal fee rate we'd like to use for the closing
 	// transaction. Once the channel has been flushed, we'll use this as
 	// our target fee rate.
-	IdealFeeRate fn.Option[chainfee.SatPerVByte]
+	IdealFeeRate fn.Option[chainfee.SatPerKWeight]
 }
 
 // String returns the name of the state for ChannelFlushing.
@@ -732,7 +732,7 @@ type LocalOfferSent struct {
 	ProposedFee btcutil.Amount
 
 	// ProposedFeeRate is the fee rate we proposed to the remote party.
-	ProposedFeeRate chainfee.SatPerVByte
+	ProposedFeeRate chainfee.SatPerKWeight
 
 	// LocalSig is the signature we sent to the remote party.
 	LocalSig lnwire.Sig
@@ -781,7 +781,7 @@ type ClosePending struct {
 	*CloseChannelTerms
 
 	// FeeRate is the fee rate of the closing transaction.
-	FeeRate chainfee.SatPerVByte
+	FeeRate chainfee.SatPerKWeight
 
 	// Party indicates which party is at this state. This is used to
 	// implement the state transition properly, based on ShouldRouteTo.

lnwallet/chancloser/rbf_coop_states.go

@@ -783,7 +783,7 @@ func newRbfCloserTestHarness(t *testing.T,
 		ChanPoint:             chanPoint,
 		ChanID:                chanID,
 		Scid:                  scid,
-		DefaultFeeRate:        defaultFeeRate.FeePerVByte(),
+		DefaultFeeRate:        defaultFeeRate,
 		ThawHeight:            cfg.thawHeight,
 		RemoteUpfrontShutdown: cfg.remoteUpfrontAddr,
 		LocalUpfrontShutdown:  cfg.localUpfrontAddr,
@@ -854,7 +854,7 @@ func TestRbfChannelActiveTransitions(t *testing.T) {
 	localAddr := lnwire.DeliveryAddress(bytes.Repeat([]byte{0x01}, 20))
 	remoteAddr := lnwire.DeliveryAddress(bytes.Repeat([]byte{0x02}, 20))
 
-	feeRate := chainfee.SatPerVByte(1000)
+	feeRate := chainfee.SatPerKWeight(250000)
 
 	// Test that if a spend event is received, the FSM transitions to the
 	// CloseFin terminal state.
@@ -1050,7 +1050,7 @@ func TestRbfShutdownPendingTransitions(t *testing.T) {
 	t.Run("initiator_shutdown_recv_ok", func(t *testing.T) {
 		firstState := *startingState
 		firstState.IdealFeeRate = fn.Some(
-			chainfee.FeePerKwFloor.FeePerVByte(),
+			chainfee.FeePerKwFloor,
 		)
 		firstState.ShutdownScripts = ShutdownScripts{
 			LocalDeliveryScript:  localAddr,
@@ -1097,7 +1097,7 @@ func TestRbfShutdownPendingTransitions(t *testing.T) {
 	t.Run("responder_complete", func(t *testing.T) {
 		firstState := *startingState
 		firstState.IdealFeeRate = fn.Some(
-			chainfee.FeePerKwFloor.FeePerVByte(),
+			chainfee.FeePerKwFloor,
 		)
 		firstState.ShutdownScripts = ShutdownScripts{
 			LocalDeliveryScript:  localAddr,
@@ -1128,7 +1128,7 @@ func TestRbfShutdownPendingTransitions(t *testing.T) {
 	t.Run("early_remote_offer_shutdown_complete", func(t *testing.T) {
 		firstState := *startingState
 		firstState.IdealFeeRate = fn.Some(
-			chainfee.FeePerKwFloor.FeePerVByte(),
+			chainfee.FeePerKwFloor,
 		)
 		firstState.ShutdownScripts = ShutdownScripts{
 			LocalDeliveryScript:  localAddr,
@@ -1175,7 +1175,7 @@ func TestRbfShutdownPendingTransitions(t *testing.T) {
 	t.Run("early_remote_offer_shutdown_received", func(t *testing.T) {
 		firstState := *startingState
 		firstState.IdealFeeRate = fn.Some(
-			chainfee.FeePerKwFloor.FeePerVByte(),
+			chainfee.FeePerKwFloor,
 		)
 		firstState.ShutdownScripts = ShutdownScripts{
 			LocalDeliveryScript:  localAddr,
@@ -1433,7 +1433,7 @@ func TestRbfCloseClosingNegotiationLocal(t *testing.T) {
 	}
 
 	sendOfferEvent := &SendOfferEvent{
-		TargetFeeRate: chainfee.FeePerKwFloor.FeePerVByte(),
+		TargetFeeRate: chainfee.FeePerKwFloor,
 	}
 
 	balanceAfterClose := localBalance.ToSatoshis() - absoluteFee
@@ -1614,7 +1614,7 @@ func TestRbfCloseClosingNegotiationLocal(t *testing.T) {
 		// Next, we'll send in a new SendOfferEvent event which
 		// simulates the user requesting a RBF fee bump. We'll use 10x
 		// the fee we used in the last iteration.
-		rbfFeeBump := chainfee.FeePerKwFloor.FeePerVByte() * 10
+		rbfFeeBump := chainfee.FeePerKwFloor * 10
 		localOffer := &SendOfferEvent{
 			TargetFeeRate: rbfFeeBump,
 		}
@@ -1649,7 +1649,7 @@ func TestRbfCloseClosingNegotiationLocal(t *testing.T) {
 		// the amount we have in the channel.
 		closeHarness.expectFeeEstimate(btcutil.SatoshiPerBitcoin, 1)
 
-		rbfFeeBump := chainfee.FeePerKwFloor.FeePerVByte()
+		rbfFeeBump := chainfee.FeePerKwFloor
 		localOffer := &SendOfferEvent{
 			TargetFeeRate: rbfFeeBump,
 		}
@@ -1997,7 +1997,7 @@ func TestRbfCloseErr(t *testing.T) {
 		})
 		defer closeHarness.stopAndAssert()
 
-		rbfFeeBump := chainfee.FeePerKwFloor.FeePerVByte()
+		rbfFeeBump := chainfee.FeePerKwFloor
 		localOffer := &SendOfferEvent{
 			TargetFeeRate: rbfFeeBump,
 		}

lnwallet/chancloser/rbf_coop_test.go

@@ -4,6 +4,7 @@ import (
 	"bytes"
 	"fmt"
 
+	"github.com/btcsuite/btcd/blockchain"
 	"github.com/btcsuite/btcd/btcec/v2"
 	"github.com/btcsuite/btcd/btcutil"
 	"github.com/btcsuite/btcd/chaincfg"
@@ -509,7 +510,7 @@ func (c *ChannelFlushing) ProcessEvent(event ProtocolEvent,
 		localTxOut, remoteTxOut := closeTerms.DeriveCloseTxOuts()
 		absoluteFee := env.FeeEstimator.EstimateFee(
 			env.ChanType, localTxOut, remoteTxOut,
-			idealFeeRate.FeePerKWeight(),
+			idealFeeRate,
 		)
 
 		chancloserLog.Infof("ChannelPoint(%v): using ideal_fee=%v, "+
@@ -752,7 +753,7 @@ func (l *LocalCloseStart) ProcessEvent(event ProtocolEvent,
 		localTxOut, remoteTxOut := l.DeriveCloseTxOuts()
 		absoluteFee := env.FeeEstimator.EstimateFee(
 			env.ChanType, localTxOut, remoteTxOut,
-			msg.TargetFeeRate.FeePerKWeight(),
+			msg.TargetFeeRate,
 		)
 
 		// If we can't actually pay for fees here, then we'll just do a
@@ -1128,10 +1129,16 @@ func (l *RemoteCloseStart) ProcessEvent(event ProtocolEvent,
 		// We'll also compute the final fee rate that the remote party
 		// paid based off the absolute fee and the size of the closing
 		// transaction.
-		vSize := mempool.GetTxVirtualSize(btcutil.NewTx(closeTx))
-		feeRate := chainfee.SatPerVByte(
-			int64(msg.SigMsg.FeeSatoshis) / vSize,
-		)
+		tx := btcutil.NewTx(closeTx)
+		total := int64(tx.MsgTx().SerializeSize())
+		base := int64(tx.MsgTx().SerializeSizeStripped())
+		den := base*(blockchain.WitnessScaleFactor) + (total - base)
+
+		// Round to the next integer.
+		num := int64(msg.SigMsg.FeeSatoshis) * 1000
+		rate := (num + den - 1) / den
+
+		feeRate := chainfee.SatPerKWeight(rate)
 
 		// Now that we've extracted the signature, we'll transition to
 		// the next state where we'll sign+broadcast the sig.