https://github.com/0xb10c/nix-bitcoin-core
A WORK_IN_PROGRESS Nix environment for Bitcoin Core development.
https://github.com/0xb10c/nix-bitcoin-core
Last synced: about 1 month ago
JSON representation
A WORK_IN_PROGRESS Nix environment for Bitcoin Core development.
- Host: GitHub
- URL: https://github.com/0xb10c/nix-bitcoin-core
- Owner: 0xB10C
- License: mit
- Created: 2024-03-28T14:57:29.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-23T21:50:32.000Z (10 months ago)
- Last Synced: 2025-03-28T03:03:54.863Z (about 2 months ago)
- Language: Nix
- Homepage:
- Size: 30.3 KB
- Stars: 5
- Watchers: 4
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nix-bitcoin-core
A Nix environment for Bitcoin Core development. Helps install necessary and optional dependencies.
## Installation
One way is to have the **nix-bitcoin-core/** directory alongside your **bitcoin/** directory, then symlink the shell.nix across. (Here it's done from **bitcoin/** assuming a common parent directory).
```console
ln -s ../nix-bitcoin-core/shell.nix .
```
## Usage
Get your terminal into the **bitcoin/** directory and do some variant of this:
```console
nix-shell --arg withClang true --arg withGui false
```
### Supported arguments
| Name | Description | Valid values |
|--------------|-----------------------------------------------|---------------|
| `bdbVersion` | Which version of Berkeley DB to use, if any.
Use `--argstr` instead of `--arg` with this one. | `""` = off
`"db48"` = Compatible v4.8
`"db5"` = Incompatible v5.x |
| `spareCores` | How many cores to exclude when running `make` | `` = less than the number of logical cores |
| `withClang` | Whether to switch from GCC to Clang for compilation | `` |
| `withDebug` | Whether to pass `--enable-debug` to `./configure` | `` |
| `withGui` | Whether to enable bitcoin-qt | `` |