2017-03-09 14:14:55 -08:00
#!/usr/bin/env python3
# Copyright (c) 2014-2017 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
""" Test mempool persistence.
By default , bitcoind will dump mempool on shutdown and
then reload it on startup . This can be overridden with
2017-05-05 06:17:39 -07:00
the - persistmempool = 0 command line option .
2017-03-09 14:14:55 -08:00
Test is as follows :
2017-05-05 06:17:39 -07:00
- start node0 , node1 and node2 . node1 has - persistmempool = 0
2017-03-09 14:14:55 -08:00
- create 5 transactions on node2 to its own address . Note that these
are not sent to node0 or node1 addresses because we don ' t want
them to be saved in the wallet .
- check that node0 and node1 have 5 transactions in their mempools
- shutdown all nodes .
- startup node0 . Verify that it still has 5 transactions
in its mempool . Shutdown node0 . This tests that by default the
mempool is persistent .
- startup node1 . Verify that its mempool is empty . Shutdown node1 .
2017-05-05 06:17:39 -07:00
This tests that with - persistmempool = 0 , the mempool is not
2017-03-09 14:14:55 -08:00
dumped to disk when the node is shut down .
2017-05-05 06:17:39 -07:00
- Restart node0 with - persistmempool = 0. Verify that its mempool is
empty . Shutdown node0 . This tests that with - persistmempool = 0 ,
2017-03-09 14:14:55 -08:00
the mempool is not loaded from disk on start up .
2017-05-05 06:17:39 -07:00
- Restart node0 with - persistmempool . Verify that it has 5
transactions in its mempool . This tests that - persistmempool = 0
2017-03-09 14:14:55 -08:00
does not overwrite a previously valid mempool stored on disk .
2017-08-21 04:23:18 -07:00
- Remove node0 mempool . dat and verify savemempool RPC recreates it
2018-03-18 07:26:45 -07:00
and verify that node1 can load it and has 5 transactions in its
2017-08-21 04:23:18 -07:00
mempool .
- Verify that savemempool throws when the RPC is called if
node1 can ' t write to disk.
2017-03-09 14:14:55 -08:00
"""
2017-08-21 04:23:18 -07:00
import os
2017-05-05 06:17:39 -07:00
import time
2017-03-09 14:14:55 -08:00
from test_framework . test_framework import BitcoinTestFramework
from test_framework . util import *
class MempoolPersistTest ( BitcoinTestFramework ) :
2017-06-09 15:21:21 -07:00
def set_test_params ( self ) :
2017-03-09 14:14:55 -08:00
self . num_nodes = 3
2017-05-05 06:17:39 -07:00
self . extra_args = [ [ ] , [ " -persistmempool=0 " ] , [ ] ]
2017-03-09 14:14:55 -08:00
def run_test ( self ) :
chain_height = self . nodes [ 0 ] . getblockcount ( )
assert_equal ( chain_height , 200 )
self . log . debug ( " Mine a single block to get out of IBD " )
self . nodes [ 0 ] . generate ( 1 )
2017-05-05 06:17:39 -07:00
self . sync_all ( )
2017-03-09 14:14:55 -08:00
self . log . debug ( " Send 5 transactions from node2 (to its own address) " )
for i in range ( 5 ) :
self . nodes [ 2 ] . sendtoaddress ( self . nodes [ 2 ] . getnewaddress ( ) , Decimal ( " 10 " ) )
2017-12-06 09:08:40 -08:00
node2_balance = self . nodes [ 2 ] . getbalance ( )
2017-03-09 14:14:55 -08:00
self . sync_all ( )
self . log . debug ( " Verify that node0 and node1 have 5 transactions in their mempools " )
assert_equal ( len ( self . nodes [ 0 ] . getrawmempool ( ) ) , 5 )
assert_equal ( len ( self . nodes [ 1 ] . getrawmempool ( ) ) , 5 )
2017-12-06 09:08:40 -08:00
self . log . debug ( " Stop-start the nodes. Verify that node0 has the transactions in its mempool and node1 does not. Verify that node2 calculates its balance correctly after loading wallet transactions. " )
2017-03-23 20:56:31 -07:00
self . stop_nodes ( )
2018-03-06 15:43:50 -08:00
# Give this node a head-start, so we can be "extra-sure" that it didn't load anything later
# Also don't store the mempool, to keep the datadir clean
self . start_node ( 1 , extra_args = [ " -persistmempool=0 " ] )
2017-06-09 13:35:17 -07:00
self . start_node ( 0 )
2017-12-06 09:08:40 -08:00
self . start_node ( 2 )
2017-05-05 06:17:39 -07:00
# Give bitcoind a second to reload the mempool
2018-01-18 07:16:34 -08:00
wait_until ( lambda : len ( self . nodes [ 0 ] . getrawmempool ( ) ) == 5 , timeout = 1 )
wait_until ( lambda : len ( self . nodes [ 2 ] . getrawmempool ( ) ) == 5 , timeout = 1 )
# The others have loaded their mempool. If node_1 loaded anything, we'd probably notice by now:
2017-03-09 14:14:55 -08:00
assert_equal ( len ( self . nodes [ 1 ] . getrawmempool ( ) ) , 0 )
2017-12-06 09:08:40 -08:00
# Verify accounting of mempool transactions after restart is correct
2018-01-18 07:16:34 -08:00
self . nodes [ 2 ] . syncwithvalidationinterfacequeue ( ) # Flush mempool to wallet
2017-12-06 09:08:40 -08:00
assert_equal ( node2_balance , self . nodes [ 2 ] . getbalance ( ) )
2017-05-05 06:17:39 -07:00
self . log . debug ( " Stop-start node0 with -persistmempool=0. Verify that it doesn ' t load its mempool.dat file. " )
2017-03-23 20:56:31 -07:00
self . stop_nodes ( )
2017-06-09 13:35:17 -07:00
self . start_node ( 0 , extra_args = [ " -persistmempool=0 " ] )
2017-05-05 06:17:39 -07:00
# Give bitcoind a second to reload the mempool
time . sleep ( 1 )
2017-03-09 14:14:55 -08:00
assert_equal ( len ( self . nodes [ 0 ] . getrawmempool ( ) ) , 0 )
self . log . debug ( " Stop-start node0. Verify that it has the transactions in its mempool. " )
2017-03-23 20:56:31 -07:00
self . stop_nodes ( )
2017-06-09 13:35:17 -07:00
self . start_node ( 0 )
2017-08-16 09:17:34 -07:00
wait_until ( lambda : len ( self . nodes [ 0 ] . getrawmempool ( ) ) == 5 )
2017-03-09 14:14:55 -08:00
2018-01-02 05:57:27 -08:00
mempooldat0 = os . path . join ( self . nodes [ 0 ] . datadir , ' regtest ' , ' mempool.dat ' )
mempooldat1 = os . path . join ( self . nodes [ 1 ] . datadir , ' regtest ' , ' mempool.dat ' )
2017-08-21 04:23:18 -07:00
self . log . debug ( " Remove the mempool.dat file. Verify that savemempool to disk via RPC re-creates it " )
os . remove ( mempooldat0 )
self . nodes [ 0 ] . savemempool ( )
assert os . path . isfile ( mempooldat0 )
self . log . debug ( " Stop nodes, make node1 use mempool.dat from node0. Verify it has 5 transactions " )
os . rename ( mempooldat0 , mempooldat1 )
self . stop_nodes ( )
self . start_node ( 1 , extra_args = [ ] )
wait_until ( lambda : len ( self . nodes [ 1 ] . getrawmempool ( ) ) == 5 )
self . log . debug ( " Prevent bitcoind from writing mempool.dat to disk. Verify that `savemempool` fails " )
# to test the exception we are setting bad permissions on a tmp file called mempool.dat.new
# which is an implementation detail that could change and break this test
mempooldotnew1 = mempooldat1 + ' .new '
with os . fdopen ( os . open ( mempooldotnew1 , os . O_CREAT , 0o000 ) , ' w ' ) :
pass
2017-07-12 07:33:46 -07:00
assert_raises_rpc_error ( - 1 , " Unable to dump mempool to disk " , self . nodes [ 1 ] . savemempool )
2017-08-21 04:23:18 -07:00
os . remove ( mempooldotnew1 )
2017-03-09 14:14:55 -08:00
if __name__ == ' __main__ ' :
MempoolPersistTest ( ) . main ( )