This project packages Bitcoin for StartOS. Bitcoin uses peer-to-peer technology to operate with no central authority or banks - managing transactions and the issuing of bitcoins is carried out collectively by the network.

We welcome contributions from all!

For non-technical contributors, please use the Issues section above to communicate your desired edits or additions.

For technical contributors, please fork this repository, make your changes according to the instructions below, and open a pull reuqest.

To add config options, include the new config options in both scripts/services/getConfig.ts and assets/compat/bitcoin.conf.template, adhering to the syntax and conventions of those files. To view the full list of config options, complete with descriptions and specifications, check out this site from Jameson Lopp.

Install the following system dependencies to build this project by following the instructions on the provided links:

• docker
• docker-buildx
• rust-musl-cross
• yq
• rust
• start-sdk
• make

Clone the project locally. Note the submodule link to the original project(s).

git clone [email protected]:Start9Labs/bitcoind-wrapper.git
cd bitcoind-wrapper
git submodule update --init

To build the project for all supported platforms, run the following command:

make

To build the project for a single platform, run:

# for amd64
make x86

or

# for arm64
make arm

Run the following commands to determine successful install:

ℹ️ Change server-name.local to your Start9 server address

start-cli auth login
# Enter your StartOS password
start-cli --host https://server-name.local package install bitcoind.s9pk

If you already have your start-cli config file setup with a default host, you can install simply by running:

make install

Tip: You can also install the bitcoind.s9pk using Sideload Service under the System > Manage section.

Our documentation includes guides for integrating Bitcoin with external applications.