Skip to content

Commit

Permalink
Separate timelord, add Windows/CentOS/AMZN (#62)
Browse files Browse the repository at this point in the history 
1.1.1 release

* windows build instructions

* install.sh newline fix

\n wasn't as cross platform as it should be so reverted to an extra echo

* Add CentOS to README.md

Full CentOS 7.7 install instructions

* mention blspy

* confirmed boost 1.67.0 works on Ubuntu

* Update README.md.

* Fix problem with zip download.

* Remove scm warning

Revert install instructions due to scm fix

* Update README and install scripts to separate timelord installation

Do not install VDF server and its dependencies in install.sh, create a
separate script install_timelord.sh for that.

* Move installation of VDF server dependencies to install_timelord.sh

* First and broken attempt at CentOS install

* Working CentOS 7.7 install

* typos in timelord explanation

* Timlord/VDF build instructions

Specifics for CentOS and MacOS

* Various install tips and tricks

* spelling error

* Add AMZN linux 2 install

* Add AMZN linux 2 timelord install

Also clean up base install instructions

* Combine TL for AMZN and CentOS

* Nits for AMZN and CentOS

* CentOS, AMZN timelord paralleling

* Fix header layouts

* Replace VDF server compilation scripts with Makefile

* layout improvements

* fast_vdf: Remove unused files

* Partial ARM install support

* missing l in lib

* Fleshed out Windows/WSL installs

And verified the method for upgrade to 19.x

* Move MacOS install fullnode to bottom

* Change to mongo "system-wide"

* Add mongo start to WSL

* Add actual upgrade for WSL/Ubuntu

Co-authored-by: Mariano Sorgente <[email protected]>
Co-authored-by: Rostislav Skudnov <[email protected]>
Co-authored-by: Richard Kiss <[email protected]>
Co-authored-by: wjblanke <[email protected]>
  • Loading branch information
@hoffmang9 @mariano54
@rostislav @richardkiss @wjblanke
5 people committed Dec 25, 2019
1 parent 5492bbf commit d9bf22c
Show file tree
Hide file tree
Showing 12 changed files with 273 additions and 135 deletions.
227 changes: 205 additions & 22 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,51 +3,224 @@ Python 3.7 is used for this project. Make sure your default python version is >=

You will need to enable [UPnP](https://www.homenethowto.com/ports-and-nat/upnp-automatic-port-forward/) on your router or add a NAT (for IPv4 but not IPv6) and firewall rule to allow TCP port 8444 access to your peer. These methods tend to be router make/model specific.

### Install on Debian/Ubuntu
For alpha testnet most should only install harvesters, farmers, plotter and full nodes. Building timelords and VDFs is for sophisticated users in most environments. Chia Network and additional volunteers are running sufficient time lords for testnet consensus.

## Install harvester, farmer, plotter, and full node

### Debian/Ubuntu

```bash
sudo apt-get update
sudo apt-get install build-essential cmake python3-dev python3-venv --no-install-recommends
sudo apt-get install build-essential cmake python3-dev python3-venv libssl-dev libffi-dev --no-install-recommends

git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sh install.sh

# Install MongoDB Community Edition
# Instructions - https://docs.mongodb.com/manual/administration/install-on-linux/

# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```
### Amazon Linux 2

```bash
sudo yum update
sudo yum install gcc-c++ cmake3 wget git openssl openssl-devel
sudo yum install python3 python3-devel libffi-devel

# CMake - add a symlink for cmake3 - required by blspy
sudo ln -s /usr/bin/cmake3 /usr/local/bin/cmake

git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sh install.sh

# Install MongoDB Community Edition
# Instructions - https://docs.mongodb.com/manual/administration/install-on-linux/

# Update boost version to 1.71.0 or greater if needed, check version: dpkg -s libboost-dev | grep 'Version'
# Install from www.boost.org
# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```
### CentOS 7

```bash
sudo yum update
sudo yum install centos-release-scl-rh epel-release
sudo yum install devtoolset-8-toolchain cmake3 libffi-devel
sudo yum install wget git openssl openssl-devel

# CMake - add a symlink for cmake3 - required by blspy
sudo ln -s /usr/bin/cmake3 /usr/local/bin/cmake

scl enable devtoolset-8 bash

# Install Python 3.7.5 (current rpm's are 3.6.x)
wget https://www.python.org/ftp/python/3.7.5/Python-3.7.5.tgz
tar -zxvf Python-3.7.5.tgz; cd Python-3.7.5
./configure --enable-optimizations; sudo make install; cd ..

git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sh install.sh

# Install MongoDB Community Edition
# Instructions - https://docs.mongodb.com/manual/administration/install-on-linux/

# Run mongo database
# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```

### Windows (WSL + Ubuntu)
#### Install WSL + Ubuntu 18.04 LTS, upgrade to Ubuntu 19.x

This will require multiple reboots. From an Administrator PowerShell
`Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux`
and then
`Enable-WindowsOptionalFeature -Online -FeatureName VirtualMachinePlatform`.
Once that is complete, install Ubuntu 18.04 LTS from the Windows Store.
```bash
# Upgrade to 19.x
sudo nano /etc/update-manager/release-upgrades
# Change "Prompt=lts" to "Prompt=normal" save and exit

sudo apt-get -y update
sudo apt-get -y upgrade
sudo do-release-upgrade

sudo apt-get install -y build-essential cmake python3-dev python3-venv mongodb software-properties-common --no-install-recommends

git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sudo sh install.sh

# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```
### Install on MacOS

#### Alternate method for Ubuntu 18.04 LTS
In `./install.sh`:
Change `python3` to `python3.7`
Each line that starts with `pip ...` becomes `python -m pip ...`

```bash
sudo apt-get -y update
sudo apt-get install -y build-essential cmake python3-dev python3-venv mongodb software-properties-common --no-install-recommends

# Install python3.7 with ppa
sudo add-apt-repository -y ppa:deadsnakes/ppa
sudo apt-get -y update
sudo apt-get install -y python3.7 python3.7-venv python3.7-dev

git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sudo sh install.sh

# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```

### MacOS
Make sure [brew](https://brew.sh/) is available before starting the setup.
```bash
brew tap mongodb/brew
brew upgrade python
brew install cmake boost gmp mpir mpfr [email protected]

git clone https://github.com/Chia-Network/chia-blockchain.git && cd chia-blockchain
brew install cmake [email protected]

git clone https://github.com/wbhart/flint2
git clone https://github.com/Chia-Network/chia-blockchain.git
cd chia-blockchain

sh install.sh

# Run mongo database
# Run mongo database if not running system-wide
mongod --fork --dbpath ./db/ --logpath mongod.log

. .venv/bin/activate
```

### Generate keys

## Install timelord
Note: this step is needed only if you intend to run a timelord or a local simulation.
These assume you've already successfully installed harvester, farmer, plotting, and full node above.
### Ubuntu/Debian
```bash
cd chia-blockchain

sh install_timelord.sh
```
### Amazon Linux 2 and CentOS 7
```bash
#Only for Amazon Linux 2
sudo amazon-linux-extras install epel

sudo yum install gmp-devel mpfr-devel

# Install Boost 1.72.0
wget https://dl.bintray.com/boostorg/release/1.72.0/source/boost_1_72_0.tar.gz
tar -zxvf boost_1_72_0.tar.gz
cd boost_1_72_0
./bootstrap.sh --prefix=/usr/local
sudo ./b2 install --prefix=/usr/local --with=all; cd ..

# Install Flint2
git clone https://github.com/wbhart/flint2
cd flint2; ./configure; sudo make install; cd ..
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib

cd chia-blockchain

sh install_timelord.sh
```

### Windows (WSL + Ubuntu)
#### Install WSL + Ubuntu upgraded to 19.x
```bash
cd chia-blockchain

sh install_timelord.sh
```
#### Alternate method for Ubuntu 18.04
```bash
# Install boost 1.70 with ppa
sudo add-apt-repository -y ppa:mhier/libboost-latest
sudo apt-get update
sudo apt-get install libboost1.70 libboost1.70-dev
```

### MacOS
```bash
brew install boost gmp mpir mpfr

cd chia-blockchain

git clone https://github.com/wbhart/flint2

sh install_timelord.sh
```

## Generate keys
First, create some keys by running the following script:
```bash
python -m scripts.regenerate_keys
```

### Run a full node
## Run a full node
To run a full node on port 8002, and connect to the testnet, run the following command.
This wil also start an ssh server in port 8222 for the UI, which you can connect to
to see the state of the node.
Expand All @@ -56,7 +229,7 @@ python -m src.server.start_full_node "127.0.0.1" 8444 -id 1 -u 8222 &
ssh -p 8222 localhost
```

### Run a farmer + full node
## Run a farmer + full node
Farmers are entities in the network who use their hard drive space to try to create
blocks (like Bitcoin's miners), and earn block rewards. First, you must generate some hard drive plots, which
can take a long time depending on the size of the plots (the k variable). Then, run the farmer + full node with
Expand All @@ -66,24 +239,34 @@ python -m scripts.create_plots -k 20 -n 10
sh ./scripts/run_farming.sh
```

### Run a timelord + full node
## Run a timelord + full node
Timelords execute sequential verifiable delay functions (proofs of time), that get added to
blocks to make them valid. This requires fast CPUs and a lot of memory.
blocks to make them valid. This requires fast CPUs and a lot of memory as well as completing
both install steps above.
```bash
sh ./scripts/run_timelord.sh
```

### Tips
## Tips
When running the servers on Mac OS, allow the application to accept incoming connections.

UPnP is enabled by default, to open the port for incoming connections. If this causes issues, you can disable it in the configuration. Some routers may require port forwarding, or enabling UPnP in the router configuration.
Ubuntu 19.xx, Amazon Linux 2, and CentOS 7.7 or newer are the easiest linux install environments currently.

UPnP is enabled by default, to open the port for incoming connections. If this causes issues,
you can disable it in the configuration. Some routers may require port forwarding, or enabling
UPnP in the router configuration.

Due to the nature of proof of space lookups by the harvester you should limit the number of plots on a physical drive to 50 or less.
Due to the nature of proof of space lookups by the harvester you should limit the number of plots
on a physical drive to 50 or less. This limit should significantly increase before beta.

You can also run the simulation, which runs all servers and multiple full nodes, locally, at once.
If you want to run the simulation, change the introducer ip in ./config/config.yaml so that the full node points to the local introducer (127.0.0.1:8445).
Note the the simulation is local only.
The introducer will only know the local ips of the full nodes, so it cannot broadcast the correct ips to external peers.
If you want to run the simulation, change the introducer ip in ./config/config.yaml so that the
full node points to the local introducer (127.0.0.1:8445).

Note the the simulation is local only and requires installation of timelords and VDFs.

The introducer will only know the local ips of the full nodes, so it cannot broadcast the correct
ips to external peers.

```bash
sh ./scripts/run_all_simulation.sh
Expand Down
19 changes: 5 additions & 14 deletions install.sh
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,13 @@
#!/bin/bash
set -e

python3 -m venv .venv
. .venv/bin/activate
pip install wheel # For building blspy
pip install -e .
pip install -r requirements.txt

# Install libgmp, libboost, and libflint, and then run the following
# Check for git clone of flint2 on MacOS and install if found
if [ -f flint2/configure ]; then
cd flint2/
if [ ! -f Makefile ]; then
./configure
fi
make -j4
make install
cd ../
fi

cd lib/chiavdf/fast_vdf && sh install.sh
echo "\nChia blockchain install.sh complete."
echo ""
echo "Chia blockchain install.sh complete."
echo "For assistance join us on Keybase in the #testnet chat channel"
echo "https://keybase.io/team/chia_network.public"
27 changes: 27 additions & 0 deletions install_timelord.sh
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#!/bin/bash
set -e

if [ `uname` = "Linux" ] && type apt-get; then
# Debian/Ubuntu
sudo apt-get install -y libgmp3-dev libflint-dev \
libboost-dev libboost-system-dev
fi

# Install libgmp, libboost, and libflint, and then run the following
# Check for git clone of flint2 on MacOS and install if found
if [ -f flint2/configure ]; then
cd flint2/
if [ ! -f Makefile ]; then
./configure
fi
make -j4
make install
cd ../
fi

make -C lib/chiavdf/fast_vdf

echo ""
echo "Chia blockchain install_timelord.sh complete."
echo "For assistance join us on Keybase in the #testnet chat channel"
echo "https://keybase.io/team/chia_network.public"
36 changes: 36 additions & 0 deletions lib/chiavdf/fast_vdf/Makefile
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
UNAME := $(shell uname)

ifeq ($(UNAME),Linux)
ALL_INSTR := $(shell grep -w avx2 /proc/cpuinfo | grep -w fma | grep -w -q adx \
&& echo 1 || echo 0)
else
ALL_INSTR := 0
endif

LDFLAGS += -no-pie
LDLIBS += -lgmpxx -lgmp -lflint -lboost_system -pthread
CXXFLAGS += -std=c++1z -D VDF_MODE=0 -D ENABLE_ALL_INSTRUCTIONS=$(ALL_INSTR) \
-no-pie -pthread -march=native
ifeq ($(UNAME),Darwin)
CXXFLAGS += -D CHIAOSX=1
else
OPT_CFLAGS = -O3
endif

.PHONY: all clean

all: vdf_server

clean:
rm -f *.o vdf_server compile_asm

vdf_server: vdf_server.o asm_compiled.o
$(CXX) $(LDFLAGS) -o $@ $^ $(LDLIBS)

vdf_server.o: CXXFLAGS += $(OPT_CFLAGS)

asm_compiled.s: compile_asm
./compile_asm

compile_asm: compile_asm.o
$(CXX) $(LDFLAGS) -o $@ $^ $(LDLIBS)
2 changes: 0 additions & 2 deletions lib/chiavdf/fast_vdf/compile.sh
View file

This file was deleted.

2 changes: 0 additions & 2 deletions lib/chiavdf/fast_vdf/copy_to_repo.sh
View file

This file was deleted.

2 changes: 0 additions & 2 deletions lib/chiavdf/fast_vdf/install.sh
View file

This file was deleted.

Loading

0 comments on commit d9bf22c

Please sign in to comment.