From ca92834493c20a255887c664d70bca79df57e6f0 Mon Sep 17 00:00:00 2001 From: hunicus <93150691+hunicus@users.noreply.github.com> Date: Wed, 15 Jun 2022 13:11:59 -0400 Subject: [PATCH] Edit formatting of regtest docs --- backend/README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/backend/README.md b/backend/README.md index b65001182..823998fdc 100644 --- a/backend/README.md +++ b/backend/README.md @@ -160,57 +160,56 @@ nodemon src/index.ts --ignore cache/ --ignore pools.json `nodemon` should be in npm's global binary folder. If needed, you can determine where that is with `npm -g bin`. -### Regtest cheatsheets +### Useful Regtest Commands -* Useful link https://gist.github.com/System-Glitch/cb4e87bf1ae3fec9925725bb3ebe223a +Helpful link: https://gist.github.com/System-Glitch/cb4e87bf1ae3fec9925725bb3ebe223a -* Run bitcoind for regtest +Run bitcoind on regtest: ``` bitcoind -regtest -rpcport=8332 ``` -* If it's the first time, create a new wallet +Create a new wallet, if needed: ``` bitcoin-cli -regtest -rpcport=8332 createwallet test ``` -* If it's not the first time, load the wallet. This command may take a while if you have lot of utxos +Load wallet (this command may take a while if you have lot of UTXOs): ``` bitcoin-cli -regtest -rpcport=8332 loadwallet test ``` -* Get a new address +Get a new address: ``` address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress) ``` -* Mine blocks to the previously generated new address, you need at least 101 blocks before being able to spend. This will take some time to execute (~1 min) +Mine blocks to the previously generated address. You need at least 101 blocks before you can spend. This will take some time to execute (~1 min): ``` bitcoin-cli -regtest -rpcport=8332 generatetoaddress 101 $address ``` -* Send 0.1 BTC at 5 sat/vB to another address +Send 0.1 BTC at 5 sat/vB to another address: ``` ./src/bitcoin-cli -named -regtest -rpcport=8332 sendtoaddress address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress) amount=0.1 fee_rate=5 ``` -* See more example of `sendtoaddress` +See more example of `sendtoaddress`: ``` ./src/bitcoin-cli sendtoaddress # will print the help ``` -* Mini script to generate transactions with random TX fee-rate (between 1 to 100 sat/vB). It's slow so don't expect to use this to test mempool spam, except if you let it run for a long time, or maybe with multiple regtest node connected to each other. +Mini script to generate transactions with random TX fee-rate (between 1 to 100 sat/vB). It's slow so don't expect to use this to test mempool spam, except if you let it run for a long time, or maybe with multiple regtest nodes connected to each other. ``` #!/bin/bash address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress) for i in {1..1000000} do - ./src/bitcoin-cli -regtest -rpcport=8332 -named sendtoaddress address=$address amount=0.01 fee_rate=$(jot -r 1 1 100) + ./src/bitcoin-cli -regtest -rpcport=8332 -named sendtoaddress address=$address amount=0.01 fee_rate=$(jot -r 1 1 100) done ``` -* Generate block at regular interval (every 10 sec in this example) +Generate block at regular interval (every 10 seconds in this example): ``` watch -n 10 "./src/bitcoin-cli -regtest -rpcport=8332 generatetoaddress 1 $address" ``` -