chia-blockchain/BUILD_TIMELORD.md
Gene Hoffman c3a3fdba1f Integrate GH super linter - fix shell, markdown, python issues (#296)
* Try super-linter
* Fix lint issues, move to separate gh action
* Fix md, shell
* Ignore import-error for python - fix MDs
* Disable standard-js, initial eslint config
* Fix raises, remove prettier for now
* skip pylint no-member check in src/util/byte_types.py line 40
* pyinstaller windows back to INFO
* Disable powershell lint for now.
* Disable css validation temporarily
2020-07-16 13:05:43 -07:00

30 lines
1.2 KiB
Markdown

# Building timelords
The Linux and MacOS chiavdf binary wheels currently exclude an executable
required to run a Timelord. If you want to run a Timelord on Linux or MacOS,
you must install the wheel from source (which may require some additional
development packages) while in the virtual environment.
```bash
. ./activate
sh install-timelord.sh
```
If the compile fails, it's likely due to a missing dependency.
[install-timelord.sh](https://github.com/Chia-Network/chia-blockchain/blob/master/install-timelord.sh)
attempts to install required build dependencies for Linux and MacOS before
invoking pip to build from the source python distribution of chiavdf.
The `install-timelord.sh` install script leverages two environmental variables
that the chiavdf wheels can use to specify how to build. `vdf_client` is the
service that the Timelord uses to run the VDF and prove the Proof of Time.
`vdf_bench` is a utility to get a sense of a given CPU's iterations per second.
- To build vdf_client set the environment variable BUILD_VDF_CLIENT to "Y".
`export BUILD_VDF_CLIENT=Y`.
- Similarly, to build vdf_bench set the environment variable BUILD_VDF_BENCH
to "Y". `export BUILD_VDF_BENCH=Y`.
Building and running Timelords in Windows x86-64 is not yet supported.