Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/judecoin/judecoin

Website of the judecoin Ecosystem project
https://github.com/judecoin/judecoin

blockchain cryptonote judecoin privacy security

Last synced: 21 days ago
JSON representation

Website of the judecoin Ecosystem project

Awesome Lists containing this project

README 

          
# Judecoin



Copyright (c) 2014-2026 The Judecoin Project.   

Portions Copyright (c) The Cryptonote developers.



## Table of Contents



- [Development Resources](#development-resources)

- [Documentation](#documentation)

- [Vulnerability Response](#vulnerability-response)

- [Research](#research)

- [Announcements](#announcements)

- [Translations](#translations)

- [Coverage](#coverage)

- [Introduction](#introduction)

- [About This Project](#about-this-project)

- [Supporting the Project](#supporting-the-project)

- [License](#license)

- [Contributing](#contributing)

- [Scheduled Software Upgrades](#scheduled-software-upgrades)

- [Release Staging Schedule and Protocol](#release-staging-schedule-and-protocol)

- [Compiling Judecoin from Source](#compiling-judecoin-from-source)

- [Running Judecoind](#running-judecoind)

- [Internationalization](#internationalization)

- [Using Tor](#using-tor)

- [Pruning](#pruning)

- [Debugging](#debugging)

- [Known Issues](#known-issues)



## Development Resources



- Web: [judecoin.info](https://www.judecoin.info/)

- Community-News: [github.com/Judecoin/information](https://github.com/Judecoin/information/tree/main/community-news)

- GitHub: [github.com/Judecoin/judecoin](https://github.com/Judecoin/judecoin)

- Block Explorer: [judeblock.org](https://www.judeblock.org/)



## Documentation



- [Judecoin Wallet Documentation](https://github.com/Judecoin/wallet)

- [PoS Evolution and Service Node Documentation](https://github.com/Judecoin/pos-evolution)



## Vulnerability Response



Responsible disclosure is encouraged.



If you discover a security issue, please report it through the official Judecoin communication channels or the official repository issue process when appropriate.



Please do not publicly disclose sensitive vulnerabilities before they have been reviewed.



## Research



Judecoin research and development may include work related to privacy, cryptography, protocols, fungibility, network behavior, wallet tools, and Service Node operation.



For roadmap-related research and development directions, please refer to the [Judecoin Roadmap](https://www.judecoin.info/roadmap).



Researchers, developers, and contributors are welcome to review the codebase, discuss technical improvements, and submit relevant contributions.



## Announcements



Important announcements, software updates, release notes, and upgrade information should be checked through official Judecoin resources.



For updates, please refer to the [Judecoin Community News](https://www.judecoin.info/community-news).



Users, wallet operators, node operators, and service providers should keep their software updated according to official release guidance.



## Translations



Judecoin wallet tools may support multiple languages depending on the release version.



Translation support and localization behavior may vary by wallet type and software release.



## Coverage



Coverage and testing status may vary by repository configuration, release branch, and development stage.



Please refer to the current repository status, release notes, and available CI/test results where applicable.



| Type | Status |

|------|--------|

| License | [![License](https://img.shields.io/badge/license-BSD3-blue.svg)](https://opensource.org/licenses/BSD-3-Clause) |



## Introduction



JUDE is many things. A private cryptocurrency. A secure messaging platform. A network anonymity layer. A vision for a future where privacy is effortless.



We provide a range of tools and services powered by the JUDE network, enabling people all over the world to leverage the power of decentralised blockchain networks to achieve unparalleled privacy and security as they work, play, and live their day-to-day lives on the internet. But this isn’t a plan we have for the future — our suite of privacy tools already exists, and it is already used by over one million people.



Judecoin is a privacy-focused cryptocurrency and blockchain network built for private digital payments, censorship-resistant value transfer, decentralized participation, and long-term ecosystem infrastructure.



At its core, Judecoin is designed to protect user privacy while enabling secure value transfer on a verifiable blockchain network. It gives users a way to send, receive, store, and participate in the network’s digital value without relying on fully transparent transaction systems that expose financial activity to public tracing.



JUDE is the native currency of the Judecoin network. It is used for transactions, value transfer, staking, Service Node participation, reward distribution, atomic swaps, and future ecosystem activity.



Judecoin is built as a privacy-focused network that brings together private digital currency, Proof of Stake, Service Nodes, wallet infrastructure, atomic swap development, cross-chain value movement, privacy tools, network anonymity, and future ecosystem applications.



**Privacy:** Judecoin uses privacy-oriented cryptographic technology to help users send and receive funds without exposing unnecessary transaction information on the public blockchain. This helps protect purchases, receipts, transfers, and financial activity by default.



**Security:** Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have recovery information that should be backed up carefully and protected with strong security practices.



**Censorship resistance:** Judecoin is designed to let users hold, send, receive, and participate in digital value without relying on banks, payment platforms, or centralized intermediaries.



**Decentralization:** The utility of Judecoin depends on its decentralized peer-to-peer network, wallet infrastructure, Service Node operation, Proof of Stake participation, research-driven development, atomic swap capability, cross-chain value movement, and community participation. Anyone should be able to run Judecoin software, validate the integrity of the blockchain, and contribute to the long-term resilience of the Judecoin network.



## About This Project



This repository contains the core implementation of Judecoin. It is open source and free to use under the terms specified in the license agreement below.



The project includes the core daemon, wallet tools, build files, network components, and related technical documentation needed to build, run, and contribute to the Judecoin network.



As with many open source projects, this repository may include ongoing development work. Users running production systems should follow official release guidance and use tagged stable releases whenever possible.



**Anyone is welcome to contribute to Judecoin's codebase and documentation.** Clear, accurate, and relevant pull requests are welcome. Larger or more complex changes should be discussed in advance or reviewed carefully through the pull request process.



## Supporting the Project



Judecoin is a community-supported open source project.



If you would like to support the project, you may do so through the official donation address below, or by using the `donate` command in the command-line wallet.



The Judecoin donation address is:



`J6GX4gh7ix1ft9xVvUci45cTPFPjaRihnNQ7Y8kRvAxCNGVh6Fw8Hw83aJ8hFZyYtvB2CBaBfNKK3gSr4zJkqox1Jm2TiLF`



## License



See [LICENSE](LICENSE).



## Contributing



If you want to help, see [CONTRIBUTING](docs/CONTRIBUTING.md) for contribution guidelines.



You may contribute by improving documentation, reporting issues, testing releases, submitting code, or helping improve user guides.



Before submitting changes, please make sure your contribution is clear, accurate, and relevant to the Judecoin project.



## Scheduled Software Upgrades



Judecoin uses a fixed-schedule software upgrade (hard fork) mechanism to implement new features. This means that users of Judecoin (end users and service providers) should run current versions and upgrade their software on a regular schedule. Software upgrades occur during the months of April and October. The required software for these upgrades will be available prior to the scheduled date. Please check the repository prior to this date for the proper Judecoin software version. Below is the historical schedule and the projected schedule for the next upgrade.

Dates are provided in the format YYYY-MM-DD.



| Software upgrade block height | Date | Fork version | Minimum Judecoin version | Recommended Judecoin version | Details |

|-------------------------------|------|--------------|--------------------------|------------------------------|---------|



## Release Staging Schedule and Protocol



Approximately three months prior to a scheduled software upgrade, a branch from master will be created with the new release version tag. Pull requests that address bugs should then be made to both master and the new release branch. Pull requests that require extensive review and testing (generally, optimizations and new features) should *not* be made to the release branch.



## Compiling Judecoin from Source



### Dependencies



The following table summarizes the tools and libraries required to build. A

few of the libraries are also included in this repository (marked as

"Vendored"). By default, the build uses the library installed on the system

and ignores the vendored sources. However, if no library is found installed on

the system, then the vendored source will be built and used. The vendored

sources are also used for statically-linked builds because distribution

packages often include only shared library binaries (`.so`) but not static

library archives (`.a`).



| Dep          | Min. version  | Vendored | Debian/Ubuntu pkg    | Arch pkg     | Void pkg           | Fedora pkg          | Optional | Purpose         |

| ------------ | ------------- | -------- | -------------------- | ------------ | ------------------ | ------------------- | -------- | --------------- |

| GCC          | 4.7.3         | NO       | `build-essential`    | `base-devel` | `base-devel`       | `gcc`               | NO       |                 |

| CMake        | 3.5           | NO       | `cmake`              | `cmake`      | `cmake`            | `cmake`             | NO       |                 |

| pkg-config   | any           | NO       | `pkg-config`         | `base-devel` | `base-devel`       | `pkgconf`           | NO       |                 |

| Boost        | 1.58          | NO       | `libboost-all-dev`   | `boost`      | `boost-devel`      | `boost-devel`       | NO       | C++ libraries   |

| OpenSSL      | basically any | NO       | `libssl-dev`         | `openssl`    | `libressl-devel`   | `openssl-devel`     | NO       | sha256 sum      |

| libzmq       | 3.0.0         | NO       | `libzmq3-dev`        | `zeromq`     | `zeromq-devel`     | `zeromq-devel`      | NO       | ZeroMQ library  |

| OpenPGM      | ?             | NO       | `libpgm-dev`         | `libpgm`     |                    | `openpgm-devel`     | NO       | For ZeroMQ      |

| libnorm[2]   | ?             | NO       | `libnorm-dev`        |              |                    |                     | YES      | For ZeroMQ      |

| libunbound   | 1.4.16        | YES      | `libunbound-dev`     | `unbound`    | `unbound-devel`    | `unbound-devel`     | NO       | DNS resolver    |

| libsodium    | ?             | NO       | `libsodium-dev`      | `libsodium`  | `libsodium-devel`  | `libsodium-devel`   | NO       | cryptography    |

| libunwind    | any           | NO       | `libunwind8-dev`     | `libunwind`  | `libunwind-devel`  | `libunwind-devel`   | YES      | Stack traces    |

| liblzma      | any           | NO       | `liblzma-dev`        | `xz`         | `liblzma-devel`    | `xz-devel`          | YES      | For libunwind   |

| libreadline  | 6.3.0         | NO       | `libreadline6-dev`   | `readline`   | `readline-devel`   | `readline-devel`    | YES      | Input editing   |

| ldns         | 1.6.17        | NO       | `libldns-dev`        | `ldns`       | `libldns-devel`    | `ldns-devel`        | YES      | SSL toolkit     |

| expat        | 1.1           | NO       | `libexpat1-dev`      | `expat`      | `expat-devel`      | `expat-devel`       | YES      | XML parsing     |

| GTest        | 1.5           | YES      | `libgtest-dev`[1]    | `gtest`      | `gtest-devel`      | `gtest-devel`       | YES      | Test suite      |

| Doxygen      | any           | NO       | `doxygen`            | `doxygen`    | `doxygen`          | `doxygen`           | YES      | Documentation   |

| Graphviz     | any           | NO       | `graphviz`           | `graphviz`   | `graphviz`         | `graphviz`          | YES      | Documentation   |

| lrelease     | ?             | NO       | `qttools5-dev-tools` | `qt5-tools`  | `qt5-tools`        | `qt5-linguist`      | YES      | Translations    |

| libhidapi    | ?             | NO       | `libhidapi-dev`      | `hidapi`     | `hidapi-devel`     | `hidapi-devel`      | YES      | Hardware wallet |

| libusb       | ?             | NO       | `libusb-1.0-0-dev`   | `libusb`     | `libusb-devel`     | `libusbx-devel`     | YES      | Hardware wallet |

| libprotobuf  | ?             | NO       | `libprotobuf-dev`    | `protobuf`   | `protobuf-devel`   | `protobuf-devel`    | YES      | Hardware wallet |

| protoc       | ?             | NO       | `protobuf-compiler`  | `protobuf`   | `protobuf`         | `protobuf-compiler` | YES      | Hardware wallet |

| libudev      | ?             | No       | `libudev-dev`        | `systemd`    | `eudev-libudev-devel` | `systemd-devel`     | YES      | Hardware wallet |



[1] On Debian/Ubuntu `libgtest-dev` only includes sources and headers. You must

build the library binary manually. This can be done with the following command ```sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libg* /usr/lib/ ```

[2] libnorm-dev is needed if your zmq library was built with libnorm, and not needed otherwise



Install all dependencies at once on Debian/Ubuntu:



``` sudo apt update && sudo apt install build-essential cmake pkg-config libboost-all-dev libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev doxygen graphviz libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler libudev-dev```



Install all dependencies at once on macOS with the provided Brewfile:

``` brew update && brew bundle --file=contrib/brew/Brewfile ```



FreeBSD 12.1 one-liner required to build dependencies:

```pkg install git gmake cmake pkgconf boost-libs libzmq4 libsodium```



### Cloning the repository



Clone recursively to pull-in needed submodule(s):



`$ git clone --recursive https://github.com/Judecoin/judecoin`



If you already have a repo cloned, initialize and update:



`$ cd judecoin && git submodule init && git submodule update`



### Build instructions



Judecoin uses the CMake build system and a top-level [Makefile](Makefile) that

invokes cmake commands as needed.



#### On Linux and macOS



* Install the dependencies

* Change to the root of the source code directory, change to the most recent release tag, and build:



    ```bash

    cd judecoin

    git checkout 

    make

    ```



    *Optional*: If your machine has several cores and enough memory, enable

    parallel build by running `make -j` instead of `make`. For

    this to be worthwhile, the machine should have one core and about 2GB of RAM

    available per thread.



    *Note*: The instructions above will compile the most stable release of the

    Judecoin software. If you would like to use and test the most recent software,

    use ```git checkout master```. The master branch may contain updates that are

    both unstable and incompatible with release software, though testing is always

    encouraged.



* The resulting executables can be found in `build/release/bin`



* Add `PATH="$PATH:$HOME/judecoin/build/release/bin"` to `.profile`



* Run Judecoin with `judecoind --detach`



* **Optional**: build and run the test suite to verify the binaries:



    ```bash

    make release-test

    ```



    *NOTE*: `core_tests` test may take a few hours to complete.



* **Optional**: to build binaries suitable for debugging:



    ```bash

    make debug

    ```



* **Optional**: to build statically-linked binaries:



    ```bash

    make release-static

    ```



Dependencies need to be built with -fPIC. Static libraries usually aren't, so you may have to build them yourself with -fPIC. Refer to their documentation for how to build them.



* **Optional**: build documentation in `doc/html` (omit `HAVE_DOT=YES` if `graphviz` is not installed):



    ```bash

    HAVE_DOT=YES doxygen Doxyfile

    ```



#### On the Raspberry Pi



Tested on a Raspberry Pi Zero with a clean install of minimal Raspbian Stretch (2017-09-07 or later). If you are using Raspbian Jessie, [please see note in the following section](#note-for-raspbian-jessie-users).



* `apt-get update && apt-get upgrade` to install all of the latest software



* Install the dependencies for Judecoin from the 'Debian' column in the table above.



* Increase the system swap size:



    ```bash

    sudo /etc/init.d/dphys-swapfile stop  

    sudo nano /etc/dphys-swapfile  

    CONF_SWAPSIZE=2048

    sudo /etc/init.d/dphys-swapfile start

    ```



* If using an external hard disk without an external power supply, ensure it gets enough power to avoid hardware issues when syncing, by adding the line "max_usb_current=1" to /boot/config.txt



* Clone Judecoin and checkout the most recent release version:



    ```bash

    git clone https://github.com/Judecoin/judecoin.git

    cd judecoin

    git checkout 

    ```



* Build:



    ```bash

    make release

    ```



* Wait 4-6 hours



* The resulting executables can be found in `build/release/bin`



* Add `PATH="$PATH:$HOME/judecoin/build/release/bin"` to `.profile`



* Run Judecoin with `judecoind --detach`



* You may wish to reduce the size of the swap file after the build has finished, and delete the boost directory from your home directory



#### Note for Raspbian Jessie users



If you are using the older Raspbian Jessie image, compiling Judecoin is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with Judecoin, and thus you must compile a newer version yourself. The following explains the extra steps and has been tested on a Raspberry Pi 2 with a clean install of minimal Raspbian Jessie.



* As before, `apt-get update && apt-get upgrade` to install all of the latest software, and increase the system swap size



    ```bash

    sudo /etc/init.d/dphys-swapfile stop

    sudo nano /etc/dphys-swapfile

    CONF_SWAPSIZE=2048

    sudo /etc/init.d/dphys-swapfile start

    ```

    

* Then, install the dependencies for Judecoin except for `libunwind` and `libboost-all-dev`



* Install the latest version of boost (this may first require invoking `apt-get remove --purge libboost*-dev` to remove a previous version if you're not using a clean install):



    ```bash

    cd

    wget https://sourceforge.net/projects/boost/files/boost/1.72.0/boost_1_72_0.tar.bz2

    tar xvfo boost_1_72_0.tar.bz2

    cd boost_1_72_0

    ./bootstrap.sh

    sudo ./b2

    ```



* Wait ~8 hours



    ```bash    

    sudo ./bjam cxxflags=-fPIC cflags=-fPIC -a install

    ```



* Wait ~4 hours



* From here, follow the [general Raspberry Pi instructions](#on-the-raspberry-pi) from the "Clone Judecoin and checkout most recent release version" step.



### On Windows



Binaries for Windows are built on Windows using the MinGW toolchain within

[MSYS2 environment](https://www.msys2.org). The MSYS2 environment emulates a

POSIX system. The toolchain runs within the environment and *cross-compiles*

binaries that can run outside of the environment as a regular Windows

application.



**Preparing the build environment**



* Download and install the [MSYS2 installer](https://www.msys2.org), either the 64-bit or the 32-bit package, depending on your system.

* Open the MSYS shell via the `MSYS2 Shell` shortcut

* Update packages using pacman:  



    ```bash

    pacman -Syu

    ```



* Exit the MSYS shell using Alt+F4  

* Edit the properties for the `MSYS2 Shell` shortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds

* Restart MSYS shell via modified shortcut and update packages again using pacman:  



    ```bash

    pacman -Syu

    ```



* Install dependencies:



    To build for 64-bit Windows:



    ```bash

    pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost mingw-w64-x86_64-openssl mingw-w64-x86_64-zeromq mingw-w64-x86_64-libsodium mingw-w64-x86_64-hidapi

    ```



    To build for 32-bit Windows:



    ```bash

    pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost mingw-w64-i686-openssl mingw-w64-i686-zeromq mingw-w64-i686-libsodium mingw-w64-i686-hidapi

    ```



* Open the MingW shell via `MinGW-w64-Win64 Shell` shortcut on 64-bit Windows

  or `MinGW-w64-Win64 Shell` shortcut on 32-bit Windows. Note that if you are

  running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.



**Cloning**



* To git clone, run:



    ```bash

    git clone --recursive https://github.com/Judecoin/judecoin.git

    ```



**Building**



* Change to the cloned directory, run:



    ```bash

    cd judecoin

    ```



* If you would like a specific [version/tag](https://github.com/Judecoin/judecoin/tags), do a git checkout for that version. eg. 'v0.17.1.0'. If you don't care about the version and just want binaries from master, skip this step:



    ```bash

    git checkout 

    ```



* If you are on a 64-bit system, run:



    ```bash

    make release-static-win64

    ```



* If you are on a 32-bit system, run:



    ```bash

    make release-static-win32

    ```



* The resulting executables can be found in `build/release/bin`



* **Optional**: to build Windows binaries suitable for debugging on a 64-bit system, run:



    ```bash

    make debug-static-win64

    ```



* **Optional**: to build Windows binaries suitable for debugging on a 32-bit system, run:



    ```bash

    make debug-static-win32

    ```



* The resulting executables can be found in `build/debug/bin`



### On FreeBSD



The project can be built from scratch by following instructions for Linux above(but use `gmake` instead of `make`). 

If you are running Judecoin in a jail, you need to add `sysvsem="new"` to your jail configuration, otherwise lmdb will throw the error message: `Failed to open lmdb environment: Function not implemented`.



Judecoin is also available as a port or package as `judecoin-cli`.



### On OpenBSD



You will need to add a few packages to your system. `pkg_add cmake gmake zeromq libiconv boost`.



The `doxygen` and `graphviz` packages are optional and require the xbase set.

Running the test suite also requires `py-requests` package.



Build Judecoin: `env DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/usr/local gmake release-static`



Note: you may encounter the following error when compiling the latest version of Judecoin as a normal user:



```

LLVM ERROR: out of memory

c++: error: unable to execute command: Abort trap (core dumped)

```



Then you need to increase the data ulimit size to 2GB and try again: `ulimit -d 2000000`



### On NetBSD



Check that the dependencies are present: `pkg_info -c libexecinfo boost-headers boost-libs protobuf readline libusb1 zeromq git-base pkgconf gmake cmake | more`, and install any that are reported missing, using `pkg_add` or from your pkgsrc tree.  Readline is optional but worth having.



Third-party dependencies are usually under `/usr/pkg/`, but if you have a custom setup, adjust the "/usr/pkg" (below) accordingly.



Clone the Judecoin repository recursively and checkout the most recent release as described above. Then build Judecoin: `gmake BOOST_ROOT=/usr/pkg LDFLAGS="-Wl,-R/usr/pkg/lib" release`.  The resulting executables can be found in `build/NetBSD/[Release version]/Release/bin/`.



### On Solaris



The default Solaris linker can't be used, you have to install GNU ld, then run cmake manually with the path to your copy of GNU ld:



```bash

mkdir -p build/release

cd build/release

cmake -DCMAKE_LINKER=/path/to/ld -D CMAKE_BUILD_TYPE=Release ../..

cd ../..

```



Then you can run make as usual.



### On Linux for Android (using docker)



```bash

# Build image (for ARM 32-bit)

docker build -f utils/build_scripts/android32.Dockerfile -t judecoin-android .

# Build image (for ARM 64-bit)

docker build -f utils/build_scripts/android64.Dockerfile -t judecoin-android .

# Create container

docker create -it --name judecoin-android judecoin-android bash

# Get binaries

docker cp judecoin-android:/src/build/release/bin .

```



### Building portable statically linked binaries



By default, in either dynamically or statically linked builds, binaries target the specific host processor on which the build happens and are not portable to other processors. Portable binaries can be built using the following targets:



* ```make release-static-linux-x86_64``` builds binaries on Linux on x86_64 portable across POSIX systems on x86_64 processors

* ```make release-static-linux-i686``` builds binaries on Linux on x86_64 or i686 portable across POSIX systems on i686 processors

* ```make release-static-linux-armv8``` builds binaries on Linux portable across POSIX systems on armv8 processors

* ```make release-static-linux-armv7``` builds binaries on Linux portable across POSIX systems on armv7 processors

* ```make release-static-linux-armv6``` builds binaries on Linux portable across POSIX systems on armv6 processors

* ```make release-static-win64``` builds binaries on 64-bit Windows portable across 64-bit Windows systems

* ```make release-static-win32``` builds binaries on 64-bit or 32-bit Windows portable across 32-bit Windows systems



### Cross Compiling



You can also cross-compile static binaries on Linux for Windows and macOS with the `depends` system.



* ```make depends target=x86_64-linux-gnu``` for 64-bit linux binaries.

* ```make depends target=x86_64-w64-mingw32``` for 64-bit windows binaries.

  * Requires: `python3 g++-mingw-w64-x86-64 wine1.6 bc`

* ```make depends target=x86_64-apple-darwin``` for Intel macOS binaries.

  * Requires: `clang`

* ```make depends target=arm64-apple-darwin``` for Apple Silicon macOS binaries.

  * Requires: `clang`

* ```make depends target=i686-linux-gnu``` for 32-bit linux binaries.

  * Requires: `g++-multilib bc`

* ```make depends target=i686-w64-mingw32``` for 32-bit windows binaries.

  * Requires: `python3 g++-mingw-w64-i686`

* ```make depends target=arm-linux-gnueabihf``` for armv7 binaries.

  * Requires: `g++-arm-linux-gnueabihf`

* ```make depends target=aarch64-linux-gnu``` for armv8 binaries.

  * Requires: `g++-aarch64-linux-gnu`

* ```make depends target=riscv64-linux-gnu``` for RISC V 64 bit binaries.

  * Requires: `g++-riscv64-linux-gnu`

* ```make depends target=x86_64-unknown-freebsd``` for freebsd binaries.

  * Requires: `clang-8`

* ```make depends target=arm-linux-android``` for 32bit android binaries

* ```make depends target=aarch64-linux-android``` for 64bit android binaries



The required packages are the names for each toolchain on apt. Depending on your distro, they may have different names.



Using `depends` might also be easier to compile Judecoin on Windows than using MSYS. Activate Windows Subsystem for Linux (WSL) with a distro (for example Ubuntu), install the apt build-essentials and follow the `depends` steps as depicted above.



The produced binaries still link libc dynamically. If the binary is compiled on a current distribution, it might not run on an older distribution with an older installation of libc. Passing `-DBACKCOMPAT=ON` to cmake will make sure that the binary will run on systems having at least libc version 2.17.



## Installing Judecoin from a package



**DISCLAIMER: These packages are not part of this repository or maintained by this project's contributors, and as such, do not go through the same review process to ensure their trustworthiness and security.**



Packages are available for



* Debian 12 (Bookworm) or later



    ```bash

    sudo apt install judecoin

    ```



* Arch Linux:



* Void Linux:



    ```bash

    xbps-install -S judecoin

    ```

* Guix



    ```bash

    guix package -i judecoin

    ```



* macOS (homebrew)

    ```bash

    brew install judecoin

    ```

* Docker



    ```bash

    # Build using all available cores

    docker build -t judecoin .



    # or build using a specific number of cores (reduce RAM requirement)

    docker build --build-arg NPROC=1 -t judecoin .



    # either run in foreground

    docker run -it -v /judecoin/chain:/root/.bitjudecoin -v /judecoin/wallet:/wallet -p 18080:18080 judecoin



    # or in background

    docker run -it -d -v /judecoin/chain:/root/.bitjudecoin -v /judecoin/wallet:/wallet -p 18080:18080 judecoin

    ```



* The build needs 3 GB space.

* Wait one hour or more



Packaging for your favorite distribution would be a welcome contribution!



## Running judecoind



The build places the binary in `bin/` sub-directory within the build directory

from which cmake was invoked (repository root by default). To run in the

foreground:



```bash

./bin/judecoind

```



To list all available options, run `./bin/judecoind --help`.  Options can be

specified either on the command line or in a configuration file passed by the

`--config-file` argument.  To specify an option in the configuration file, add

a line with the syntax `argumentname=value`, where `argumentname` is the name

of the argument without the leading dashes, for example, `log-level=1`.



To run in background:



```bash

./bin/judecoind --log-file judecoind.log --detach

```



To run as a systemd service, copy

[judecoind.service](utils/systemd/judecoind.service) to `/etc/systemd/system/` and

[judecoind.conf](utils/conf/judecoind.conf) to `/etc/`. The [example

service](utils/systemd/judecoind.service) assumes that the user `judecoin` exists

and its home is the data directory specified in the [example

config](utils/conf/judecoind.conf).



If you're on Mac, you may need to add the `--max-concurrency 1` option to

judecoin-wallet-cli, and possibly judecoind, if you get crashes refreshing.



## Internationalization



See [README.i18n.md](docs/README.i18n.md).



## Using Tor



> There is a new, still experimental, [integration with Tor](docs/ANONYMITY_NETWORKS.md). The

> feature allows connecting over IPv4 and Tor simultaneously - IPv4 is used for

> relaying blocks and relaying transactions received by peers whereas Tor is

> used solely for relaying transactions received over local RPC. This provides

> privacy and better protection against surrounding node (sybil) attacks.



Judecoin can also be used with torsocks by setting the following configuration parameters and environment variables:



* `--p2p-bind-ip 127.0.0.1` on the command line or `p2p-bind-ip=127.0.0.1` in

  judecoind.conf to disable listening for connections on external interfaces.

* `--no-igd` on the command line or `no-igd=1` in judecoind.conf to disable IGD

  (UPnP port forwarding negotiation), which is pointless with Tor.

* `DNS_PUBLIC=tcp` or `DNS_PUBLIC=tcp://x.x.x.x` where x.x.x.x is the IP of the

  desired DNS server, for DNS requests to go over TCP, so that they are routed

  through Tor. When IP is not specified, judecoind uses the default list of

  servers defined in [src/common/dns_utils.cpp](src/common/dns_utils.cpp).

* `TORSOCKS_ALLOW_INBOUND=1` to tell torsocks to allow judecoind to bind to interfaces

   to accept connections from the wallet. On some Linux systems, torsocks

   allows binding to localhost by default, so setting this variable is only

   necessary to allow binding to local LAN/VPN interfaces to allow wallets to

   connect from remote hosts. On other systems, it may be needed for local wallets

   as well.

* Do NOT pass `--detach` when running through torsocks with systemd, (see

  [utils/systemd/judecoind.service](utils/systemd/judecoind.service) for details).

* If you use the wallet with a Tor daemon via the loopback IP (eg, 127.0.0.1:9050),

  then use `--untrusted-daemon` unless it is your own hidden service.



Example command line to start Judecoind through Tor:



```bash

DNS_PUBLIC=tcp torsocks judecoind --p2p-bind-ip 127.0.0.1 --no-igd

```



A helper script is in contrib/tor/judecoin-over-tor.sh. It assumes Tor is installed

already, and runs Tor and Judecoin with the right configuration.



### Using Tor on Tails



TAILS ships with a very restrictive set of firewall rules. Therefore, you need

to add a rule to allow this connection too, in addition to telling torsocks to

allow inbound connections. Full example:



```bash

sudo iptables -I OUTPUT 2 -p tcp -d 127.0.0.1 -m tcp --dport 18081 -j ACCEPT

DNS_PUBLIC=tcp torsocks ./judecoind --p2p-bind-ip 127.0.0.1 --no-igd --rpc-bind-ip 127.0.0.1 \

    --data-dir /home/amnesia/Persistent/your/directory/to/the/blockchain

```



## Pruning



As of May 2020, the full Judecoin blockchain file is about 80 GB. One can store a pruned blockchain, which is about 28 GB.

A pruned blockchain can only serve part of the historical chain data to other peers, but is otherwise identical in

functionality to the full blockchain.

To use a pruned blockchain, it is best to start the initial sync with --prune-blockchain. However, it is also possible

to prune an existing blockchain using the judecoin-blockchain-prune tool or using the --prune-blockchain judecoind option

with an existing chain. If an existing chain exists, pruning will temporarily require disk space to store both the full

and pruned blockchains.



## Debugging



This section contains general instructions for debugging failed installs or problems encountered with Judecoin. First, ensure you are running the latest version built from the GitHub repository.



### Obtaining stack traces and core dumps on Unix systems



We generally use the tool `gdb` (GNU debugger) to provide stack trace functionality, and `ulimit` to provide core dumps in builds which crash or segfault.



* To use `gdb` in order to obtain a stack trace for a build that has stalled:



Run the build.



Once it stalls, enter the following command:



```bash

gdb /path/to/judecoind `pidof judecoind`

```



Type `thread apply all bt` within gdb in order to obtain the stack trace



* If however the core dumps or segfaults:



Enter `ulimit -c unlimited` on the command line to enable unlimited filesizes for core dumps



Enter `echo core | sudo tee /proc/sys/kernel/core_pattern` to stop cores from being hijacked by other tools



Run the build.



When it terminates with an output along the lines of "Segmentation fault (core dumped)", there should be a core dump file in the same directory as judecoind. It may be named just `core`, or `core.xxxx` with numbers appended.



You can now analyse this core dump with `gdb` as follows:



```bash

gdb /path/to/judecoind /path/to/dumpfile

```



Print the stack trace with `bt`



 * If a program crashed and cores are managed by systemd, the following can also get a stack trace for that crash:



```bash

coredumpctl -1 gdb

```



#### To run Judecoin within gdb:



Type `gdb /path/to/judecoind`



Pass command-line options with `--args` followed by the relevant arguments



Type `run` to run judecoind



### Analysing memory corruption



There are two tools available:



#### ASAN



Configure Judecoin with the -D SANITIZE=ON cmake flag, eg:



```bash

cd build/debug && cmake -D SANITIZE=ON -D CMAKE_BUILD_TYPE=Debug ../..

```



You can then run the Judecoin tools normally. Performance will typically halve.



#### valgrind



Install valgrind and run as `valgrind /path/to/judecoind`. It will be very slow.



### LMDB



Instructions for debugging suspected blockchain corruption as per @HYC



There is an `mdb_stat` command in the LMDB source that can print statistics about the database but it's not routinely built. This can be built with the following command:



```bash

cd ~/judecoin/external/db_drivers/liblmdb && make

```



The output of `mdb_stat -ea ` will indicate inconsistencies in the blocks, block_heights and block_info table.



The output of `mdb_dump -s blocks ` and `mdb_dump -s block_info ` is useful for indicating whether blocks and block_info contain the same keys.



These records are dumped as hex data, where the first line is the key and the second line is the data.



## Known Issues



### Protocols



#### Socket-based



Because of the nature of the socket-based protocols that drive Judecoin, certain protocol weaknesses are somewhat unavoidable at this time. While these weaknesses can theoretically be fully mitigated, the effort required (the means) may not justify the ends. As such, please consider taking the following precautions if you are a Judecoin node operator:



- Run `judecoind` on a "secured" machine. If operational security is not your forte, at a very minimum, have a dedicated computer running `judecoind` and **do not** browse the web, use email clients, or use any other potentially harmful apps on your `judecoind` machine. **Do not click links or load URL/MUA content on the same machine**. Doing so may potentially exploit weaknesses in commands which accept "localhost" and "127.0.0.1".

- If you plan on hosting a public "remote" node, start `judecoind` with `--restricted-rpc`. This is a must.



#### Blockchain-based



Certain blockchain "features" can be considered "bugs" if misused correctly. Consequently, please consider the following:



- When receiving Judecoin, be aware that it may be locked for an arbitrary time if the sender elected to, preventing you from spending that Judecoin until the lock time expires. You may want to hold off acting upon such a transaction until the unlock time lapses. To get a sense of that time, you can consider the remaining blocktime until unlock as seen in the `show_transfers` command.