Skip to content

Commit

Permalink
tests: Add CPFP tests
Browse files Browse the repository at this point in the history
  • Loading branch information
danielabrozzoni committed Oct 29, 2021
1 parent 619e7f9 commit 23a52fa
Show file tree
Hide file tree
Showing 2 changed files with 158 additions and 3 deletions.
10 changes: 7 additions & 3 deletions tests/fixtures.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,9 @@ def revaultd_stakeholder(bitcoind, directory):
os.makedirs(datadir, exist_ok=True)
(stks, cosigs, mans, _, _, _) = get_participants(2, 3)
cpfp_xprivs = [
bytes.fromhex("0488ade4000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35")
bytes.fromhex(
"0488ade4000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"
)
]
cpfp_xpubs = [
"xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
Expand Down Expand Up @@ -183,7 +185,9 @@ def revaultd_manager(bitcoind, directory):
os.makedirs(datadir, exist_ok=True)
(stks, cosigs, mans, _, _, _) = get_participants(2, 3)
cpfp_xprivs = [
bytes.fromhex("0488ade4000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35")
bytes.fromhex(
"0488ade4000000000000000000873dff81c02f525623fd1fe5167eac3a55a049de3d314bb42ee227ffed37d50800e8f32e723decf4051aefac8e2c93c9c5b214313817cdb01a1494b917c8436b35"
)
]
cpfp_xpubs = [
"xpub661MyMwAqRbcFtXgS5sYJABqqG9YLmC4Q1Rdap9gSE8NqtwybGhePY2gZ29ESFjqJoCu1Rupje8YtGqsefD265TMg7usUDFdp6W1EGMcet8"
Expand Down Expand Up @@ -214,7 +218,7 @@ def revaultd_manager(bitcoind, directory):
reserve(),
bitcoind,
man_config=man_config,
cpfp_priv=cpfp_xprivs[0]
cpfp_priv=cpfp_xprivs[0],
)
revaultd.start()

Expand Down
151 changes: 151 additions & 0 deletions tests/test_misc.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

from bitcoin.core import COIN
from fixtures import *
from test_framework import serializations
from test_framework.utils import (
TailableProc,
POSTGRES_IS_SETUP,
Expand Down Expand Up @@ -225,3 +226,153 @@ def test_no_cosig_server(revault_network):
rn.spend_vaults_anyhow(vaults[:2])
rn.unvault_vaults_anyhow([vaults[-1]])
rn.cancel_vault(vaults[-1])


@pytest.mark.skipif(not POSTGRES_IS_SETUP, reason="Needs Postgres for servers db")
def test_cpfp_transaction(revault_network, bitcoind):
CSV = 12
revault_network.deploy(2, 1, n_stkmanagers=1, csv=CSV)
man = revault_network.mans()[1]
stks = revault_network.stks()
amount = 0.24
vault = revault_network.fund(amount)
deposit = f"{vault['txid']}:{vault['vout']}"

revault_network.secure_vault(vault)
revault_network.activate_vault(vault)
_, spend_psbt = revault_network.unvault_vaults_anyhow_unconfirmed(
[vault], priority=True
)

unvault_psbt = serializations.PSBT()
unvault_b64 = stks[0].rpc.getunvaulttx(deposit)["unvault_tx"]
unvault_psbt.deserialize(unvault_b64)
unvault_psbt.tx.calc_sha256()
unvault_txid = unvault_psbt.tx.hash
spend_txid = spend_psbt.tx.hash

# Let's test that the revaultd poller behaves correctly
# Case 1: the unvault is broadcasted and inserted in the CPFP table
for w in revault_network.participants():
wait_for(
lambda: len(w.rpc.listvaults(["unvaulting"], [deposit])["vaults"]) == 1,
)
man.wait_for_log(
f"Inserted freshly-broadcasted Unvault transaction {unvault_txid} in CPFPable table",
)

# Uh oh! The feerate is too low, miners aren't including our transaction...
# 1 block is fine, maybe miners didn't see the tx...
bitcoind.generate_blocks_censor(1, [unvault_txid])
man.wait_for_log("Checking if transactions need CPFP...")
assert bitcoind.rpc.getmempoolentry(unvault_txid)["descendantcount"] == 1

# 2 blocks and yet not included? We start being aggressive.
bitcoind.generate_blocks_censor(1, [unvault_txid])
man.wait_for_log(
f"CPFPed transaction with id '{unvault_txid}'",
)
assert bitcoind.rpc.getmempoolentry(unvault_txid)["descendantcount"] == 2

# Case 2: the unvault is confirmed and removed from the CPFP table
bitcoind.generate_block(1)
for w in revault_network.participants():
wait_for(
lambda: len(w.rpc.listvaults(["unvaulted"], [deposit])["vaults"]) == 1,
)
man.wait_for_log(
f"Removed Unvault transaction {unvault_txid} from CPFPable table as it's confirmed",
)

# Case 3: the unvault got unconfirmed, insert it again in the CPFP table
bitcoind.simple_reorg(bitcoind.rpc.getblockcount() - 1, -1)
for w in revault_network.participants():
w.wait_for_log("Detected reorg")
wait_for(
lambda: len(w.rpc.listvaults(["unvaulting"], [deposit])["vaults"]) == 1,
)
man.wait_for_log(
f"Inserted Unvault transaction {unvault_txid} in CPFPable table as it got unconfirmed",
)

# TODO: Case 4: the unvault got evicted from the mempool, remove it from the CPFP table
# This is not implemented yet

# Alright, now let's do everything again for the spend :tada:

# Confirming the unvault
bitcoind.generate_block(1)
for w in revault_network.participants():
wait_for(
lambda: len(w.rpc.listvaults(["unvaulted"], [deposit])["vaults"]) == 1,
)

bitcoind.generate_block(CSV - 1)
man.wait_for_logs(
[
f"Succesfully broadcasted Spend tx '{spend_txid}'",
f"Inserted freshly-broadcasted Spend transaction {spend_txid} in CPFPable table",
]
)

# Uh oh! The feerate is too low, miners aren't including our transaction...
# 1 block is fine, maybe miners didn't see the tx...
bitcoind.generate_blocks_censor(1, [spend_txid])
assert bitcoind.rpc.getmempoolentry(spend_txid)["descendantcount"] == 1

# 2 blocks and yet not included? We start being aggressive.
bitcoind.generate_blocks_censor(1, [spend_txid])
man.wait_for_log(
f"CPFPed transaction with id '{spend_txid}'",
)
assert bitcoind.rpc.getmempoolentry(spend_txid)["descendantcount"] == 2

# Case 2: the spend is confirmed and removed from the CPFP table
bitcoind.generate_block(1)
for w in revault_network.participants():
wait_for(
lambda: len(w.rpc.listvaults(["spent"], [deposit])["vaults"]) == 1,
)
man.wait_for_log(
f"Removed Spend transaction {spend_txid} from CPFPable table as it's confirmed",
)

# Case 3: the spend got unconfirmed, insert it again in the CPFP table
bitcoind.simple_reorg(bitcoind.rpc.getblockcount() - 1, -1)
for w in revault_network.participants():
w.wait_for_log("Detected reorg")
wait_for(
lambda: len(w.rpc.listvaults(["spending"], [deposit])["vaults"]) == 1,
)
man.wait_for_log(
f"Inserted Spend transaction {spend_txid} in CPFPable table as it got unconfirmed",
)

# TODO: Case 4: the spend got evicted from the mempool, remove it from the CPFP table
# This case is (hopefully <3) handled in the code, it just needs to be tested

# Let's test that non priority txs don't get cpfped
amount = 0.24
vault = revault_network.fund(amount)
deposit = f"{vault['txid']}:{vault['vout']}"

revault_network.secure_vault(vault)
revault_network.activate_vault(vault)
spend_psbt = revault_network.unvault_vaults_anyhow([vault], priority=False)
spend_txid = spend_psbt.tx.hash

bitcoind.generate_block(CSV - 1)
man.wait_for_log(
f"Succesfully broadcasted Spend tx '{spend_txid}'",
)

# Uh oh! The feerate is too low, miners aren't including our transaction...
# 1 block is fine, maybe miners didn't see the tx...
bitcoind.generate_blocks_censor(1, [spend_txid])
assert bitcoind.rpc.getmempoolentry(spend_txid)["descendantcount"] == 1

# 2 blocks and yet not included? We are still calm, this tx has no priority...
bitcoind.generate_blocks_censor(1, [spend_txid])
man.wait_for_log("Checking if transactions need CPFP...")
# Nah, they don't
assert bitcoind.rpc.getmempoolentry(spend_txid)["descendantcount"] == 1

0 comments on commit 23a52fa

Please sign in to comment.