hirosystems / chainhook

Extract transactions from Stacks and Bitcoin and build event driven re-org resistant indexers and databases.
GNU General Public License v3.0
155 stars 63 forks source link

Specify Bitcoind v24.0+ requirement in documentation and add version check #405

Open MicaiahReid opened 1 year ago

MicaiahReid commented 1 year ago

We need to specify in our documentation that a version of 24.0+ of bitcoind is required to use Chainhook to index a bitcoin node. We should update our readme and this guide: https://docs.hiro.so/chainhook/how-to-guides/how-to-run-chainhook-as-a-service-using-bitcoind

We should also add a version check on the initial RPC request to the bitcoin node to verify the correct version of bitcoind is being used by the user.

qustavo commented 1 year ago

although documentation is required, it might not be enough, chainhook instances running against bitcoind prior to v23 will fail silently and that can be confusing. A version check upon starting the service will help for a better diagnose and correct execution.

MicaiahReid commented 1 year ago

@qustavo totally agree! @lgalabru and I discussed this and I totally forgot to document this in the issue 🤦 . Thanks!

qustavo commented 1 year ago

My understanding is that prevout RPC field has been added on v23, what the reason behind requiring v24?

MicaiahReid commented 1 year ago

@qustavo We have some other requirements for ordhook, which uses Chainhook as a dependency.

qustavo commented 1 year ago

@qustavo We have some other requirements for ordhook, which uses Chainhook as a dependency.

thanks for clarifying!