lightning/wallet/wallet_tests.c

  #include <lightningd/log.h>

static void wallet_fatal(const char *fmt, ...);
#define fatal wallet_fatal

#include "wallet.c"

#include "db.c"

#include <ccan/mem/mem.h>
#include <ccan/tal/str/str.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>
#include <wallet/test_utils.h>

static char *wallet_err;
static void wallet_fatal(const char *fmt, ...)
{
	va_list ap;

	/* Fail hard if we're complaining about not being in transaction */
	assert(!strstarts(fmt, "No longer in transaction"));

	/* Fail hard if we're complaining about not being in transaction */
	assert(!strstarts(fmt, "No longer in transaction"));

	va_start(ap, fmt);
	wallet_err = tal_vfmt(NULL, fmt, ap);
	va_end(ap);
}

#define transaction_wrap(db, ...)					\
	(db_begin_transaction(db), __VA_ARGS__, db_commit_transaction(db), wallet_err == NULL)

void invoice_add(struct invoices *invs,
		 struct invoice *inv){}

/**
 * mempat -- Set the memory to a pattern
 *
 * Used mainly to check that we don't mix fields while
 * serializing/unserializing.
 */
static void mempat(void *dst, size_t len)
{
	static int n = 0;
	u8 *p = (u8*)dst;
	for(int i=0 ; i < len; ++i)
		p[i] = n % 251; /* Prime */
}

static struct wallet *create_test_wallet(const tal_t *ctx)
{
	char filename[] = "/tmp/ldb-XXXXXX";
	int fd = mkstemp(filename);
	struct log_book *log_book;
	struct wallet *w = tal(ctx, struct wallet);
	CHECK_MSG(fd != -1, "Unable to generate temp filename");
	close(fd);

	w->db = db_open(w, filename);

	CHECK_MSG(w->db, "Failed opening the db");
	db_migrate(w->db);
	CHECK_MSG(!wallet_err, "DB migration failed");

	ltmp = tal_tmpctx(ctx);
	log_book = new_log_book(w, 20*1024*1024, LOG_DBG);
	w->log = new_log(w, log_book, "wallet_tests(%u):", (int)getpid());

	return w;
}

static bool test_wallet_outputs(void)
{
	char filename[] = "/tmp/ldb-XXXXXX";
	struct utxo u;
	int fd = mkstemp(filename);
	struct wallet *w = tal(NULL, struct wallet);
	CHECK_MSG(fd != -1, "Unable to generate temp filename");
	close(fd);

	w->db = db_open(w, filename);
	CHECK_MSG(w->db, "Failed opening the db");
	db_migrate(w->db);
	CHECK_MSG(!wallet_err, "DB migration failed");

	memset(&u, 0, sizeof(u));

	db_begin_transaction(w->db);

	/* Should work, it's the first time we add it */
	CHECK_MSG(wallet_add_utxo(w, &u, p2sh_wpkh),
		  "wallet_add_utxo failed on first add");

	/* Should fail, we already have that UTXO */
	CHECK_MSG(!wallet_add_utxo(w, &u, p2sh_wpkh),
		  "wallet_add_utxo succeeded on second add");

	/* Attempt to reserve the utxo */
	CHECK_MSG(wallet_update_output_status(w, &u.txid, u.outnum,
					      output_state_available,
					      output_state_reserved),
		  "could not reserve available output");

	/* Reserving twice should fail */
	CHECK_MSG(!wallet_update_output_status(w, &u.txid, u.outnum,
					       output_state_available,
					       output_state_reserved),
		  "could reserve already reserved output");

	/* Un-reserving should work */
	CHECK_MSG(wallet_update_output_status(w, &u.txid, u.outnum,
					      output_state_reserved,
					      output_state_available),
		  "could not unreserve reserved output");

	/* Switching from any to something else */
	CHECK_MSG(wallet_update_output_status(w, &u.txid, u.outnum,
					      output_state_any,
					      output_state_spent),
		  "could not change output state ignoring oldstate");

	db_commit_transaction(w->db);
	tal_free(w);
	return true;
}

static bool test_shachain_crud(void)
{
	struct wallet_shachain a, b;
	char filename[] = "/tmp/ldb-XXXXXX";
	int fd = mkstemp(filename);
	struct wallet *w = tal(NULL, struct wallet);
	struct sha256 seed, hash;
	uint64_t index = UINT64_MAX >> (64 - SHACHAIN_BITS);

	w->db = db_open(w, filename);
	CHECK_MSG(w->db, "Failed opening the db");
	db_migrate(w->db);
	CHECK_MSG(!wallet_err, "DB migration failed");

	CHECK_MSG(fd != -1, "Unable to generate temp filename");
	close(fd);
	memset(&seed, 'A', sizeof(seed));

	memset(&a, 0, sizeof(a));
	memset(&b, 0, sizeof(b));

	w->db = db_open(w, filename);
	db_begin_transaction(w->db);
	CHECK_MSG(!wallet_err, "db_begin_transaction failed");
	wallet_shachain_init(w, &a);
	CHECK(!wallet_err);

	CHECK(a.id == 1);

	CHECK(a.chain.num_valid == 0);
	CHECK(shachain_next_index(&a.chain) == index);

	for (int i=0; i<100; i++) {
		shachain_from_seed(&seed, index, &hash);
		CHECK(wallet_shachain_add_hash(w, &a, index, &hash));
		index--;
	}

	CHECK(wallet_shachain_load(w, a.id, &b));
	CHECK_MSG(memcmp(&a, &b, sizeof(a)) == 0, "Loading from database doesn't match");

	db_commit_transaction(w->db);
	CHECK(!wallet_err);
	tal_free(w);
	return true;
}

static bool bitcoin_tx_eq(const struct bitcoin_tx *tx1,
			  const struct bitcoin_tx *tx2)
{
	u8 *lin1, *lin2;
	bool eq;
	lin1 = linearize_tx(NULL, tx1);
	lin2 = linearize_tx(lin1, tx2);
	eq = memeq(lin1, tal_len(lin1), lin2, tal_len(lin2));
	tal_free(lin1);
	return eq;
}

static bool channelseq(struct wallet_channel *c1, struct wallet_channel *c2)
{
	struct peer *p1 = c1->peer, *p2 = c2->peer;
	struct channel_info *ci1 = p1->channel_info, *ci2 = p2->channel_info;
	struct changed_htlc *lc1 = p1->last_sent_commit, *lc2 = p2->last_sent_commit;
	CHECK(c1->id == c2->id);
	CHECK(c1->peer->dbid == c2->peer->dbid);
	CHECK(p1->their_shachain.id == p2->their_shachain.id);
	CHECK_MSG(pubkey_eq(&p1->id, &p2->id), "NodeIDs do not match");
	CHECK((p1->scid == NULL && p2->scid == NULL) || short_channel_id_eq(p1->scid, p2->scid));
	CHECK((p1->our_msatoshi == NULL && p2->our_msatoshi == NULL) || *p1->our_msatoshi == *p2->our_msatoshi);
	CHECK((p1->remote_shutdown_scriptpubkey == NULL && p2->remote_shutdown_scriptpubkey == NULL) || memeq(
		      p1->remote_shutdown_scriptpubkey,
		      tal_len(p1->remote_shutdown_scriptpubkey),
		      p2->remote_shutdown_scriptpubkey,
		      tal_len(p2->remote_shutdown_scriptpubkey)));
	CHECK((p1->funding_txid == NULL && p2->funding_txid == NULL) || memeq(
		      p1->funding_txid,
		      sizeof(struct sha256_double),
		      p2->funding_txid,
		      sizeof(struct sha256_double)));
	CHECK((ci1 != NULL) ==  (ci2 != NULL));
	if(ci1) {
		CHECK(pubkey_eq(&ci1->remote_fundingkey, &ci2->remote_fundingkey));
		CHECK(pubkey_eq(&ci1->theirbase.revocation, &ci2->theirbase.revocation));
		CHECK(pubkey_eq(&ci1->theirbase.payment, &ci2->theirbase.payment));
		CHECK(pubkey_eq(&ci1->theirbase.delayed_payment, &ci2->theirbase.delayed_payment));
		CHECK(pubkey_eq(&ci1->remote_per_commit, &ci2->remote_per_commit));
		CHECK(pubkey_eq(&ci1->old_remote_per_commit, &ci2->old_remote_per_commit));
		CHECK(ci1->their_config.id != 0 && ci1->their_config.id == ci2->their_config.id);
	}

	CHECK(p1->our_config.id != 0 && p1->our_config.id == p2->our_config.id);
	CHECK((lc1 != NULL) ==  (lc2 != NULL));
	if(lc1) {
		CHECK(lc1->newstate == lc2->newstate);
		CHECK(lc1->id == lc2->id);
	}

	CHECK((p1->last_tx != NULL) ==  (p2->last_tx != NULL));
	if(p1->last_tx) {
		CHECK(bitcoin_tx_eq(p1->last_tx, p2->last_tx));
	}
	CHECK((p1->last_sig != NULL) ==  (p2->last_sig != NULL));
	if(p1->last_sig) {
		CHECK(memeq(p1->last_sig, sizeof(*p1->last_sig),
			    p2->last_sig, sizeof(*p2->last_sig)));
	}

	return true;
}

static bool test_channel_crud(const tal_t *ctx)
{
	struct wallet *w = create_test_wallet(ctx);
	struct wallet_channel c1, *c2 = tal(w, struct wallet_channel);
	struct peer p;
	struct channel_info ci;
	struct sha256_double *hash = tal(w, struct sha256_double);
	struct pubkey pk;
	struct changed_htlc last_commit;
	secp256k1_ecdsa_signature *sig = tal(w, secp256k1_ecdsa_signature);

	u64 msat = 12345;

	memset(&c1, 0, sizeof(c1));
	memset(c2, 0, sizeof(*c2));
	memset(&p, 0, sizeof(p));
	memset(&ci, 3, sizeof(ci));
	mempat(hash, sizeof(*hash));
	mempat(sig, sizeof(*sig));
	mempat(&last_commit, sizeof(last_commit));
	pubkey_from_der(tal_hexdata(w, "02a1633cafcc01ebfb6d78e39f687a1f0995c62fc95f51ead10a02ee0be551b5dc", 66), 33, &pk);
	ci.feerate_per_kw[LOCAL] = ci.feerate_per_kw[REMOTE] = 31337;
	mempat(&p.id, sizeof(p.id));
	c1.peer = &p;
	p.id = pk;
	p.our_msatoshi = NULL;
	p.last_tx = NULL;
	memset(&ci.their_config, 0, sizeof(struct channel_config));
	ci.remote_fundingkey = pk;
	ci.theirbase.revocation = pk;
	ci.theirbase.payment = pk;
	ci.theirbase.htlc = pk;
	ci.theirbase.delayed_payment = pk;
	ci.remote_per_commit = pk;
	ci.old_remote_per_commit = pk;

	db_begin_transaction(w->db);
	CHECK(!wallet_err);

	/* Variant 1: insert with null for scid, funding_tx_id, channel_info, last_tx */
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Load from DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v1)");

	/* We just inserted them into an empty DB so this must be 1 */
	CHECK(c1.id == 1);
	CHECK(c1.peer->dbid == 1);
	CHECK(c1.peer->their_shachain.id == 1);

	/* Variant 2: update with scid set */
	c1.peer->scid = talz(w, struct short_channel_id);
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v2)");

	/* Updates should not result in new ids */
	CHECK(c1.id == 1);
	CHECK(c1.peer->dbid == 1);
	CHECK(c1.peer->their_shachain.id == 1);

	/* Variant 3: update with our_satoshi set */
	c1.peer->our_msatoshi = &msat;

	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err, tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v3)");

	/* Variant 4: update with funding_tx_id */
	c1.peer->funding_txid = hash;
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err, tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v4)");

	/* Variant 5: update with channel_info */
	p.channel_info = &ci;
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err, tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v5)");

	/* Variant 6: update with last_commit_sent */
	p.last_sent_commit = &last_commit;
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err, tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v6)");

	/* Variant 7: update with last_tx (taken from BOLT #3) */
	p.last_tx = bitcoin_tx_from_hex(w, "02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220", strlen("02000000000101bef67e4e2fb9ddeeb3461973cd4c62abb35050b1add772995b820b584a488489000000000038b02b8003a00f0000000000002200208c48d15160397c9731df9bc3b236656efb6665fbfe92b4a6878e88a499f741c4c0c62d0000000000160014ccf1af2f2aabee14bb40fa3851ab2301de843110ae8f6a00000000002200204adb4e2f00643db396dd120d4e7dc17625f5f2c11a40d857accc862d6b7dd80e040047304402206a2679efa3c7aaffd2a447fd0df7aba8792858b589750f6a1203f9259173198a022008d52a0e77a99ab533c36206cb15ad7aeb2aa72b93d4b571e728cb5ec2f6fe260147304402206d6cb93969d39177a09d5d45b583f34966195b77c7e585cf47ac5cce0c90cefb022031d71ae4e33a4e80df7f981d696fbdee517337806a3c7138b7491e2cbb077a0e01475221023da092f6980e58d2c037173180e9a465476026ee50f96695963e8efe436f54eb21030e9f7b623d2ccc7c9bd44d66d5ce21ce504c0acf6385a132cec6d3c39fa711c152ae3e195220"));
	p.last_sig = sig;
	wallet_channel_save(w, &c1);
	CHECK_MSG(!wallet_err, tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(wallet_channel_load(w, c1.id, c2), tal_fmt(w, "Load from DB"));
	CHECK_MSG(!wallet_err,
		  tal_fmt(w, "Insert into DB: %s", wallet_err));
	CHECK_MSG(channelseq(&c1, c2), "Compare loaded with saved (v7)");

	db_commit_transaction(w->db);
	CHECK(!wallet_err);
	tal_free(w);
	return true;
}

static bool test_channel_config_crud(const tal_t *ctx)
{
	struct channel_config *cc1 = talz(ctx, struct channel_config),
			      *cc2 = talz(ctx, struct channel_config);
	struct wallet *w = create_test_wallet(ctx);
	CHECK(w);

	cc1->dust_limit_satoshis = 1;
	cc1->max_htlc_value_in_flight_msat = 2;
	cc1->channel_reserve_satoshis = 3;
	cc1->htlc_minimum_msat = 4;
	cc1->to_self_delay = 5;
	cc1->max_accepted_htlcs = 6;

	CHECK(transaction_wrap(w->db, wallet_channel_config_save(w, cc1)));
	CHECK_MSG(
	    cc1->id == 1,
	    tal_fmt(ctx, "channel_config->id != 1; got %" PRIu64, cc1->id));

	CHECK(transaction_wrap(w->db, wallet_channel_config_load(w, cc1->id, cc2)));
	CHECK(memeq(cc1, sizeof(*cc1), cc2, sizeof(*cc2)));
       	return true;
}

static bool test_htlc_crud(const tal_t *ctx)
{
	struct htlc_in in, *hin;
	struct htlc_out out, *hout;
	struct preimage payment_key;
	struct wallet_channel *chan = tal(ctx, struct wallet_channel);
	struct peer *peer = talz(ctx, struct peer);
	struct wallet *w = create_test_wallet(ctx);
	struct htlc_in_map *htlcs_in = tal(ctx, struct htlc_in_map);
	struct htlc_out_map *htlcs_out = tal(ctx, struct htlc_out_map);

	/* Make sure we have our references correct */
	CHECK(transaction_wrap(w->db,
			       db_exec(__func__, w->db, "INSERT INTO channels (id) VALUES (1);")));
	chan->id = 1;
	chan->peer = peer;

	memset(&in, 0, sizeof(in));
	memset(&out, 0, sizeof(out));
	memset(&in.payment_hash, 'A', sizeof(struct sha256));
	memset(&out.payment_hash, 'A', sizeof(struct sha256));
	memset(&payment_key, 'B', sizeof(payment_key));
	in.key.id = 42;
	in.key.peer = peer;
	in.msatoshi = 42;

	out.in = &in;
	out.key.id = 1337;
	out.key.peer = peer;
	out.msatoshi = 41;

	/* Store the htlc_in */
	CHECK_MSG(transaction_wrap(w->db, wallet_htlc_save_in(w, chan, &in)),
		  tal_fmt(ctx, "Save htlc_in failed: %s", wallet_err));
	CHECK_MSG(in.dbid != 0, "HTLC DB ID was not set.");
	/* Saving again should get us a collision */
	CHECK_MSG(!transaction_wrap(w->db, wallet_htlc_save_in(w, chan, &in)),
		  "Saving two HTLCs with the same data must not succeed.");
	CHECK(wallet_err);
	wallet_err = tal_free(wallet_err);

	/* Update */
	CHECK_MSG(transaction_wrap(w->db, wallet_htlc_update(w, in.dbid, RCVD_ADD_HTLC, NULL)),
		  "Update HTLC with null payment_key failed");
	CHECK_MSG(
		transaction_wrap(w->db, wallet_htlc_update(w, in.dbid, SENT_REMOVE_HTLC, &payment_key)),
	    "Update HTLC with payment_key failed");

	CHECK_MSG(transaction_wrap(w->db, wallet_htlc_save_out(w, chan, &out)),
		  tal_fmt(ctx, "Save htlc_out failed: %s", wallet_err));
	CHECK_MSG(out.dbid != 0, "HTLC DB ID was not set.");

	CHECK_MSG(!transaction_wrap(w->db, wallet_htlc_save_out(w, chan, &out)),
		  "Saving two HTLCs with the same data must not succeed.");
	CHECK(wallet_err);
	wallet_err = tal_free(wallet_err);

	/* Attempt to load them from the DB again */
	htlc_in_map_init(htlcs_in);
	htlc_out_map_init(htlcs_out);

	db_begin_transaction(w->db);
	CHECK(!wallet_err);

	CHECK_MSG(wallet_htlcs_load_for_channel(w, chan, htlcs_in, htlcs_out),
		  "Failed loading HTLCs");

	CHECK_MSG(wallet_htlcs_reconnect(w, htlcs_in, htlcs_out),
		  "Unable to reconnect htlcs.");
	db_commit_transaction(w->db);
	CHECK(!wallet_err);

	hin = htlc_in_map_get(htlcs_in, &in.key);
	hout = htlc_out_map_get(htlcs_out, &out.key);

	CHECK(hin != NULL);
	CHECK(hout != NULL);

	/* Have to free manually, otherwise we get our dependencies
	 * twisted */
	tal_free(hin);
	tal_free(hout);
	htlc_in_map_clear(htlcs_in);
	htlc_out_map_clear(htlcs_out);

	return true;
}

static bool test_payment_crud(const tal_t *ctx)
{
	struct wallet_payment t, *t2;
	struct wallet *w = create_test_wallet(ctx);
	struct pubkey destination;

	mempat(&t, sizeof(t));
	memset(&destination, 1, sizeof(destination));

	t.id = 0;
	t.destination = NULL;

	db_begin_transaction(w->db);
	CHECK(wallet_payment_add(w, &t));
	CHECK(t.id != 0);
	t2 = wallet_payment_by_hash(ctx, w, &t.payment_hash);
	CHECK(t2 != NULL);
	CHECK(t2->id == t.id && t2->destination == NULL);

	t.destination = &destination;
	t.id = 0;
	memset(&t.payment_hash, 1, sizeof(t.payment_hash));

	CHECK(wallet_payment_add(w, &t));
	t2 = wallet_payment_by_hash(ctx, w, &t.payment_hash);
	CHECK(t2->destination && pubkey_cmp(t2->destination, &destination) == 0);

	db_commit_transaction(w->db);
	return true;
}

int main(void)
{
	bool ok = true;
	tal_t *tmpctx = tal_tmpctx(NULL);

	ok &= test_wallet_outputs();
	ok &= test_shachain_crud();
	ok &= test_channel_crud(tmpctx);
	ok &= test_channel_config_crud(tmpctx);
	ok &= test_htlc_crud(tmpctx);
	ok &= test_payment_crud(tmpctx);

	tal_free(tmpctx);
	return !ok;
}