You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-33Lines changed: 54 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,7 @@ just build # build the project
128
128
129
129
### Using `Justfile` to run `bitcoind` as a Client
130
130
131
-
If you are testing `bdk-cli` in regtest mode and wants to use your `bitcoind` node as a blockchain client, the `Justfile` can help you to quickly do so. Below are the steps to `start`, `connect` and `run` your `bitcoind` node:
131
+
If you are testing `bdk-cli` in regtest mode and wants to use your `bitcoind` node as a blockchain client, the `Justfile` can help you to quickly do so. Below are the steps to use your `bitcoind` node in *regtest* mode with `bdk-cli`:
132
132
133
133
Note: You can modify the `Justfile` to reflect your nodes' configuration values. These values are the default values used in `bdk-cli`
134
134
> * default wallet: The set default wallet name is `regtest_default_wallet`
@@ -139,40 +139,61 @@ Note: You can modify the `Justfile` to reflect your nodes' configuration values.
139
139
#### Steps
140
140
141
141
1. Start bitcoind
142
-
143
-
>> `just start`
144
-
145
-
2. Create or load a wallet
146
-
147
-
>> `just create` # if you do not have an existing default wallet (regtest_default_wallet)
148
-
149
-
>> `load wallet` # if you have an existing default wallet
150
-
151
-
3. Generate an address to mine regtest bitcoins.
152
-
153
-
>> `just address` # if you want to save to use in the next step `address=$(just address)`
154
-
155
-
4. Mine bitcoin
156
-
157
-
>> `just generate 101 $address` # or just generate to a new addres `just generate 101 (just address)`
158
-
159
-
5. Check Balance
160
-
161
-
>> `just balance`
162
-
163
-
6. Connect your `bdk-cli` wallet to your node and perform a full_scan
164
-
165
-
>> `cargo run --features rpc -- -n regtest wallet -w {your-bdk-cli-wallet-name} -u "127.0.0.1:18443" -c rpc -a user:password -d sqlite full_scan`
142
+
```shell
143
+
just start
144
+
```
145
+
146
+
2. Create or load a bitcoind wallet with default wallet name
147
+
148
+
```shell
149
+
just create
150
+
```
151
+
or
152
+
```shell
153
+
just load
154
+
```
155
+
156
+
3. Generate a bitcoind wallet address to send regtest bitcoins to.
157
+
158
+
```shell
159
+
just address
160
+
```
161
+
162
+
4. Mine 101 blocks on regtest to bitcoind wallet address
163
+
```shell
164
+
just generate 101 $(just address)
165
+
```
166
+
167
+
5. Check the bitcoind wallet balance
168
+
```shell
169
+
just balance
170
+
```
171
+
172
+
6. Setup your `bdk-cli` wallet config and connect it to your regtest node to perform a `sync`
0 commit comments