Bitprim Server
License Overview
All files in this repository fall under the license specified in COPYING. The project is licensed as AGPL with a lesser clause. It may be used within a proprietary project, but the core library and any changes to it must be published online. Source code for this library must always remain free for everybody to access.
About Bitprim
The Bitprim toolkit is a set of cross platform C++ libraries for building bitcoin applications. The toolkit consists of several libraries, most of which depend on the foundational bitprim-core library. Each library's repository can be cloned and built using common automake 1.14+ instructions.
A minimal bitprim build requires boost and libsecp256k1. The bitprim/secp256k1 repository is forked from bitcoin-core/secp256k1 in order to control for changes and to incorporate the necessary Visual Studio build. The original repository can be used directly but recent changes to the public interface may cause build breaks. The --enable-module-recovery switch is required.
Detailed instructions are provided below.
Bitprim requires a C++11 compiler, currently minimum GCC 4.8.0 or Clang based on LLVM 3.5.
To see your GCC version:
$ g++ --versiong++ (Ubuntu 4.8.2-19ubuntu1) 4.8.2
Copyright (C) 2013 Free Software Foundation, Inc.
This is free software; see the source for copying conditions. There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
If necessary, upgrade your compiler as follows:
$ sudo apt-get install g++-4.8
$ sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-4.8 50
$ sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-4.8 50
$ sudo update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-4.8 50Next install the build system (Automake minimum 1.14) and git:
$ sudo apt-get install build-essential autoconf automake libtool pkg-config git Next install the Boost (minimum 1.56.0) development package:
$ sudo apt-get install libboost-all-devIf you intend to use libbbitcoin-consensus (this is the default), you will also need libcrypto:
$ sudo apt-get install libssl-devNext install the ZeroMQ (minimum 4.2.0) development package:
$ git clone https://github.com/zeromq/libzmq
$ cd libzmq
$ ./autogen.sh && ./configure && make -j 4
$ make check
$ sudo make install
$ sudo ldconfigNext install the Protobuff (minimum 3.0.0) development package:
$ sudo apt-get install autoconf automake libtool curl make g++ unzip
$ git clone https://github.com/google/protobuf
$ cd protobuf
$ ./autogen.sh
$ ./configure
$ make
$ make check
$ sudo make install
$ sudo ldconfigNext install the CMake (minimum 3.7.0-rc1) development package:
$ wget https://cmake.org/files/v3.7/cmake-3.7.0-rc1.tar.gz
$ tar -xvzf cmake-3.7.0-rc1.tar.gz
$ cd cmake-3.7.0-rc1
$ ./bootstrap
$ make
$ sudo make install
$ sudo ln -s /usr/local/bin/cmake /usr/bin/cmakeFinally, install bitprim-build:
$ git clone --recursive https://github.com/bitprim/bitprim-build/
$ cd bitprim-build
$ mkdir build
$ cd build
$ cmake .. -G "Unix Makefiles" -DENABLE_TESTS=OFF -DWITH_TESTS=OFF -DWITH_TOOLS=OFF -DCMAKE_BUILD_TYPE=Release
$ make
$ sudo make install
$ sudo ldconfigBitprim is now installed in /usr/local/.
The OSX installation differs from Linux in the installation of the compiler and packaged dependencies. Bitprim supports both Homebrew and MacPorts package managers. Both require Apple's Xcode command line tools. Neither requires Xcode as the tools may be installed independently.
Bitprim compiles with Clang on OSX and requires C++11 support. Installation has been verified using Clang based on LLVM 3.5. This version or newer should be installed as part of the Xcode command line tools.
To see your Clang/LLVM version:
$ clang++ --versionApple LLVM version 6.0 (clang-600.0.54) (based on LLVM 3.5svn)
Target: x86_64-apple-darwin14.0.0
Thread model: posix
If required update your version of the command line tools as follows:
$ xcode-select --installFirst install Homebrew. Installation requires Ruby and cURL, which are pre-installed on OSX.
$ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"You may encounter a prompt to install the Xcode command line developer tools, in which case accept the prompt.
Next install the build system (Automake minimum 1.14) and wget:
$ brew install autoconf automake libtool pkgconfig wgetNext install the Boost (1.56.0 or newer) development package:
$ brew install boostNext install the ZeroMQ (minimum 4.2.0) development package:
TODO: ZeroMQ Mac Install
Next install the Protobuff (minimum 3.0.0) development package:
TODO: Protobuff Mac Install
Finally install bitprim:
TODO: Mac Install
Bitprim is now installed in /usr/local/.
First install MacPorts.
Next install the build system (Automake minimum 1.14) and wget:
$ sudo port install autoconf automake libtool pkgconfig wgetNext install the Boost (1.56.0 or newer) development package. The - options remove MacPort defaults that are not Boost defaults:
$ sudo port install boost -no_single -no_static -python27Next install the ZeroMQ (minimum 4.2.0) development package:
TODO: ZeroMQ MacPorts Install
Next install the Protobuff (minimum 3.0.0) development package:
TODO: Protobuff MacPorts Install
Finally install bitprim:
TODO: MacPorts Install
Bitprim is now installed in /usr/local/.
The install script itself is commented so that the manual build steps for each dependency can be inferred by a developer.
You can run the install script from any directory on your system. By default this will build bitprim in a subdirectory named build-bitprim and install it to /usr/local/. The install script requires sudo only if you do not have access to the installation location, which you can change using the --prefix option on the installer command line.
The build script clones, builds and installs two unpackaged repositories, namely:
The script builds from the head of their version4 and version2 branches respectively. The master branch is a staging area for changes. The version branches are considered release quality.
TODO:Windows Install