Merge pull request #1889 from hunicus/regtest-formatting

Edit regtest docs formatting
This commit is contained in:
wiz 2022-06-17 07:44:04 +09:00 committed by GitHub
commit 7e08058d0a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -160,46 +160,46 @@ 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`. `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 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 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 bitcoin-cli -regtest -rpcport=8332 loadwallet test
``` ```
* Get a new address Get a new address:
``` ```
address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress) 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 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 ./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 ./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 #!/bin/bash
address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress) address=$(./src/bitcoin-cli -regtest -rpcport=8332 getnewaddress)
@ -209,8 +209,7 @@ nodemon src/index.ts --ignore cache/ --ignore pools.json
done 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" watch -n 10 "./src/bitcoin-cli -regtest -rpcport=8332 generatetoaddress 1 $address"
``` ```