lnwallet+walletrpc: add WalletKit.SubmitPackage for v3 CPFP package relay #10900
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,206 @@ | ||
| package itest | ||
|
|
||
| import ( | ||
| "bytes" | ||
|
|
||
| btcaddr "github.com/btcsuite/btcd/address/v2" | ||
| "github.com/btcsuite/btcd/btcec/v2" | ||
| "github.com/btcsuite/btcd/btcutil/v2" | ||
| "github.com/btcsuite/btcd/txscript/v2" | ||
| "github.com/btcsuite/btcd/wire/v2" | ||
| "github.com/lightningnetwork/lnd/lnrpc" | ||
| "github.com/lightningnetwork/lnd/lnrpc/signrpc" | ||
| "github.com/lightningnetwork/lnd/lnrpc/walletrpc" | ||
| "github.com/lightningnetwork/lnd/lntest" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| // testSubmitPackage tests that the WalletKit.SubmitPackage RPC relays a v3 | ||
| // (TRUC) transaction package: a zero-fee parent that would be rejected by a | ||
| // standalone broadcast (below the minimum relay fee) is accepted together with | ||
| // a fee-paying CPFP child whose combined package feerate clears policy. | ||
| // | ||
| // This requires a bitcoind chain backend, as btcd has no submitpackage RPC and | ||
| // cannot relay zero-fee v3 transactions; run with backend=bitcoind. The | ||
| // zero-fee parent can only enter the mempool via package evaluation (a | ||
| // standalone submission is rejected for the min relay fee), so a successful | ||
| // SubmitPackage proves the CPFP package path worked end to end. | ||
| func testSubmitPackage(ht *lntest.HarnessTest) { | ||
| // submitpackage is a bitcoind RPC: btcd has no equivalent and neutrino | ||
| // has no mempool, so this test only applies to the bitcoind backend. | ||
| if ht.ChainBackendName() != "bitcoind" { | ||
|
Collaborator
There was a problem hiding this comment. could we also run it with neutrino? as the implementation would suggest it works there
Collaborator
Author
There was a problem hiding this comment. good point — it does work on neutrino, but only against a package-aware miner. neutrino has no mempool, so |
||
| ht.Skipf("submitpackage requires the bitcoind backend, got %v", | ||
| ht.ChainBackendName()) | ||
| } | ||
|
|
||
| // The zero-fee v3 parent only propagates to (and is observable in) the | ||
| // mempool of a package-relay-capable node, so the miner must also be | ||
| // bitcoind. With the default btcd miner the package is submitted to | ||
| // Alice's bitcoind successfully but never relays to the miner, so the | ||
| // mempool assertions below would time out. | ||
| if ht.Miner().BackendName() != "bitcoind" { | ||
| ht.Skipf("submitpackage requires a bitcoind miner for the "+ | ||
| "zero-fee v3 package to relay, got %v miner", | ||
| ht.Miner().BackendName()) | ||
| } | ||
|
|
||
| alice := ht.NewNodeWithCoins("Alice", nil) | ||
|
|
||
| const ( | ||
| fundAmt = int64(btcutil.SatoshiPerBitcoin) | ||
|
|
||
| // childFee is paid by the child for the whole package. It | ||
| // must cover both transactions' weight at >= the min relay | ||
| // fee; a few thousand sats is comfortably above that. | ||
| childFee = int64(20_000) | ||
|
|
||
| // p2wkhKeyFamily is a custom key family so the derived keys | ||
| // (and thus the addresses we control via SignOutputRaw) are | ||
| // independent of the node's normal key usage. | ||
| p2wkhKeyFamily = 44 | ||
| ) | ||
|
|
||
| // p2wkhKey derives a fresh key and returns it together with the p2wkh | ||
| // address/pkScript it controls, which we can later spend via the | ||
| // SignOutputRaw RPC. | ||
| p2wkhKey := func() (*signrpc.KeyDescriptor, *btcec.PublicKey, | ||
| btcaddr.Address, []byte) { | ||
|
|
||
| keyDesc := alice.RPC.DeriveNextKey(&walletrpc.KeyReq{ | ||
| KeyFamily: p2wkhKeyFamily, | ||
| }) | ||
|
|
||
| pubKey, err := btcec.ParsePubKey(keyDesc.RawKeyBytes) | ||
| require.NoError(ht, err) | ||
|
|
||
| addr, err := btcaddr.NewAddressWitnessPubKeyHash( | ||
| btcaddr.Hash160(pubKey.SerializeCompressed()), | ||
| harnessNetParams, | ||
| ) | ||
| require.NoError(ht, err) | ||
|
|
||
| pkScript, err := txscript.PayToAddrScript(addr) | ||
| require.NoError(ht, err) | ||
|
|
||
| return keyDesc, pubKey, addr, pkScript | ||
| } | ||
|
|
||
| // signP2WKHInput signs input idx of tx (spending a p2wkh output | ||
| // with the given pkScript and value) via SignOutputRaw and attaches | ||
| // the witness. | ||
| signP2WKHInput := func(tx *wire.MsgTx, idx int, pkScript []byte, | ||
| value int64, keyDesc *signrpc.KeyDescriptor, | ||
| pubKey *btcec.PublicKey) { | ||
|
|
||
| var buf bytes.Buffer | ||
| require.NoError(ht, tx.Serialize(&buf)) | ||
|
|
||
| signResp := alice.RPC.SignOutputRaw(&signrpc.SignReq{ | ||
| RawTxBytes: buf.Bytes(), | ||
| SignDescs: []*signrpc.SignDescriptor{{ | ||
| Output: &signrpc.TxOut{ | ||
| PkScript: pkScript, | ||
| Value: value, | ||
| }, | ||
| InputIndex: int32(idx), | ||
| KeyDesc: keyDesc, | ||
| Sighash: uint32(txscript.SigHashAll), | ||
| WitnessScript: pkScript, | ||
| }}, | ||
| }) | ||
|
|
||
| tx.TxIn[idx].Witness = wire.TxWitness{ | ||
| append(signResp.RawSigs[0], byte(txscript.SigHashAll)), | ||
| pubKey.SerializeCompressed(), | ||
| } | ||
| } | ||
|
|
||
| serialize := func(tx *wire.MsgTx) []byte { | ||
| var buf bytes.Buffer | ||
| require.NoError(ht, tx.Serialize(&buf)) | ||
|
|
||
| return buf.Bytes() | ||
| } | ||
|
|
||
| // Fund a p2wkh output we control: send coins to a key-derived | ||
| // address and confirm it, so the parent has a confirmed input to spend. | ||
| parentInKey, parentInPub, parentInAddr, parentInScript := p2wkhKey() | ||
| alice.RPC.SendCoins(&lnrpc.SendCoinsRequest{ | ||
| Addr: parentInAddr.String(), | ||
| Amount: fundAmt, | ||
| TargetConf: 6, | ||
| }) | ||
| fundTxid := ht.AssertNumTxsInMempool(1)[0] | ||
| fundOutIdx := ht.GetOutputIndex(fundTxid, parentInAddr.String()) | ||
| ht.MineBlocksAndAssertNumTxes(1, 1) | ||
|
|
||
| // The child will spend the parent's output, so derive a key we control | ||
| // for it and use its script as the parent's output. | ||
| childInKey, childInPub, _, childInScript := p2wkhKey() | ||
|
|
||
| // Build the zero-fee v3 parent: spend the confirmed input and pay the | ||
| // full value to the child-input script, leaving no fee. | ||
| parent := wire.NewMsgTx(3) | ||
| parent.AddTxIn(&wire.TxIn{ | ||
| PreviousOutPoint: wire.OutPoint{ | ||
| Hash: fundTxid, | ||
| Index: uint32(fundOutIdx), | ||
| }, | ||
| }) | ||
| parent.AddTxOut(wire.NewTxOut(fundAmt, childInScript)) | ||
| signP2WKHInput( | ||
| parent, 0, parentInScript, fundAmt, parentInKey, parentInPub, | ||
| ) | ||
|
|
||
| // Build the v3 CPFP child: spend the parent's unconfirmed output | ||
| // and pay childFee, which covers the whole package. | ||
| childOut := alice.RPC.NewAddress(&lnrpc.NewAddressRequest{ | ||
| Type: AddrTypeWitnessPubkeyHash, | ||
| }) | ||
| childOutAddr, err := btcaddr.DecodeAddress( | ||
| childOut.Address, harnessNetParams, | ||
| ) | ||
| require.NoError(ht, err) | ||
| childOutScript, err := txscript.PayToAddrScript(childOutAddr) | ||
| require.NoError(ht, err) | ||
|
|
||
| child := wire.NewMsgTx(3) | ||
| child.AddTxIn(&wire.TxIn{ | ||
| PreviousOutPoint: wire.OutPoint{ | ||
| Hash: parent.TxHash(), | ||
| Index: 0, | ||
| }, | ||
| }) | ||
| child.AddTxOut(wire.NewTxOut(fundAmt-childFee, childOutScript)) | ||
| signP2WKHInput(child, 0, childInScript, fundAmt, childInKey, childInPub) | ||
|
|
||
| // Submit the two transactions as a package. A max fee rate of 0 | ||
| // disables the fee-rate ceiling so a high-feerate CPFP child is | ||
| // never rejected. | ||
| noFeeLimit := uint64(0) | ||
| resp := alice.RPC.SubmitPackage(&walletrpc.SubmitPackageRequest{ | ||
| RawTxs: [][]byte{serialize(parent), serialize(child)}, | ||
| SatPerVbyte: &noFeeLimit, | ||
| }) | ||
|
|
||
| // The whole package must be accepted, with a per-tx result (keyed by | ||
| // wtxid) for each transaction and no per-tx error. | ||
| require.Equal(ht, "success", resp.PackageMsg) | ||
| require.Len(ht, resp.TxResults, 2) | ||
| for _, txResult := range resp.TxResults { | ||
| require.Emptyf( | ||
| ht, txResult.Error, "tx %s rejected", txResult.Txid, | ||
| ) | ||
| } | ||
|
ellemouton marked this conversation as resolved.
|
||
|
|
||
| // The accepted package must now be in the mempool: both the zero-fee | ||
| // parent and its fee-paying CPFP child. This proves the package | ||
| // actually relayed, not merely that the RPC returned success. | ||
| ht.AssertTxInMempool(parent.TxHash()) | ||
| ht.AssertTxInMempool(child.TxHash()) | ||
|
|
||
| // Mine the package so it confirms (the strongest end-to-end proof the | ||
| // CPFP package relayed) and the mempool is clean for the harness's | ||
| // end-of-test teardown check. | ||
| ht.MineBlocksAndAssertNumTxes(1, 2) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.