Skip to content

crystaleum/crystaleum

Repository files navigation

Crystaleum a multi-chain of interoperable blockchain protocols

For educational purposes, please do your own research before attempting any actions in cryptocurrency. This is not considered permission to reproduce, redistribute or for that matter, install the software contained in this repository. All information provided herein, or on our community development group chats is done so in a best-effort, and may not be kept up to date due to our short handed staff. If you would like to donate to our cause, kindly find the donation addresses below.

Copyright (c) 2014-2018 The Monero Project. Portions Copyright (c) 2012-2013 The Cryptonote developers. Portions Copyright (c) 2017-2018 The Electroneum developers. Portions Copyright (c) ~2018 The Masari developers. Portions Copyright (c) ~2018 The Sumokoin developers. Portions Copyright (c) ~2018 The Stellite developers. Portions Copyright (c) 2014-2018 The Electronero Project. Portions Copyright (c) 2014-2018 The Electronero Pulse Project. Portions Copyright (c) 2014-2018 The Litenero Project. Portions Copyright (c) 2014-2018 The Goldnero Project. Portions Copyright (c) 2014-2018 The Crystaleum Project.

EI-1.0 Electronero legacy Cryptonote coins

CRFI is the native coin of Crystaleum privacy-centric chain, with the parent blockchain raw imported from Electroneum ETN, and the source code forked from Goldnero GLDX with adaptations from Monero XMR, and inspiration from various other cryptonote coins. CRFI privacy chain (part of EI-1.0 "electronero 1.0") remains in parallell to CRYSTAL aka 💎 public ledger (part of EI-2.0 "electronero 2.0")

EI-2.0 Crystaleum CRFI | (wrapped) CRYSTAL & wCRFI | Alt-Eth POA chain (bridged) aka

Crystaleum EVM "ethereum virtual machine" compatibility brings the native Crystaleum CRYSTAL aka 💎 to the Crystaleum ecosystem. Additionally xAssets & XRC-20 tokens are minted for token swaps & airdrops on public ledgers including Ethereum, Binance Smart Chain, Polygon, on Crystaleum native EVM CRYSTAL / 💎 and / or on the future Electronero Smart Chain.

To reveal Crystaleum "evm" 💎 git submodule init && git submodule update To install 💎 "evm" cd evm && go install ./...


EI-2.0 began deployments to public ledgers with various xAssets "Experimental Assets" to ethereum virtual machine compatible main nets on 09/09/2021. EI-1.0 holders will be airdropped xAssets or have exclusive access to Sidechained AIO bridge to swap to and from EI-1.0 && EI-2.0 digital assets at variable rates. The main methods to bridge digital assets between EI-1.0 and EI-2.0 introduced with Sidechained AIO bridge would be decentralized through Webnero including cross-chain atomic swaps, P2P, and more details are to be announced.
More intel released on the website and through social media.
Crystaleum Community Core contributors are mainly active on Telegram join the community

Table of Contents

Development resources

electronero ETNX - Web: electronero.org electronero pulse ETNXP - Web: electroneropulse.org litenero LTNX - Web: litenero.org goldnero GLDX - Web: goldnero.org crystaleum CRFI - Web: crystaleum.org electronero unnoffical - Chat: t.me/electronero electronero network - Chat: t.me/electronero_network electronero pulse - Chat: t.me/etnxp litenero - Chat: t.me/litenero goldnero - Chat: t.me/goldnero crystaleum - Chat: t.me/crystaleum electronero core - Mail: support@electronero.org electronero network - GitHub: github.com/electronero/electronero

Vulnerability response

Announcements

You can subscribe to crystaleum announcements electronero announcements to get critical announcements from Electronero core. The announcement list can be very helpful for knowing when software updates are needed, etc.

Introduction

Crystaleum is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.

Privacy: Crystaleum uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private 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 a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.

Educational: Crystaleum provides an educational resource to the communtity of cryptocurrency developers, helping others is our passion. If you would like to learn how to develop cryptocurrency with us, join Crystaleum community development group on telegram! https://t.me/crystaleum

Smart Contracts: Crystaleum core merged Ethereum code base from go-ethereum into "evm" the module in this repository may be activated by git submodule init && git submodule update followed by installation of core Ethereum Virtual Machine components along with the core GETH, which is a command line utility to access the CRYSTAL protocols.

Untraceability: By taking advantage of ring signatures, a special property of a certain type of cryptography, Crystaleum is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.

Supporting the project

Crystaleum is a 100% community driven endeavor. To join community efforts, the easiest thing you can do is support the project financially. Crystaleum donations can be made to the Crystaleum donation address via the donate command (type help in the command-line wallet for details). Else, here are our dev teams addresses. The funding goes to many developers, and volunteers who contribute, they are grateful for our donations!

The Monero donation address is: 85PTaJNpkEEeJao2MNk1sRWTQXLUf1FGjZew8oR8R4cRUrXxFrTexa9GwrjmJD4Pyx6UrjgMQnuMoFNmaBKqxs7PPXVe9oX

The Bitcoin donation address is: 38jiBKevQHp8zhQpZ42bTvK4QpzzqWkA3K

The Ethereum donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The Tether USD donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The ZCash donation address is: t1Kmnv9eDqw7VyDWmzSUbjBPrxoY7hMuUCc

The Liquid donation address is: VJL9H2mk4tKBRgSkTNkSrFGQABiNxUs1UPbm4rHCsE8vF87kSJgSo8AQfGDt54nC59tEtb2W47GsMrw2

The Crystaleum donation address is: etnkHfFuanNeTe3q9dux4d9cRiLkUR4hDffvhfTp6nbhEJ5R8TY4vdyZjT4BtWxnvSJ5nfD64eCAQfKMJHSym2dj8PQqeiKmBM

The Electroneum donation address is: etnkHfFuanNeTe3q9dux4d9cRiLkUR4hDffvhfTp6nbhEJ5R8TY4vdyZjT4BtWxnvSJ5nfD64eCAQfKMJHSym2dj8PQqeiKmBM

The Dogecoin donation address is: DTTez7ggKPzDcKuUUTns8VzMrKesZUKMCk

The Litecoin donation address is: MAtV7sbBnmuf2bxVUPgCprpmJ5xX6euBwe

The Sumokoin donation address is: Sumoo47CGenbHfZtpCVV4PRMSsXP38idFdt5JSj7VuJrD1nABoPHTBHgR6owQJfn1JU8BiWWohw4oiefGEjAn4GmbFYYtCcfPeT

The Aave donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The Attention Token donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The Cardano ADA donation address is: DdzFFzCqrhspgQJTD1r81KsmXjzySdu4Zb4pJf7iLxkcVKvoRLoVHss9f2147QTRCRkQAFjWwHdr77Snn3efEo9ne4YzM5UCwwnMGR15

The Compound donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The Dash donation address is: XcFVDo2k3XRJwQKQQRgMBfhCEDFANawQ3B

The Maker donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The Paxos Standard donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The REN donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The TrueUSD donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

The USDCoin donation address is: 0x59d26980a1cdd75e1c3af516b912a6233aa2f5e4

About this project

This is a modified core implementation of Monero/Electroneum. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of Monero that uses the protocol and network in a compatible manner.

As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.

Anyone is welcome to contribute to Crystaleum's codebase! If you have a fix or code change, feel free to submit it as a pull request directly to the "master" branch. In cases where the change is relatively small or does not affect other parts of the codebase it may be merged in immediately by any one of the collaborators. On the other hand, if the change is particularly large or complex, it is expected that it will be discussed at length either well in advance of the pull request being submitted, or even directly on the pull request.

License

See LICENSE.

Contributing

If you want to help out, join Crystaleum Network Core Contributors. Contact us on Telegram.
See CONTRIBUTING for a set of guidelines.

Scheduled software upgrades

Crystaleum utilizes a software upgrade (hard fork) mechanism to implement new features. This means that users of Crystaleum (end users and service providers) should run current versions and upgrade their software on a regular basis. 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 Crystaleum software version.

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 Crystaleum 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 Fedora Optional Purpose
GCC 4.7.3 NO build-essential base-devel gcc NO
CMake 3.0.0 NO cmake cmake cmake NO
pkg-config any NO pkg-config base-devel pkgconf NO
Boost 1.58 NO libboost-all-dev boost boost-devel NO C++ libraries
OpenSSL basically any NO libssl-dev openssl openssl-devel NO sha256 sum
libzmq 3.0.0 NO libzmq3-dev zeromq cppzmq-devel NO ZeroMQ library
libunbound 1.4.16 YES libunbound-dev unbound unbound-devel NO DNS resolver
libsodium ? NO libsodium-dev ? libsodium-devel NO libsodium
libminiupnpc 2.0 YES libminiupnpc-dev miniupnpc miniupnpc-devel YES NAT punching
libunwind any NO libunwind8-dev libunwind libunwind-devel YES Stack traces
liblzma any NO liblzma-dev xz xz-devel YES For libunwind
libreadline 6.3.0 NO libreadline6-dev readline readline-devel YES Input editing
ldns 1.6.17 NO libldns-dev ldns ldns-devel YES SSL toolkit
expat 1.1 NO libexpat1-dev expat expat-devel YES XML parsing
GTest 1.5 YES libgtest-dev^ gtest gtest-devel YES Test suite
Doxygen any NO doxygen doxygen doxygen YES Documentation
Graphviz any NO graphviz graphviz graphviz YES Documentation

[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 Then:

  • on Debian: sudo mv libg* /usr/lib/
  • on Ubuntu: sudo mv lib/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 libssl-dev libzmq3-dev libunbound-dev libsodium-dev libunwind8-dev liblzma-dev libreadline6-dev libldns-dev libexpat1-dev libpgm-dev qttools5-dev-tools libhidapi-dev libusb-1.0-0-dev libprotobuf-dev protobuf-compiler libudev-dev libboost-chrono-dev libboost-date-time-dev libboost-filesystem-dev libboost-locale-dev libboost-program-options-dev libboost-regex-dev libboost-serialization-dev libboost-system-dev libboost-thread-dev ccache doxygen graphviz

Install all dependencies at once on openSUSE:

sudo zypper ref && sudo zypper in cppzmq-devel ldns-devel libboost_chrono-devel libboost_date_time-devel libboost_filesystem-devel libboost_locale-devel libboost_program_options-devel libboost_regex-devel libboost_serialization-devel libboost_system-devel libboost_thread-devel libexpat-devel libminiupnpc-devel libsodium-devel libunwind-devel unbound-devel cmake doxygen ccache fdupes gcc-c++ libevent-devel libopenssl-devel pkgconf-pkg-config readline-devel xz-devel libqt5-qttools-devel patterns-devel-C-C++-devel_C_C++

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/crystaleum/crystaleum

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

$ cd Crystaleum && git submodule init && git submodule update && cd coins/Crystaleum && git submodule init && git submodule update && make -j2 && cd ../electroneropulse && git submodule init && git submodule update && make -j2 && cd ../litenero && git submodule init && git submodule update && make -j2 && cd ../goldnero && git submodule init && git submodule update && make -j2 && cd ../crystaleum && git submodule init && git submodule update && make -j2

Note: If there are submodule differences between branches, you may need to use git submodule sync && git submodule update after changing branches to build successfully.

Build instructions

Crystaleum uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.

On Linux and OS X

  • Install the dependencies

  • Change to the root of the source code directory and build:

      `$ cd Crystaleum && git submodule init && git submodule update && cd coins/Crystaleum && git submodule init && git submodule update && make -j2 && cd ../electroneropulse && git submodule init && git submodule update && make -j2 && cd ../litenero && git submodule init && git submodule update && make -j2 && cd ../goldnero && git submodule init && git submodule update && make -j2 && cd ../crystaleum && git submodule init && git submodule update && make -j2`
    

    Optional: If your machine has several cores and enough memory, enable parallel build by running make -j<number of threads> instead of make. For this to be worthwhile, the machine should have one core and about 2GB of RAM available per thread.

    Note: If cmake can not find zmq.hpp file on OS X, installing zmq.hpp from https://github.com/zeromq/cppzmq to /usr/local/include should fix that error.

  • The resulting Crystaleum Network executables can be found in build/release/bin for each Crystaleum Network coin in coins/ dir

  • Add PATH="$PATH:$HOME/crystaleum/build/release/bin" to .profile

  • Add PATH="$PATH:$HOME/electroneropulse/build/release/bin" to .profile

  • Add PATH="$PATH:$HOME/litenero/build/release/bin" to .profile

  • Add PATH="$PATH:$HOME/goldnero/build/release/bin" to .profile

  • Add PATH="$PATH:$HOME/crystaleum/build/release/bin" to .profile

  • Run Electronero electronerod

  • Run Electronero Pulse pulsed

  • Run Litenero litenerod

  • Run Goldnero goldnerod

  • Run Crystaleum crystaleumd

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

      make release-test
    

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

  • Optional: to build binaries suitable for debugging:

       make debug
    
  • Optional: to build statically-linked binaries:

       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):

      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) from https://www.raspberrypi.org/downloads/raspbian/. If you are using Raspian Jessie, please see note in the following section.

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

  • Install the dependencies for Crystaleum from the 'Debian' column in the table above.

  • Increase the system swap size:

	sudo /etc/init.d/dphys-swapfile stop  
	sudo nano /etc/dphys-swapfile  
	CONF_SWAPSIZE=1024  
	sudo /etc/init.d/dphys-swapfile start  
  • Clone Crystaleum and checkout most recent release version:
        git clone https://github.com/crystaleum/crystaleum.git
  • Build: $ cd electronero && git submodule init && git submodule update && cd coins/electronero && git submodule init && git submodule update && make -j2 && cd ../electroneropulse && git submodule init && git submodule update && make -j2 && cd ../litenero && git submodule init && git submodule update && make -j2 && cd ../goldnero && git submodule init && git submodule update && make -j2

  • Add PATH="$PATH:$HOME/crystaleum/build/release/bin" to .profile

  • 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 Crystaleum is a bit more complicated. The version of Boost available in the Debian Jessie repositories is too old to use with Crystaleum, 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
	sudo /etc/init.d/dphys-swapfile stop  
	sudo nano /etc/dphys-swapfile  
	CONF_SWAPSIZE=1024  
	sudo /etc/init.d/dphys-swapfile start  
  • Then, install the dependencies for Crystaleum except libunwind and libboost-all-dev

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

	cd  
	wget https://sourceforge.net/projects/boost/files/boost/1.64.0/boost_1_64_0.tar.bz2  
	tar xvfo boost_1_64_0.tar.bz2  
	cd boost_1_64_0  
	./bootstrap.sh  
	sudo ./b2  
	sudo ./bjam install

On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. 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, 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:

      pacman -Syuu  
    
  • 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:

      pacman -Syuu  
    
  • Install dependencies:

    To build for 64-bit Windows:

      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
    

    To build for 32-bit Windows:

      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
    
  • 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.

Building

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

      make release-static-win64
    
  • If you are on a 32-bit system, run:

      make release-static-win32
    
  • The resulting executables can be found in build/release/bin

On OpenBSD:

OpenBSD < 6.2

This has been tested on OpenBSD 5.8.

You will need to add a few packages to your system. pkg_add db cmake gcc gcc-libs g++ miniupnpc gtest.

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

The Boost package has a bug that will prevent librpc.a from building correctly. In order to fix this, you will have to Build boost yourself from scratch. Follow the directions here (under "Building Boost"): https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md

You will have to add the serialization, date_time, and regex modules to Boost when building as they are needed by Crystaleum.

To build: env CC=egcc CXX=eg++ CPP=ecpp DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/path/to/the/boost/you/built make release-static-64

OpenBSD >= 6.2

You will need to add a few packages to your system. pkg_add cmake miniupnpc zeromq libiconv.

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

Build the Boost library using clang. This guide is derived from: https://github.com/bitcoin/bitcoin/blob/master/doc/build-openbsd.md

We assume you are compiling with a non-root user and you have doas enabled.

Note: do not use the boost package provided by OpenBSD, as we are installing boost to /usr/local.

# Create boost building directory
mkdir ~/boost
cd ~/boost

# Fetch boost source
ftp -o boost_1_64_0.tar.bz2 https://netcologne.dl.sourceforge.net/project/boost/boost/1.64.0/boost_1_64_0.tar.bz2

# MUST output: (SHA256) boost_1_64_0.tar.bz2: OK
echo "7bcc5caace97baa948931d712ea5f37038dbb1c5d89b43ad4def4ed7cb683332 boost_1_64_0.tar.bz2" | sha256 -c
tar xfj boost_1_64_0.tar.bz2

# Fetch and apply boost patches, required for OpenBSD
ftp -o boost_test_impl_execution_monitor_ipp.patch https://raw.githubusercontent.com/openbsd/ports/bee9e6df517077a7269ff0dfd57995f5c6a10379/devel/boost/patches/patch-boost_test_impl_execution_monitor_ipp
ftp -o boost_config_platform_bsd_hpp.patch https://raw.githubusercontent.com/openbsd/ports/90658284fb786f5a60dd9d6e8d14500c167bdaa0/devel/boost/patches/patch-boost_config_platform_bsd_hpp

# MUST output: (SHA256) boost_config_platform_bsd_hpp.patch: OK
echo "1f5e59d1154f16ee1e0cc169395f30d5e7d22a5bd9f86358f738b0ccaea5e51d boost_config_platform_bsd_hpp.patch" | sha256 -c
# MUST output: (SHA256) boost_test_impl_execution_monitor_ipp.patch: OK
echo "30cec182a1437d40c3e0bd9a866ab5ddc1400a56185b7e671bb3782634ed0206 boost_test_impl_execution_monitor_ipp.patch" | sha256 -c

cd boost_1_64_0
patch -p0 < ../boost_test_impl_execution_monitor_ipp.patch
patch -p0 < ../boost_config_platform_bsd_hpp.patch

# Start building boost
echo 'using clang : : c++ : <cxxflags>"-fvisibility=hidden -fPIC" <linkflags>"" <archiver>"ar" <striper>"strip"  <ranlib>"ranlib" <rc>"" : ;' > user-config.jam
./bootstrap.sh --without-icu --with-libraries=chrono,filesystem,program_options,system,thread,test,date_time,regex,serialization,locale --with-toolset=clang
./b2 toolset=clang cxxflags="-stdlib=libc++" linkflags="-stdlib=libc++" -sICONV_PATH=/usr/local
doas ./b2 -d0 runtime-link=shared threadapi=pthread threading=multi link=static variant=release --layout=tagged --build-type=complete --user-config=user-config.jam -sNO_BZIP2=1 -sICONV_PATH=/usr/local --prefix=/usr/local install

Build cppzmq

Build the cppzmq bindings.

We assume you are compiling with a non-root user and you have doas enabled.

# Create cppzmq building directory
mkdir ~/cppzmq
cd ~/cppzmq

# Fetch cppzmq source
ftp -o cppzmq-4.2.3.tar.gz https://github.com/zeromq/cppzmq/archive/v4.2.3.tar.gz

# MUST output: (SHA256) cppzmq-4.2.3.tar.gz: OK
echo "3e6b57bf49115f4ae893b1ff7848ead7267013087dc7be1ab27636a97144d373 cppzmq-4.2.3.tar.gz" | sha256 -c
tar xfz cppzmq-4.2.3.tar.gz

# Start building cppzmq
cd cppzmq-4.2.3
mkdir build
cd build
cmake ..
doas make install

Build Crystaleum: env DEVELOPER_LOCAL_TOOLS=1 BOOST_ROOT=/usr/local make release-static

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:

    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):

    # Build image (select android64.Dockerfile for aarch64)
    cd utils/build_scripts/ && docker build -f android32.Dockerfile -t crystaleum-android .
    # Create container
    docker create -it --name crystaleum-android crystaleum-android bash
    # Get binaries
    docker cp crystaleum-android:/opt/android/crystaleum/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

Running crystaleumd

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 foreground:

./bin/crystaleumd

To list all available options, run ./bin/crystaleumd --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:

./bin/crystaleumd --log-file crystaleumd.log

To run as a systemd service, copy crystaleumd.service to /etc/systemd/system/ and crystaleumd.conf to /etc/. The example service assumes that the user crystaleumd exists in and its home is the data directory specified in the example config.

If you're on Mac, you may need to add the --max-concurrency 1 option to crystaleum-wallet-cli, and possibly crystaleumd, if you get crashes refreshing.