Skip to main content

Source Installation PlatON

This document is intended for users with the ability to compile source code on the PlatON blockchain.

  • PlatON supports source code compilation and installation under Windows and Ubuntu.

Windows source code compilation#

Windows compilation environment requirements :

  • git: 2.19.1 and above
  • Go language development kit: go (1.16+)
  • mingw: mingw (V8.1.0)
  • cmake: 3.0 +

You can install the above compilation environment yourself. Please make sure the above environment can run normally before compiling PlatON source code.

You can also use Chocolatey to install the compilation environment (if you do not already have chocolatey, you can follow the instructions on https://chocolatey.org to install), start PowerShell as an administrator, and then execute the following command:

Install git:

choco install git

Install golang:

choco install golang

Install mingw:

choco install mingw

Install cmake:

choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'

Most softwares installed using the chocolatey package manager have a default installation path, and some software may have various paths, depending on the publisher of the software. Installing these packages will modify the Path environment variable. The final installation path can be viewed in the PATH. Some machine environments may not find the installation path of these tools in the PATH, and you need to add it manually at this time. After installation, please make sure the installed Go version is 1.16 (or higher).

Note: The following commands need to be run in the Git-bash environment. In any directory, right-click and select Git Bash Here to bring up the Git Bash running window.

  • Get the source code

Get the source code and put it in the GOPATH path, where master is the branch name, then switch to the actual branch:

mkdir -p $GOPATH/src/github.com/PlatONnetworkcd $GOPATH/src/github.com/PlatONnetworkgit clone -b master https://github.com/PlatONnetwork/PlatON-Go.git --recursive
  • Add bls dependent library to environment variables
echo 'export PATH=$PATH:"$GOPATH/src/github.com/PlatONnetwork/PlatON-Go/crypto/bls/bls_win/lib"' >> ~/.bashrcsource ~/.bashrc
  • Compile
cd $GOPATH/src/github.com/PlatONnetwork/PlatON-Gogo run build/ci.go install ./cmd/platongo run build/ci.go install ./cmd/platonkey

After compiling, platon, platonkey executable files will be generated in the PlatON-Go/build/bin directory. Copy these executable files to your working directory and run.

Repeated compilation will overwrite the previously generated executable file.

Note: It is recommended that the windows version be used for development testing only, and that the ubuntu version be used for the official production environment.

Ubuntu source code compilation#

step1. Ubuntu compilation environment requirements:

  • System version: Ubuntu 18.04 or higher
  • git: 2.19.1 or higher
  • Compilers: gcc (4.9.2+), g ++ (5.0+)
  • Go language development kit: go (1.16+)
  • cmake: 3.0 +

step2. Get the PlatON source:

git clone -b master https://github.com/PlatONnetwork/PlatON-Go.git --recursive

step3. Install dependency library:

install golang

cd /usr/localsudo wget https://go.dev/dl/go1.18.7.linux-amd64.tar.gzsudo rm -rf /usr/local/go && tar -C /usr/local -xzf go1.18.7.linux-amd64.tar.gzsudo vim /etc/profile// Add a line at the endexport PATH=$PATH:/usr/local/go/binsource /etc/profile
sudo apt update sudo apt install -y cmake llvm g++ libgmp-dev libssl-dev

step4. compilation：

cd PlatON-Go make all

After compiling, a series of executable files such as platon, platonkey and so on will be generated in the ./build/bin directory.

step5. Copy binary:

sudo cp -f ./build/bin/platon /usr/bin/ sudo cp -f ./build/bin/platonkey /usr/bin/

To this step, congratulations, the source code compilation completed!