Fix: Decouple version numbers from run-bitcoind.sh to improve maintainability #112

GideonBature · 2025-03-31T06:11:16Z

Problem:

The script previously hardcoded version numbers and assumed specific directory structures in /opt/, making updates difficult and breaking user environments when new versions were introduced. Developers had to modify the script manually whenever a new version was released or when bitcoind was installed in a different location.

Solution:

This PR removes the hardcoded version numbers and introduces a configuration-based approach. The script now loads version numbers and bitcoind paths from either:

A custom environment variable (BITCOIND_VERSIONS_CONFIG), allowing users to specify their own config file location.
A configuration file (bitcoind_versions.conf), which developers can set up based on their local environment.

If no custom environment variable is provided (BITCOIND_VERSIONS_CONFIG), the script falls back to a default config file in the home directory (~/.bitcoind_versions.conf) or the script directory (./bitcoind_versions.conf).

Closes #28

AdamuAbba · 2025-04-01T14:18:14Z

Hey @GideonBature, I’d like to test this locally. Could you please guide me on how to do that? Thanks!

GideonBature · 2025-04-01T22:19:59Z

Oh! So here is a guide on how to test it:

Go to the corepc/contrib directory and create a file named bitcoind_versions.conf.
Make sure you have bitcoind installed, use the command: where bitcoind to locate the path where your bitcoind was installed (that is if you are using a standard installed version). You can also make use of paths to other bitcoind custom installations you did.
Next, use the command: bitcoind --version to check for the version of the bitcoind you want to make use. You can also use the exact version of any other bitcoind you installed apart from the standard installed one.
In the file you created in (1), add the following to the file:

v28 28.1.0 281 /opt/bin/bitcoind

Used v28 to indicate the main version, 28.1.0 which is the exact version gotten from running the command: bitcoind --version, 281 is the first three digits of the version number without a dot(.). And lastly /opt/bin/bitcoind is the path to the bitcoind executable.

Note: Make sure you put the exact version of the bitcoind you are using because the script is going to check what you put in the config file against the version of the bitcoind whose path you included in the configuration file.

With this you should be able to test the script file. Thank you @AdamuAbba.

tcharding · 2025-04-03T01:46:09Z

Thanks for the PR, I'll get to reviewing soon as I can.

contrib/run-bitcoind.sh

AdamuAbba

ACK #7fb7b7d; successfully ran a local test.

tcharding · 2025-04-04T22:42:44Z

Thanks for your work! I'll come back to review this.

nervana21 · 2025-04-05T10:12:39Z

tACK 7fb7b7d

Thanks @GideonBature!

This PR was tested and reviewed by checking out main at commit (870efdf), then applying the net diff from all four commits in this PR as a single patch.

corepc/contrib/run-bitcoind.patch

Reproduction process (macOS, bitcoind built from source):

# 1) Clone the repo and switch to main/master
git clone https://github.com/rust-bitcoin/corepc.git
cd corepc
git checkout main #or master

# 2) Add a config for the local bitcoind build
cat <<EOF > contrib/bitcoind_versions.conf
v28 28.99.0 289 /path/to/your/bitcoind
EOF

# 3) Attempt to run without the patch
cd contrib
./run-bitcoind.sh start v28

Pre-patch output:

./run-bitcoind.sh: line 168: /opt/bitcoin-28.0/bin/bitcoind: No such file or directory
Wrong bitcoind version, expected 28.0
./run-bitcoind.sh: line 172: /opt/bitcoin-28.0/bin/bitcoind: No such file or directory

# 4) Apply the patch and try again
git apply run-bitcoind.patch
./run-bitcoind.sh start v28

Post-patch output:

Starting bitcoind v28.99.0 (alias: v28)...
Bitcoin Core 28.99.0 nodes running (RPC port: 28949)

Suggest squashing commits for a cleaner history. Happy to provide the patch in other formats if that would be useful.

GideonBature · 2025-04-05T23:05:33Z

tACK 7fb7b7d

Thanks @GideonBature!

This PR was tested and reviewed by checking out main at commit (870efdf), then applying the net diff from all four commits in this PR as a single patch.

corepc/contrib/run-bitcoind.patch

Reproduction process (macOS, bitcoind built from source):
# 1) Clone the repo and switch to main/master
git clone https://github.com/rust-bitcoin/corepc.git
cd corepc
git checkout main #or master

# 2) Add a config for the local bitcoind build
cat <<EOF > contrib/bitcoind_versions.conf
v28 28.99.0 289 /path/to/your/bitcoind
EOF

# 3) Attempt to run without the patch
cd contrib
./run-bitcoind.sh start v28
Pre-patch output:
./run-bitcoind.sh: line 168: /opt/bitcoin-28.0/bin/bitcoind: No such file or directory
Wrong bitcoind version, expected 28.0
./run-bitcoind.sh: line 172: /opt/bitcoin-28.0/bin/bitcoind: No such file or directory
# 4) Apply the patch and try again
git apply run-bitcoind.patch
./run-bitcoind.sh start v28
Post-patch output:
Starting bitcoind v28.99.0 (alias: v28)...
Bitcoin Core 28.99.0 nodes running (RPC port: 28949)
Suggest squashing commits for a cleaner history. Happy to provide the patch in other formats if that would be useful.

This is awesome. Thank you! Will squash the commits.

tcharding

Looking good, two change requests please.

contrib/run-bitcoind.sh

tcharding

Thanks for sticking with this. Still a few things to, bash is hard to get right.

contrib/run-bitcoind.sh

tcharding · 2025-04-10T23:11:03Z

You mentioned throwing an example config file in someplace. I rekon that is a good idea. This is the one I've been using to test thing

# run-bitcoind configuration
#
# This file configures the `run-bitcoind.sh` script found in the `corepc` repository.

v17 0.17.2 172 /opt/bitcoin-0.17.2/bin/bitcoind
v18 0.18.1 181 /opt/bitcoin-0.18.1/bin/bitcoind
v19 0.19.1 191 /opt/bitcoin-0.19.1/bin/bitcoind
v20 0.20.2 202 /opt/bitcoin-0.20.2/bin/bitcoind
v21 0.21.2 212 /opt/bitcoin-0.21.2/bin/bitcoind
v22 22.1 221 /opt/bitcoin-22.1/bin/bitcoind
v23 23.2 232 /opt/bitcoin-23.2/bin/bitcoind
v24 24.2 242 /opt/bitcoin-24.2/bin/bitcoind
v25 25.2 252 /opt/bitcoin-25.2/bin/bitcoind
v26 26.2 262 /opt/bitcoin-26.2/bin/bitcoind
v27 27.1 271 /opt/bitcoin-27.1/bin/bitcoind
v28 28.1 281 /opt/bitcoin-28.0/bin/bitcoind

GideonBature · 2025-04-11T07:23:54Z

You mentioned throwing an example config file in someplace. I rekon that is a good idea. This is the one I've been using to test thing

# run-bitcoind configuration
#
# This file configures the `run-bitcoind.sh` script found in the `corepc` repository.

v17 0.17.2 172 /opt/bitcoin-0.17.2/bin/bitcoind
v18 0.18.1 181 /opt/bitcoin-0.18.1/bin/bitcoind
v19 0.19.1 191 /opt/bitcoin-0.19.1/bin/bitcoind
v20 0.20.2 202 /opt/bitcoin-0.20.2/bin/bitcoind
v21 0.21.2 212 /opt/bitcoin-0.21.2/bin/bitcoind
v22 22.1 221 /opt/bitcoin-22.1/bin/bitcoind
v23 23.2 232 /opt/bitcoin-23.2/bin/bitcoind
v24 24.2 242 /opt/bitcoin-24.2/bin/bitcoind
v25 25.2 252 /opt/bitcoin-25.2/bin/bitcoind
v26 26.2 262 /opt/bitcoin-26.2/bin/bitcoind
v27 27.1 271 /opt/bitcoin-27.1/bin/bitcoind
v28 28.1 281 /opt/bitcoin-28.0/bin/bitcoind

:) Thank you!

I have implemented the changes... Thank you so much for the reviews.

tcharding

Almost there! Thanks for sticking with this.

tcharding · 2025-04-11T21:40:28Z

contrib/run-bitcoind.sh

+
+- Examples
+
+    v28 28.1 280 /opt/bitcoin-28.0/bin/bitcoind


Woops I think this mistake was mine last review, should be 28.0

tcharding · 2025-04-11T21:42:22Z

contrib/run-bitcoind.sh

+
+    v28 28.1 280 /opt/bitcoin-28.0/bin/bitcoind
+    v24 24.2 242 /opt/bitcoin-24.2/bin/bitcoind
+    v21 0.21.2 212 /opt/bitcoin-0.21.2/bin/bitcoind
 EOF


Since we have another iteration anyways, perhaps a new line before the EOF, makes the output slightly better when an incorrect command is given. Not really important though.

tcharding · 2025-04-11T21:42:41Z

contrib/run-bitcoind.sh

-
-    echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port}"
+    sleep 1  # Let nodes connect
+    echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port})"


Suggested change

echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port})"

echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port}"

GideonBature mentioned this pull request Mar 31, 2025

run-bitcoind.sh implies things about the environment #28

Open

nervana21 reviewed Apr 4, 2025

View reviewed changes

contrib/run-bitcoind.sh Outdated Show resolved Hide resolved

AdamuAbba approved these changes Apr 4, 2025

View reviewed changes

tcharding reviewed Apr 10, 2025

View reviewed changes

contrib/run-bitcoind.sh Outdated Show resolved Hide resolved

contrib/run-bitcoind.sh Outdated Show resolved Hide resolved

GideonBature force-pushed the run-bitcoind_script branch 2 times, most recently from a3c2301 to bcb840e Compare April 10, 2025 15:41

tcharding reviewed Apr 10, 2025

View reviewed changes

Decouple version numbers for maintainability

852b444

GideonBature force-pushed the run-bitcoind_script branch from bcb840e to 852b444 Compare April 11, 2025 07:32

tcharding reviewed Apr 11, 2025

View reviewed changes

tcharding mentioned this pull request Apr 11, 2025

Add support for bitcoin core 0.17.2 #128

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Decouple version numbers from run-bitcoind.sh to improve maintainability #112

Fix: Decouple version numbers from run-bitcoind.sh to improve maintainability #112

GideonBature commented Mar 31, 2025 •

edited

Loading

AdamuAbba commented Apr 1, 2025

GideonBature commented Apr 1, 2025

tcharding commented Apr 3, 2025

AdamuAbba left a comment •

edited

Loading

tcharding commented Apr 4, 2025

nervana21 commented Apr 5, 2025 •

edited

Loading

GideonBature commented Apr 5, 2025

Reproduction process (macOS, bitcoind built from source):

Pre-patch output:

Post-patch output:

tcharding left a comment •

edited

Loading

tcharding left a comment

tcharding commented Apr 10, 2025 •

edited

Loading

GideonBature commented Apr 11, 2025

tcharding left a comment

tcharding Apr 11, 2025

tcharding Apr 11, 2025

tcharding Apr 11, 2025

	echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port})"
	echo "Two connected bitcoind v${version_number} instances running, one node has JSON-RPC listening on port ${rpc_port}"

Fix: Decouple version numbers from run-bitcoind.sh to improve maintainability #112

Are you sure you want to change the base?

Fix: Decouple version numbers from run-bitcoind.sh to improve maintainability #112

Conversation

GideonBature commented Mar 31, 2025 • edited Loading

AdamuAbba commented Apr 1, 2025

GideonBature commented Apr 1, 2025

tcharding commented Apr 3, 2025

AdamuAbba left a comment • edited Loading

Choose a reason for hiding this comment

tcharding commented Apr 4, 2025

nervana21 commented Apr 5, 2025 • edited Loading

Reproduction process (macOS, bitcoind built from source):

Pre-patch output:

Post-patch output:

GideonBature commented Apr 5, 2025

Reproduction process (macOS, bitcoind built from source):

Pre-patch output:

Post-patch output:

tcharding left a comment • edited Loading

Choose a reason for hiding this comment

tcharding left a comment

Choose a reason for hiding this comment

tcharding commented Apr 10, 2025 • edited Loading

GideonBature commented Apr 11, 2025

tcharding left a comment

Choose a reason for hiding this comment

tcharding Apr 11, 2025

Choose a reason for hiding this comment

tcharding Apr 11, 2025

Choose a reason for hiding this comment

tcharding Apr 11, 2025

Choose a reason for hiding this comment

GideonBature commented Mar 31, 2025 •

edited

Loading

AdamuAbba left a comment •

edited

Loading

nervana21 commented Apr 5, 2025 •

edited

Loading

tcharding left a comment •

edited

Loading

tcharding commented Apr 10, 2025 •

edited

Loading