f0911765af
In this commit, we migrate all the code in `channeldb` to only reference the new `kvdb` package rather than `bbolt` directly. In many instances, we need to add two version to fetch a bucket as both read and write when needed. As an example, we add a new `fetchChanBucketRw` function. This function is identical to `fetchChanBucket`, but it will be used to fetch the main channel bucket for all _write_ transactions. We need a new method as you can pass a write transaction where a read is accepted, but not the other way around due to the stronger typing of the new `kvdb` package.
928 lines
26 KiB
Go
928 lines
26 KiB
Go
package migration_01_to_11
|
|
|
|
import (
|
|
"bytes"
|
|
"crypto/sha256"
|
|
"encoding/binary"
|
|
"fmt"
|
|
"math/rand"
|
|
"reflect"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/btcsuite/btcutil"
|
|
"github.com/davecgh/go-spew/spew"
|
|
"github.com/go-errors/errors"
|
|
"github.com/lightningnetwork/lnd/channeldb/kvdb"
|
|
"github.com/lightningnetwork/lnd/lntypes"
|
|
"github.com/lightningnetwork/lnd/lnwire"
|
|
)
|
|
|
|
// TestPaymentStatusesMigration checks that already completed payments will have
|
|
// their payment statuses set to Completed after the migration.
|
|
func TestPaymentStatusesMigration(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
fakePayment := makeFakePayment()
|
|
paymentHash := sha256.Sum256(fakePayment.PaymentPreimage[:])
|
|
|
|
// Add fake payment to test database, verifying that it was created,
|
|
// that we have only one payment, and its status is not "Completed".
|
|
beforeMigrationFunc := func(d *DB) {
|
|
if err := d.addPayment(fakePayment); err != nil {
|
|
t.Fatalf("unable to add payment: %v", err)
|
|
}
|
|
|
|
payments, err := d.fetchAllPayments()
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payments: %v", err)
|
|
}
|
|
|
|
if len(payments) != 1 {
|
|
t.Fatalf("wrong qty of paymets: expected 1, got %v",
|
|
len(payments))
|
|
}
|
|
|
|
paymentStatus, err := d.fetchPaymentStatus(paymentHash)
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payment status: %v", err)
|
|
}
|
|
|
|
// We should receive default status if we have any in database.
|
|
if paymentStatus != StatusUnknown {
|
|
t.Fatalf("wrong payment status: expected %v, got %v",
|
|
StatusUnknown.String(), paymentStatus.String())
|
|
}
|
|
|
|
// Lastly, we'll add a locally-sourced circuit and
|
|
// non-locally-sourced circuit to the circuit map. The
|
|
// locally-sourced payment should end up with an InFlight
|
|
// status, while the other should remain unchanged, which
|
|
// defaults to Grounded.
|
|
err = kvdb.Update(d, func(tx kvdb.RwTx) error {
|
|
circuits, err := tx.CreateTopLevelBucket(
|
|
[]byte("circuit-adds"),
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
groundedKey := make([]byte, 16)
|
|
binary.BigEndian.PutUint64(groundedKey[:8], 1)
|
|
binary.BigEndian.PutUint64(groundedKey[8:], 1)
|
|
|
|
// Generated using TestHalfCircuitSerialization with nil
|
|
// ErrorEncrypter, which is the case for locally-sourced
|
|
// payments. No payment status should end up being set
|
|
// for this circuit, since the short channel id of the
|
|
// key is non-zero (e.g., a forwarded circuit). This
|
|
// will default it to Grounded.
|
|
groundedCircuit := []byte{
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x01,
|
|
// start payment hash
|
|
0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
// end payment hash
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x0f,
|
|
0x42, 0x40, 0x00,
|
|
}
|
|
|
|
err = circuits.Put(groundedKey, groundedCircuit)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
inFlightKey := make([]byte, 16)
|
|
binary.BigEndian.PutUint64(inFlightKey[:8], 0)
|
|
binary.BigEndian.PutUint64(inFlightKey[8:], 1)
|
|
|
|
// Generated using TestHalfCircuitSerialization with nil
|
|
// ErrorEncrypter, which is not the case for forwarded
|
|
// payments, but should have no impact on the
|
|
// correctness of the test. The payment status for this
|
|
// circuit should be set to InFlight, since the short
|
|
// channel id in the key is 0 (sourceHop).
|
|
inFlightCircuit := []byte{
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x01,
|
|
// start payment hash
|
|
0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
// end payment hash
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x0f,
|
|
0x42, 0x40, 0x00,
|
|
}
|
|
|
|
return circuits.Put(inFlightKey, inFlightCircuit)
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("unable to add circuit map entry: %v", err)
|
|
}
|
|
}
|
|
|
|
// Verify that the created payment status is "Completed" for our one
|
|
// fake payment.
|
|
afterMigrationFunc := func(d *DB) {
|
|
// Check that our completed payments were migrated.
|
|
paymentStatus, err := d.fetchPaymentStatus(paymentHash)
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payment status: %v", err)
|
|
}
|
|
|
|
if paymentStatus != StatusSucceeded {
|
|
t.Fatalf("wrong payment status: expected %v, got %v",
|
|
StatusSucceeded.String(), paymentStatus.String())
|
|
}
|
|
|
|
inFlightHash := [32]byte{
|
|
0x04, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
}
|
|
|
|
// Check that the locally sourced payment was transitioned to
|
|
// InFlight.
|
|
paymentStatus, err = d.fetchPaymentStatus(inFlightHash)
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payment status: %v", err)
|
|
}
|
|
|
|
if paymentStatus != StatusInFlight {
|
|
t.Fatalf("wrong payment status: expected %v, got %v",
|
|
StatusInFlight.String(), paymentStatus.String())
|
|
}
|
|
|
|
groundedHash := [32]byte{
|
|
0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
|
|
}
|
|
|
|
// Check that non-locally sourced payments remain in the default
|
|
// Grounded state.
|
|
paymentStatus, err = d.fetchPaymentStatus(groundedHash)
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payment status: %v", err)
|
|
}
|
|
|
|
if paymentStatus != StatusUnknown {
|
|
t.Fatalf("wrong payment status: expected %v, got %v",
|
|
StatusUnknown.String(), paymentStatus.String())
|
|
}
|
|
}
|
|
|
|
applyMigration(t,
|
|
beforeMigrationFunc,
|
|
afterMigrationFunc,
|
|
PaymentStatusesMigration,
|
|
false)
|
|
}
|
|
|
|
// TestMigrateOptionalChannelCloseSummaryFields properly converts a
|
|
// ChannelCloseSummary to the v7 format, where optional fields have their
|
|
// presence indicated with boolean markers.
|
|
func TestMigrateOptionalChannelCloseSummaryFields(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
chanState, err := createTestChannelState(nil)
|
|
if err != nil {
|
|
t.Fatalf("unable to create channel state: %v", err)
|
|
}
|
|
|
|
var chanPointBuf bytes.Buffer
|
|
err = writeOutpoint(&chanPointBuf, &chanState.FundingOutpoint)
|
|
if err != nil {
|
|
t.Fatalf("unable to write outpoint: %v", err)
|
|
}
|
|
|
|
chanID := chanPointBuf.Bytes()
|
|
|
|
testCases := []struct {
|
|
closeSummary *ChannelCloseSummary
|
|
oldSerialization func(c *ChannelCloseSummary) []byte
|
|
}{
|
|
{
|
|
// A close summary where none of the new fields are
|
|
// set.
|
|
closeSummary: &ChannelCloseSummary{
|
|
ChanPoint: chanState.FundingOutpoint,
|
|
ShortChanID: chanState.ShortChanID(),
|
|
ChainHash: chanState.ChainHash,
|
|
ClosingTXID: testTx.TxHash(),
|
|
CloseHeight: 100,
|
|
RemotePub: chanState.IdentityPub,
|
|
Capacity: chanState.Capacity,
|
|
SettledBalance: btcutil.Amount(50000),
|
|
CloseType: RemoteForceClose,
|
|
IsPending: true,
|
|
|
|
// The last fields will be unset.
|
|
RemoteCurrentRevocation: nil,
|
|
LocalChanConfig: ChannelConfig{},
|
|
RemoteNextRevocation: nil,
|
|
},
|
|
|
|
// In the old format the last field written is the
|
|
// IsPendingField. It should be converted by adding an
|
|
// extra boolean marker at the end to indicate that the
|
|
// remaining fields are not there.
|
|
oldSerialization: func(cs *ChannelCloseSummary) []byte {
|
|
var buf bytes.Buffer
|
|
err := WriteElements(&buf, cs.ChanPoint,
|
|
cs.ShortChanID, cs.ChainHash,
|
|
cs.ClosingTXID, cs.CloseHeight,
|
|
cs.RemotePub, cs.Capacity,
|
|
cs.SettledBalance, cs.TimeLockedBalance,
|
|
cs.CloseType, cs.IsPending,
|
|
)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// For the old format, these are all the fields
|
|
// that are written.
|
|
return buf.Bytes()
|
|
},
|
|
},
|
|
{
|
|
// A close summary where the new fields are present,
|
|
// but the optional RemoteNextRevocation field is not
|
|
// set.
|
|
closeSummary: &ChannelCloseSummary{
|
|
ChanPoint: chanState.FundingOutpoint,
|
|
ShortChanID: chanState.ShortChanID(),
|
|
ChainHash: chanState.ChainHash,
|
|
ClosingTXID: testTx.TxHash(),
|
|
CloseHeight: 100,
|
|
RemotePub: chanState.IdentityPub,
|
|
Capacity: chanState.Capacity,
|
|
SettledBalance: btcutil.Amount(50000),
|
|
CloseType: RemoteForceClose,
|
|
IsPending: true,
|
|
RemoteCurrentRevocation: chanState.RemoteCurrentRevocation,
|
|
LocalChanConfig: chanState.LocalChanCfg,
|
|
|
|
// RemoteNextRevocation is optional, and here
|
|
// it is not set.
|
|
RemoteNextRevocation: nil,
|
|
},
|
|
|
|
// In the old format the last field written is the
|
|
// LocalChanConfig. This indicates that the optional
|
|
// RemoteNextRevocation field is not present. It should
|
|
// be converted by adding boolean markers for all these
|
|
// fields.
|
|
oldSerialization: func(cs *ChannelCloseSummary) []byte {
|
|
var buf bytes.Buffer
|
|
err := WriteElements(&buf, cs.ChanPoint,
|
|
cs.ShortChanID, cs.ChainHash,
|
|
cs.ClosingTXID, cs.CloseHeight,
|
|
cs.RemotePub, cs.Capacity,
|
|
cs.SettledBalance, cs.TimeLockedBalance,
|
|
cs.CloseType, cs.IsPending,
|
|
)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
err = WriteElements(&buf, cs.RemoteCurrentRevocation)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
err = writeChanConfig(&buf, &cs.LocalChanConfig)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// RemoteNextRevocation is not written.
|
|
return buf.Bytes()
|
|
},
|
|
},
|
|
{
|
|
// A close summary where all fields are present.
|
|
closeSummary: &ChannelCloseSummary{
|
|
ChanPoint: chanState.FundingOutpoint,
|
|
ShortChanID: chanState.ShortChanID(),
|
|
ChainHash: chanState.ChainHash,
|
|
ClosingTXID: testTx.TxHash(),
|
|
CloseHeight: 100,
|
|
RemotePub: chanState.IdentityPub,
|
|
Capacity: chanState.Capacity,
|
|
SettledBalance: btcutil.Amount(50000),
|
|
CloseType: RemoteForceClose,
|
|
IsPending: true,
|
|
RemoteCurrentRevocation: chanState.RemoteCurrentRevocation,
|
|
LocalChanConfig: chanState.LocalChanCfg,
|
|
|
|
// RemoteNextRevocation is optional, and in
|
|
// this case we set it.
|
|
RemoteNextRevocation: chanState.RemoteNextRevocation,
|
|
},
|
|
|
|
// In the old format all the fields are written. It
|
|
// should be converted by adding boolean markers for
|
|
// all these fields.
|
|
oldSerialization: func(cs *ChannelCloseSummary) []byte {
|
|
var buf bytes.Buffer
|
|
err := WriteElements(&buf, cs.ChanPoint,
|
|
cs.ShortChanID, cs.ChainHash,
|
|
cs.ClosingTXID, cs.CloseHeight,
|
|
cs.RemotePub, cs.Capacity,
|
|
cs.SettledBalance, cs.TimeLockedBalance,
|
|
cs.CloseType, cs.IsPending,
|
|
)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
err = WriteElements(&buf, cs.RemoteCurrentRevocation)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
err = writeChanConfig(&buf, &cs.LocalChanConfig)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
err = WriteElements(&buf, cs.RemoteNextRevocation)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
return buf.Bytes()
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, test := range testCases {
|
|
|
|
// Before the migration we must add the old format to the DB.
|
|
beforeMigrationFunc := func(d *DB) {
|
|
|
|
// Get the old serialization format for this test's
|
|
// close summary, and it to the closed channel bucket.
|
|
old := test.oldSerialization(test.closeSummary)
|
|
err = kvdb.Update(d, func(tx kvdb.RwTx) error {
|
|
closedChanBucket, err := tx.CreateTopLevelBucket(
|
|
closedChannelBucket,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return closedChanBucket.Put(chanID, old)
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("unable to add old serialization: %v",
|
|
err)
|
|
}
|
|
}
|
|
|
|
// After the migration it should be found in the new format.
|
|
afterMigrationFunc := func(d *DB) {
|
|
// We generate the new serialized version, to check
|
|
// against what is found in the DB.
|
|
var b bytes.Buffer
|
|
err = serializeChannelCloseSummary(&b, test.closeSummary)
|
|
if err != nil {
|
|
t.Fatalf("unable to serialize: %v", err)
|
|
}
|
|
newSerialization := b.Bytes()
|
|
|
|
var dbSummary []byte
|
|
err = kvdb.View(d, func(tx kvdb.ReadTx) error {
|
|
closedChanBucket := tx.ReadBucket(closedChannelBucket)
|
|
if closedChanBucket == nil {
|
|
return errors.New("unable to find bucket")
|
|
}
|
|
|
|
// Get the serialized verision from the DB and
|
|
// make sure it matches what we expected.
|
|
dbSummary = closedChanBucket.Get(chanID)
|
|
if !bytes.Equal(dbSummary, newSerialization) {
|
|
return fmt.Errorf("unexpected new " +
|
|
"serialization")
|
|
}
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("unable to view DB: %v", err)
|
|
}
|
|
|
|
// Finally we fetch the deserialized summary from the
|
|
// DB and check that it is equal to our original one.
|
|
dbChannels, err := d.FetchClosedChannels(false)
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch closed channels: %v",
|
|
err)
|
|
}
|
|
|
|
if len(dbChannels) != 1 {
|
|
t.Fatalf("expected 1 closed channels, found %v",
|
|
len(dbChannels))
|
|
}
|
|
|
|
dbChan := dbChannels[0]
|
|
if !reflect.DeepEqual(dbChan, test.closeSummary) {
|
|
dbChan.RemotePub.Curve = nil
|
|
test.closeSummary.RemotePub.Curve = nil
|
|
t.Fatalf("not equal: %v vs %v",
|
|
spew.Sdump(dbChan),
|
|
spew.Sdump(test.closeSummary))
|
|
}
|
|
|
|
}
|
|
|
|
applyMigration(t,
|
|
beforeMigrationFunc,
|
|
afterMigrationFunc,
|
|
MigrateOptionalChannelCloseSummaryFields,
|
|
false)
|
|
}
|
|
}
|
|
|
|
// TestMigrateGossipMessageStoreKeys ensures that the migration to the new
|
|
// gossip message store key format is successful/unsuccessful under various
|
|
// scenarios.
|
|
func TestMigrateGossipMessageStoreKeys(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
// Construct the message which we'll use to test the migration, along
|
|
// with its old and new key formats.
|
|
shortChanID := lnwire.ShortChannelID{BlockHeight: 10}
|
|
msg := &lnwire.AnnounceSignatures{ShortChannelID: shortChanID}
|
|
|
|
var oldMsgKey [33 + 8]byte
|
|
copy(oldMsgKey[:33], pubKey.SerializeCompressed())
|
|
binary.BigEndian.PutUint64(oldMsgKey[33:41], shortChanID.ToUint64())
|
|
|
|
var newMsgKey [33 + 8 + 2]byte
|
|
copy(newMsgKey[:41], oldMsgKey[:])
|
|
binary.BigEndian.PutUint16(newMsgKey[41:43], uint16(msg.MsgType()))
|
|
|
|
// Before the migration, we'll create the bucket where the messages
|
|
// should live and insert them.
|
|
beforeMigration := func(db *DB) {
|
|
var b bytes.Buffer
|
|
if err := msg.Encode(&b, 0); err != nil {
|
|
t.Fatalf("unable to serialize message: %v", err)
|
|
}
|
|
|
|
err := kvdb.Update(db, func(tx kvdb.RwTx) error {
|
|
messageStore, err := tx.CreateTopLevelBucket(
|
|
messageStoreBucket,
|
|
)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return messageStore.Put(oldMsgKey[:], b.Bytes())
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
// After the migration, we'll make sure that:
|
|
// 1. We cannot find the message under its old key.
|
|
// 2. We can find the message under its new key.
|
|
// 3. The message matches the original.
|
|
afterMigration := func(db *DB) {
|
|
var rawMsg []byte
|
|
err := kvdb.View(db, func(tx kvdb.ReadTx) error {
|
|
messageStore := tx.ReadBucket(messageStoreBucket)
|
|
if messageStore == nil {
|
|
return errors.New("message store bucket not " +
|
|
"found")
|
|
}
|
|
rawMsg = messageStore.Get(oldMsgKey[:])
|
|
if rawMsg != nil {
|
|
t.Fatal("expected to not find message under " +
|
|
"old key, but did")
|
|
}
|
|
rawMsg = messageStore.Get(newMsgKey[:])
|
|
if rawMsg == nil {
|
|
return fmt.Errorf("expected to find message " +
|
|
"under new key, but didn't")
|
|
}
|
|
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
gotMsg, err := lnwire.ReadMessage(bytes.NewReader(rawMsg), 0)
|
|
if err != nil {
|
|
t.Fatalf("unable to deserialize raw message: %v", err)
|
|
}
|
|
if !reflect.DeepEqual(msg, gotMsg) {
|
|
t.Fatalf("expected message: %v\ngot message: %v",
|
|
spew.Sdump(msg), spew.Sdump(gotMsg))
|
|
}
|
|
}
|
|
|
|
applyMigration(
|
|
t, beforeMigration, afterMigration,
|
|
MigrateGossipMessageStoreKeys, false,
|
|
)
|
|
}
|
|
|
|
// TestOutgoingPaymentsMigration checks that OutgoingPayments are migrated to a
|
|
// new bucket structure after the migration.
|
|
func TestOutgoingPaymentsMigration(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
const numPayments = 4
|
|
var oldPayments []*outgoingPayment
|
|
|
|
// Add fake payments to test database, verifying that it was created.
|
|
beforeMigrationFunc := func(d *DB) {
|
|
for i := 0; i < numPayments; i++ {
|
|
var p *outgoingPayment
|
|
var err error
|
|
|
|
// We fill the database with random payments. For the
|
|
// very last one we'll use a duplicate of the first, to
|
|
// ensure we are able to handle migration from a
|
|
// database that has copies.
|
|
if i < numPayments-1 {
|
|
p, err = makeRandomFakePayment()
|
|
if err != nil {
|
|
t.Fatalf("unable to create payment: %v",
|
|
err)
|
|
}
|
|
} else {
|
|
p = oldPayments[0]
|
|
}
|
|
|
|
if err := d.addPayment(p); err != nil {
|
|
t.Fatalf("unable to add payment: %v", err)
|
|
}
|
|
|
|
oldPayments = append(oldPayments, p)
|
|
}
|
|
|
|
payments, err := d.fetchAllPayments()
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch payments: %v", err)
|
|
}
|
|
|
|
if len(payments) != numPayments {
|
|
t.Fatalf("wrong qty of paymets: expected %d got %v",
|
|
numPayments, len(payments))
|
|
}
|
|
}
|
|
|
|
// Verify that all payments were migrated.
|
|
afterMigrationFunc := func(d *DB) {
|
|
sentPayments, err := d.fetchPaymentsMigration9()
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch sent payments: %v", err)
|
|
}
|
|
|
|
if len(sentPayments) != numPayments {
|
|
t.Fatalf("expected %d payments, got %d", numPayments,
|
|
len(sentPayments))
|
|
}
|
|
|
|
graph := d.ChannelGraph()
|
|
sourceNode, err := graph.SourceNode()
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch source node: %v", err)
|
|
}
|
|
|
|
for i, p := range sentPayments {
|
|
// The payment status should be Completed.
|
|
if p.Status != StatusSucceeded {
|
|
t.Fatalf("expected Completed, got %v", p.Status)
|
|
}
|
|
|
|
// Check that the sequence number is preserved. They
|
|
// start counting at 1.
|
|
if p.sequenceNum != uint64(i+1) {
|
|
t.Fatalf("expected seqnum %d, got %d", i,
|
|
p.sequenceNum)
|
|
}
|
|
|
|
// Order of payments should be be preserved.
|
|
old := oldPayments[i]
|
|
|
|
// Check the individial fields.
|
|
if p.Info.Value != old.Terms.Value {
|
|
t.Fatalf("value mismatch")
|
|
}
|
|
|
|
if p.Info.CreationDate != old.CreationDate {
|
|
t.Fatalf("date mismatch")
|
|
}
|
|
|
|
if !bytes.Equal(p.Info.PaymentRequest, old.PaymentRequest) {
|
|
t.Fatalf("payreq mismatch")
|
|
}
|
|
|
|
if *p.PaymentPreimage != old.PaymentPreimage {
|
|
t.Fatalf("preimage mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.TotalFees() != old.Fee {
|
|
t.Fatalf("Fee mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.TotalAmount != old.Fee+old.Terms.Value {
|
|
t.Fatalf("Total amount mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.TotalTimeLock != old.TimeLockLength {
|
|
t.Fatalf("timelock mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.SourcePubKey != sourceNode.PubKeyBytes {
|
|
t.Fatalf("source mismatch: %x vs %x",
|
|
p.Attempt.Route.SourcePubKey[:],
|
|
sourceNode.PubKeyBytes[:])
|
|
}
|
|
|
|
for i, hop := range old.Path {
|
|
if hop != p.Attempt.Route.Hops[i].PubKeyBytes {
|
|
t.Fatalf("path mismatch")
|
|
}
|
|
}
|
|
}
|
|
|
|
// Finally, check that the payment sequence number is updated
|
|
// to reflect the migrated payments.
|
|
err = kvdb.Update(d, func(tx kvdb.RwTx) error {
|
|
payments := tx.ReadWriteBucket(paymentsRootBucket)
|
|
if payments == nil {
|
|
return fmt.Errorf("payments bucket not found")
|
|
}
|
|
|
|
seq := payments.Sequence()
|
|
if seq != numPayments {
|
|
return fmt.Errorf("expected sequence to be "+
|
|
"%d, got %d", numPayments, seq)
|
|
}
|
|
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
applyMigration(t,
|
|
beforeMigrationFunc,
|
|
afterMigrationFunc,
|
|
MigrateOutgoingPayments,
|
|
false)
|
|
}
|
|
|
|
func makeRandPaymentCreationInfo() (*PaymentCreationInfo, error) {
|
|
var payHash lntypes.Hash
|
|
if _, err := rand.Read(payHash[:]); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &PaymentCreationInfo{
|
|
PaymentHash: payHash,
|
|
Value: lnwire.MilliSatoshi(rand.Int63()),
|
|
CreationDate: time.Now(),
|
|
PaymentRequest: []byte("test"),
|
|
}, nil
|
|
}
|
|
|
|
// TestPaymentRouteSerialization tests that we're able to properly migrate
|
|
// existing payments on disk that contain the traversed routes to the new
|
|
// routing format which supports the TLV payloads. We also test that the
|
|
// migration is able to handle duplicate payment attempts.
|
|
func TestPaymentRouteSerialization(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
legacyHop1 := &Hop{
|
|
PubKeyBytes: NewVertex(pub),
|
|
ChannelID: 12345,
|
|
OutgoingTimeLock: 111,
|
|
LegacyPayload: true,
|
|
AmtToForward: 555,
|
|
}
|
|
legacyHop2 := &Hop{
|
|
PubKeyBytes: NewVertex(pub),
|
|
ChannelID: 12345,
|
|
OutgoingTimeLock: 111,
|
|
LegacyPayload: true,
|
|
AmtToForward: 555,
|
|
}
|
|
legacyRoute := Route{
|
|
TotalTimeLock: 123,
|
|
TotalAmount: 1234567,
|
|
SourcePubKey: NewVertex(pub),
|
|
Hops: []*Hop{legacyHop1, legacyHop2},
|
|
}
|
|
|
|
const numPayments = 4
|
|
var oldPayments []*Payment
|
|
|
|
sharedPayAttempt := PaymentAttemptInfo{
|
|
PaymentID: 1,
|
|
SessionKey: priv,
|
|
Route: legacyRoute,
|
|
}
|
|
|
|
// We'll first add a series of fake payments, using the existing legacy
|
|
// serialization format.
|
|
beforeMigrationFunc := func(d *DB) {
|
|
err := kvdb.Update(d, func(tx kvdb.RwTx) error {
|
|
paymentsBucket, err := tx.CreateTopLevelBucket(
|
|
paymentsRootBucket,
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to create new payments "+
|
|
"bucket: %v", err)
|
|
}
|
|
|
|
for i := 0; i < numPayments; i++ {
|
|
var seqNum [8]byte
|
|
byteOrder.PutUint64(seqNum[:], uint64(i))
|
|
|
|
// All payments will be randomly generated,
|
|
// other than the final payment. We'll force
|
|
// the final payment to re-use an existing
|
|
// payment hash so we can insert it into the
|
|
// duplicate payment hash bucket.
|
|
var payInfo *PaymentCreationInfo
|
|
if i < numPayments-1 {
|
|
payInfo, err = makeRandPaymentCreationInfo()
|
|
if err != nil {
|
|
t.Fatalf("unable to create "+
|
|
"payment: %v", err)
|
|
}
|
|
} else {
|
|
payInfo = oldPayments[0].Info
|
|
}
|
|
|
|
// Next, legacy encoded when needed, we'll
|
|
// serialize the info and the attempt.
|
|
var payInfoBytes bytes.Buffer
|
|
err = serializePaymentCreationInfo(
|
|
&payInfoBytes, payInfo,
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to encode pay "+
|
|
"info: %v", err)
|
|
}
|
|
var payAttemptBytes bytes.Buffer
|
|
err = serializePaymentAttemptInfoLegacy(
|
|
&payAttemptBytes, &sharedPayAttempt,
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to encode payment attempt: "+
|
|
"%v", err)
|
|
}
|
|
|
|
// Before we write to disk, we'll need to fetch
|
|
// the proper bucket. If this is the duplicate
|
|
// payment, then we'll grab the dup bucket,
|
|
// otherwise, we'll use the top level bucket.
|
|
var payHashBucket kvdb.RwBucket
|
|
if i < numPayments-1 {
|
|
payHashBucket, err = paymentsBucket.CreateBucket(
|
|
payInfo.PaymentHash[:],
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to create payments bucket: %v", err)
|
|
}
|
|
} else {
|
|
payHashBucket = paymentsBucket.NestedReadWriteBucket(
|
|
payInfo.PaymentHash[:],
|
|
)
|
|
dupPayBucket, err := payHashBucket.CreateBucket(
|
|
paymentDuplicateBucket,
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to create "+
|
|
"dup hash bucket: %v", err)
|
|
}
|
|
|
|
payHashBucket, err = dupPayBucket.CreateBucket(
|
|
seqNum[:],
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to make dup "+
|
|
"bucket: %v", err)
|
|
}
|
|
}
|
|
|
|
err = payHashBucket.Put(paymentSequenceKey, seqNum[:])
|
|
if err != nil {
|
|
t.Fatalf("unable to write seqno: %v", err)
|
|
}
|
|
|
|
err = payHashBucket.Put(
|
|
paymentCreationInfoKey, payInfoBytes.Bytes(),
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to write creation "+
|
|
"info: %v", err)
|
|
}
|
|
|
|
err = payHashBucket.Put(
|
|
paymentAttemptInfoKey, payAttemptBytes.Bytes(),
|
|
)
|
|
if err != nil {
|
|
t.Fatalf("unable to write attempt "+
|
|
"info: %v", err)
|
|
}
|
|
|
|
oldPayments = append(oldPayments, &Payment{
|
|
Info: payInfo,
|
|
Attempt: &sharedPayAttempt,
|
|
})
|
|
}
|
|
|
|
return nil
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("unable to create test payments: %v", err)
|
|
}
|
|
}
|
|
|
|
afterMigrationFunc := func(d *DB) {
|
|
newPayments, err := d.FetchPayments()
|
|
if err != nil {
|
|
t.Fatalf("unable to fetch new payments: %v", err)
|
|
}
|
|
|
|
if len(newPayments) != numPayments {
|
|
t.Fatalf("expected %d payments, got %d", numPayments,
|
|
len(newPayments))
|
|
}
|
|
|
|
for i, p := range newPayments {
|
|
// Order of payments should be be preserved.
|
|
old := oldPayments[i]
|
|
|
|
if p.Attempt.PaymentID != old.Attempt.PaymentID {
|
|
t.Fatalf("wrong pay ID: expected %v, got %v",
|
|
p.Attempt.PaymentID,
|
|
old.Attempt.PaymentID)
|
|
}
|
|
|
|
if p.Attempt.Route.TotalFees() != old.Attempt.Route.TotalFees() {
|
|
t.Fatalf("Fee mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.TotalAmount != old.Attempt.Route.TotalAmount {
|
|
t.Fatalf("Total amount mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.TotalTimeLock != old.Attempt.Route.TotalTimeLock {
|
|
t.Fatalf("timelock mismatch")
|
|
}
|
|
|
|
if p.Attempt.Route.SourcePubKey != old.Attempt.Route.SourcePubKey {
|
|
t.Fatalf("source mismatch: %x vs %x",
|
|
p.Attempt.Route.SourcePubKey[:],
|
|
old.Attempt.Route.SourcePubKey[:])
|
|
}
|
|
|
|
for i, hop := range p.Attempt.Route.Hops {
|
|
if !reflect.DeepEqual(hop, legacyRoute.Hops[i]) {
|
|
t.Fatalf("hop mismatch")
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
applyMigration(t,
|
|
beforeMigrationFunc,
|
|
afterMigrationFunc,
|
|
MigrateRouteSerialization,
|
|
false)
|
|
}
|
|
|
|
// TestNotCoveredMigrations only references migrations that are not referenced
|
|
// anywhere else in this package. This prevents false positives when linting
|
|
// with unused.
|
|
func TestNotCoveredMigrations(t *testing.T) {
|
|
_ = MigrateNodeAndEdgeUpdateIndex
|
|
_ = MigrateInvoiceTimeSeries
|
|
_ = MigrateInvoiceTimeSeriesOutgoingPayments
|
|
_ = MigrateEdgePolicies
|
|
_ = MigratePruneEdgeUpdateIndex
|
|
}
|