lntest/itest+lnwallet: add legacy chanrestore test
The test makes use of a nextRevocationProducer that is only used during integration tests.
This commit is contained in:
eugene
parent
bb84f0ebc8
commit
99a7271289
@ -16,6 +16,7 @@ import (
|
||||
"github.com/btcsuite/btcutil"
|
||||
"github.com/lightningnetwork/lnd/chanbackup"
|
||||
"github.com/lightningnetwork/lnd/lnrpc"
|
||||
"github.com/lightningnetwork/lnd/lnrpc/walletrpc"
|
||||
"github.com/lightningnetwork/lnd/lntest"
|
||||
"github.com/lightningnetwork/lnd/lntest/wait"
|
||||
"github.com/stretchr/testify/require"
|
||||
@ -356,6 +357,37 @@ func testChannelBackupRestore(net *lntest.NetworkHarness, t *harnessTest) {
|
||||
)
|
||||
},
|
||||
},
|
||||
|
||||
// Restore by also creating a channel with the legacy revocation
|
||||
// producer format to make sure old SCBs can still be recovered.
|
||||
{
|
||||
name: "old revocation producer format",
|
||||
initiator: true,
|
||||
legacyRevocation: true,
|
||||
restoreMethod: func(oldNode *lntest.HarnessNode,
|
||||
backupFilePath string,
|
||||
mnemonic []string) (nodeRestorer, error) {
|
||||
|
||||
// For this restoration method, we'll grab the
|
||||
// current multi-channel backup from the old
|
||||
// node, and use it to restore a new node
|
||||
// within the closure.
|
||||
req := &lnrpc.ChanBackupExportRequest{}
|
||||
chanBackup, err := oldNode.ExportAllChannelBackups(
|
||||
ctxb, req,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
multi := chanBackup.MultiChanBackup.MultiChanBackup
|
||||
|
||||
// In our nodeRestorer function, we'll restore
|
||||
// the node from seed, then manually recover the
|
||||
// channel backup.
|
||||
return chanRestoreViaRPC(
|
||||
net, password, mnemonic, multi,
|
||||
)
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
// TODO(roasbeef): online vs offline close?
|
||||
@ -765,6 +797,10 @@ type chanRestoreTestCase struct {
|
||||
// used for the channels created in the test.
|
||||
anchorCommit bool
|
||||
|
||||
// legacyRevocation signals if a channel with the legacy revocation
|
||||
// producer format should also be created before restoring.
|
||||
legacyRevocation bool
|
||||
|
||||
// restoreMethod takes an old node, then returns a function
|
||||
// closure that'll return the same node, but with its state
|
||||
// restored via a custom method. We use this to abstract away
|
||||
@ -867,6 +903,13 @@ func testChanRestoreScenario(t *harnessTest, net *lntest.NetworkHarness,
|
||||
t.Fatalf("channel backup not updated in time: %v", err)
|
||||
}
|
||||
|
||||
// Also create channels with the legacy revocation producer format if
|
||||
// requested.
|
||||
case testCase.legacyRevocation:
|
||||
createLegacyRevocationChannel(
|
||||
net, t, chanAmt, pushAmt, from, to,
|
||||
)
|
||||
|
||||
default:
|
||||
ctxt, _ = context.WithTimeout(ctxb, channelOpenTimeout)
|
||||
chanPoint := openChannelAndAssert(
|
||||
@ -1068,6 +1111,117 @@ func testChanRestoreScenario(t *harnessTest, net *lntest.NetworkHarness,
|
||||
)
|
||||
}
|
||||
|
||||
// createLegacyRevocationChannel creates a single channel using the legacy
|
||||
// revocation producer format by using PSBT to signal a special pending channel
|
||||
// ID.
|
||||
func createLegacyRevocationChannel(net *lntest.NetworkHarness, t *harnessTest,
|
||||
chanAmt, pushAmt btcutil.Amount, from, to *lntest.HarnessNode) {
|
||||
|
||||
ctxb := context.Background()
|
||||
|
||||
// We'll signal to the wallet that we also want to create a channel with
|
||||
// the legacy revocation producer format that relies on deriving a
|
||||
// private key from the key ring. This is only available during itests
|
||||
// to make sure we don't hard depend on the DerivePrivKey method of the
|
||||
// key ring. We can signal the wallet by setting a custom pending
|
||||
// channel ID. To be able to do that, we need to set a funding shim
|
||||
// which is easiest by using PSBT funding. The ID is the hex
|
||||
// representation of the string "legacy-revocation".
|
||||
itestLegacyFormatChanID := [32]byte{
|
||||
0x6c, 0x65, 0x67, 0x61, 0x63, 0x79, 0x2d, 0x72, 0x65, 0x76,
|
||||
0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e,
|
||||
}
|
||||
ctxt, cancel := context.WithTimeout(ctxb, defaultTimeout)
|
||||
defer cancel()
|
||||
openChannelReq := lntest.OpenChannelParams{
|
||||
Amt: chanAmt,
|
||||
PushAmt: pushAmt,
|
||||
FundingShim: &lnrpc.FundingShim{
|
||||
Shim: &lnrpc.FundingShim_PsbtShim{
|
||||
PsbtShim: &lnrpc.PsbtShim{
|
||||
PendingChanId: itestLegacyFormatChanID[:],
|
||||
},
|
||||
},
|
||||
},
|
||||
}
|
||||
chanUpdates, tempPsbt, err := openChannelPsbt(
|
||||
ctxt, from, to, openChannelReq,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Fund the PSBT by using the source node's wallet.
|
||||
ctxt, cancel = context.WithTimeout(ctxb, defaultTimeout)
|
||||
defer cancel()
|
||||
fundReq := &walletrpc.FundPsbtRequest{
|
||||
Template: &walletrpc.FundPsbtRequest_Psbt{
|
||||
Psbt: tempPsbt,
|
||||
},
|
||||
Fees: &walletrpc.FundPsbtRequest_SatPerVbyte{
|
||||
SatPerVbyte: 2,
|
||||
},
|
||||
}
|
||||
fundResp, err := from.WalletKitClient.FundPsbt(ctxt, fundReq)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// We have a PSBT that has no witness data yet, which is exactly what we
|
||||
// need for the next step of verifying the PSBT with the funding intents.
|
||||
_, err = from.FundingStateStep(ctxb, &lnrpc.FundingTransitionMsg{
|
||||
Trigger: &lnrpc.FundingTransitionMsg_PsbtVerify{
|
||||
PsbtVerify: &lnrpc.FundingPsbtVerify{
|
||||
PendingChanId: itestLegacyFormatChanID[:],
|
||||
FundedPsbt: fundResp.FundedPsbt,
|
||||
},
|
||||
},
|
||||
})
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Now we'll ask the source node's wallet to sign the PSBT so we can
|
||||
// finish the funding flow.
|
||||
ctxt, cancel = context.WithTimeout(ctxb, defaultTimeout)
|
||||
defer cancel()
|
||||
finalizeReq := &walletrpc.FinalizePsbtRequest{
|
||||
FundedPsbt: fundResp.FundedPsbt,
|
||||
}
|
||||
finalizeRes, err := from.WalletKitClient.FinalizePsbt(
|
||||
ctxt, finalizeReq,
|
||||
)
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// We've signed our PSBT now, let's pass it to the intent again.
|
||||
_, err = from.FundingStateStep(ctxb, &lnrpc.FundingTransitionMsg{
|
||||
Trigger: &lnrpc.FundingTransitionMsg_PsbtFinalize{
|
||||
PsbtFinalize: &lnrpc.FundingPsbtFinalize{
|
||||
PendingChanId: itestLegacyFormatChanID[:],
|
||||
SignedPsbt: finalizeRes.SignedPsbt,
|
||||
},
|
||||
},
|
||||
})
|
||||
require.NoError(t.t, err)
|
||||
|
||||
// Consume the "channel pending" update. This waits until the funding
|
||||
// transaction was fully compiled.
|
||||
ctxt, cancel = context.WithTimeout(ctxb, defaultTimeout)
|
||||
defer cancel()
|
||||
updateResp, err := receiveChanUpdate(ctxt, chanUpdates)
|
||||
require.NoError(t.t, err)
|
||||
upd, ok := updateResp.Update.(*lnrpc.OpenStatusUpdate_ChanPending)
|
||||
require.True(t.t, ok)
|
||||
chanPoint := &lnrpc.ChannelPoint{
|
||||
FundingTxid: &lnrpc.ChannelPoint_FundingTxidBytes{
|
||||
FundingTxidBytes: upd.ChanPending.Txid,
|
||||
},
|
||||
OutputIndex: upd.ChanPending.OutputIndex,
|
||||
}
|
||||
|
||||
_ = mineBlocks(t, net, 6, 1)
|
||||
ctxt, cancel = context.WithTimeout(ctxb, defaultTimeout)
|
||||
defer cancel()
|
||||
err = from.WaitForNetworkChannelOpen(ctxt, chanPoint)
|
||||
require.NoError(t.t, err)
|
||||
err = to.WaitForNetworkChannelOpen(ctxt, chanPoint)
|
||||
require.NoError(t.t, err)
|
||||
}
|
||||
|
||||
// chanRestoreViaRPC is a helper test method that returns a nodeRestorer
|
||||
// instance which will restore the target node from a password+seed, then
|
||||
// trigger a SCB restore using the RPC interface.
|
||||
|
||||
77
lnwallet/revocation_producer_itest.go
Normal file
77
lnwallet/revocation_producer_itest.go
Normal file
@ -0,0 +1,77 @@
|
||||
// +build rpctest
|
||||
|
||||
package lnwallet
|
||||
|
||||
import (
|
||||
"github.com/btcsuite/btcd/chaincfg/chainhash"
|
||||
"github.com/lightningnetwork/lnd/keychain"
|
||||
"github.com/lightningnetwork/lnd/shachain"
|
||||
)
|
||||
|
||||
// nextRevocationProducer creates a new revocation producer, deriving the
|
||||
// revocation root by applying ECDH to a new key from our revocation root family
|
||||
// and the multisig key we use for the channel.
|
||||
func (l *LightningWallet) nextRevocationProducer(res *ChannelReservation,
|
||||
keyRing keychain.KeyRing) (shachain.Producer, error) {
|
||||
|
||||
// Derive the next key in the revocation root family.
|
||||
nextRevocationKeyDesc, err := keyRing.DeriveNextKey(
|
||||
keychain.KeyFamilyRevocationRoot,
|
||||
)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Within our itests, we want to make sure we can still restore channel
|
||||
// backups created with the old revocation root derivation method. To
|
||||
// create a channel in the legacy format during the test, we signal this
|
||||
// by setting an explicit pending channel ID. The ID is the hex
|
||||
// representation of the string "legacy-revocation".
|
||||
itestLegacyFormatChanID := [32]byte{
|
||||
0x6c, 0x65, 0x67, 0x61, 0x63, 0x79, 0x2d, 0x72, 0x65, 0x76,
|
||||
0x6f, 0x63, 0x61, 0x74, 0x69, 0x6f, 0x6e,
|
||||
}
|
||||
if res.pendingChanID == itestLegacyFormatChanID {
|
||||
revocationRoot, err := l.DerivePrivKey(nextRevocationKeyDesc)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Once we have the root, we can then generate our shachain
|
||||
// producer and from that generate the per-commitment point.
|
||||
revRoot, err := chainhash.NewHash(revocationRoot.Serialize())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return shachain.NewRevocationProducer(*revRoot), nil
|
||||
}
|
||||
|
||||
// If the DeriveNextKey call returns the first key with Index 0, we need
|
||||
// to re-derive the key as the keychain/btcwallet.go DerivePrivKey call
|
||||
// special-cases Index 0.
|
||||
if nextRevocationKeyDesc.Index == 0 {
|
||||
nextRevocationKeyDesc, err = keyRing.DeriveNextKey(
|
||||
keychain.KeyFamilyRevocationRoot,
|
||||
)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
|
||||
res.nextRevocationKeyLoc = nextRevocationKeyDesc.KeyLocator
|
||||
|
||||
// Perform an ECDH operation between the private key described in
|
||||
// nextRevocationKeyDesc and our public multisig key. The result will be
|
||||
// used to seed the revocation producer.
|
||||
revRoot, err := l.ECDH(
|
||||
nextRevocationKeyDesc, res.ourContribution.MultiSigKey.PubKey,
|
||||
)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// Once we have the root, we can then generate our shachain producer
|
||||
// and from that generate the per-commitment point.
|
||||
return shachain.NewRevocationProducer(revRoot), nil
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user