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
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -122,11 +122,57 @@ The below are some of the commands included:
122
122
123
123
```shell
124
124
just # list all available recipes
125
-
just start # start regtest bitcoind in default dir
126
125
just test# test the project
127
126
just build # build the project
128
127
```
129
128
129
+
### Using `Justfile` to run `bitcoind` as a Client
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:
132
+
133
+
Note: You can modify the `Justfile` to reflect your nodes' configuration values. These values are the default values used in `bdk-cli`
134
+
> * default wallet: The set default wallet name is `regtest_default_wallet`
135
+
> * default data directory: The set default data directory is `~/.bdk-bitcoin`
136
+
> * RPC username: The set RPC username is `user`
137
+
> * RPC password: The set RPC password is `password`
138
+
139
+
#### Steps
140
+
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`
166
+
167
+
7. Generate an address from your `bdk-cli` wallet and fund it with 10 bitcoins from your bitcoind node's wallet
0 commit comments