Skip to content

Commit f472a49

Browse files
author
Ludo Galabru
committed
fix: outdated documentation
1 parent 155e3a6 commit f472a49

File tree

1 file changed

+27
-18
lines changed

1 file changed

+27
-18
lines changed

README.md

+27-18
Original file line numberDiff line numberDiff line change
@@ -307,36 +307,45 @@ $ chainhook predicates scan ./path/to/predicate.json --testnet
307307
When using the flag `--testnet`, the scan operation will generate a configuration file in memory using the following settings:
308308
```toml
309309
[storage]
310-
driver = "memory"
311-
312-
[chainhooks]
313-
max_stacks_registrations = 500
314-
max_bitcoin_registrations = 500
310+
working_dir = "cache" # Directory used by chainhook node for caching data
315311

316312
[network]
317313
mode = "testnet"
318314
bitcoind_rpc_url = "http://0.0.0.0:18332"
319-
bitcoind_rpc_username = "testnet"
320-
bitcoind_rpc_password = "testnet"
321-
stacks_node_rpc_url = "http://0.0.0.0:20443"
315+
bitcoind_rpc_username = "bitcoind_username"
316+
bitcoind_rpc_password = "bitcoind_password"
317+
# bitcoind_zmq_url = "http://0.0.0.0:18543"
318+
319+
[limits]
320+
max_number_of_bitcoin_predicates = 100
321+
max_number_of_concurrent_bitcoin_scans = 100
322+
max_number_of_stacks_predicates = 10
323+
max_number_of_concurrent_stacks_scans = 10
324+
max_number_of_processing_threads = 16
325+
max_number_of_networking_threads = 16
326+
max_caching_memory_size_mb = 32000
322327
```
323328

324329
When using the flag `--mainnet`, the scan operation will generate a configuration file in memory using the following settings:
325330
```toml
326331
[storage]
327-
driver = "memory"
328-
329-
[chainhooks]
330-
max_stacks_registrations = 500
331-
max_bitcoin_registrations = 500
332+
working_dir = "cache"
332333

333334
[network]
334-
mode = "mainnet"
335+
mode = "testnet"
335336
bitcoind_rpc_url = "http://0.0.0.0:8332"
336-
bitcoind_rpc_username = "mainnet"
337-
bitcoind_rpc_password = "mainnet"
338-
stacks_node_rpc_url = "http://0.0.0.0:20443"
339-
337+
bitcoind_rpc_username = "bitcoind_username"
338+
bitcoind_rpc_password = "bitcoind_password"
339+
# bitcoind_zmq_url = "http://0.0.0.0:18543"
340+
341+
[limits]
342+
max_number_of_bitcoin_predicates = 100
343+
max_number_of_concurrent_bitcoin_scans = 100
344+
max_number_of_stacks_predicates = 10
345+
max_number_of_concurrent_stacks_scans = 10
346+
max_number_of_processing_threads = 16
347+
max_number_of_networking_threads = 16
348+
max_caching_memory_size_mb = 32000
340349
```
341350

342351
By passing the flag `--config=/path/to/config.toml`, developers can customize the credentials and network address of their bitcoin node.

0 commit comments

Comments
 (0)