Chia blockchain python implementation (full node, farmer, harvester, timelord, and wallet)
Go to file
Kyle Altendorf a87e8e34ac
black the generated protocol messages code (#11786)
* black the generated protocol messages code

* Update tests/util/build_network_protocol_files.py

Co-authored-by: Arvid Norberg <arvid@libtorrent.org>

* more focused noqa

Co-authored-by: Arvid Norberg <arvid@libtorrent.org>
2022-06-08 10:21:03 -05:00
.github reusable workflow for a single test workflow (#11722) 2022-06-03 16:56:52 -05:00
benchmarks make recurse_jsonify() work directly on types (#11537) 2022-05-18 09:15:03 -07:00
build_scripts tidy installer building (#11077) 2022-04-29 18:34:48 -07:00
chia stop and join watchdog observer (#11706) 2022-06-08 10:20:08 -05:00
chia-blockchain-gui@b5c6bbc649 Bumping chia-blockchain-gui to b5c6bbc649 2022-06-06 10:38:08 -07:00
mozilla-ca@22106e511c adding ca updates (#11082) 2022-05-09 09:58:25 -07:00
tests black the generated protocol messages code (#11786) 2022-06-08 10:21:03 -05:00
tools upgrade chia-rs to streamable support (#11503) 2022-06-01 12:56:11 -05:00
.coveragerc run tests in CI via coverage (#9704) 2022-03-28 13:22:23 -07:00
.flake8 black the generated protocol messages code (#11786) 2022-06-08 10:21:03 -05:00
.gitignore Use get latest release endpoint for plotters, so that we ignore any pre-releases that could be returned by listReleases (#11165) 2022-04-13 18:06:50 -05:00
.gitmodules Pools mainnet (#7047) 2021-06-29 14:21:25 -07:00
.isort.cfg rename test files that are missing test_ prefix (#10712) 2022-05-16 09:51:00 -07:00
.markdown-lint.yml move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
.pre-commit-config.yaml black the generated protocol messages code (#11786) 2022-06-08 10:21:03 -05:00
BUILD_TIMELORD.md update permissions (#6061) 2021-05-26 11:33:26 -07:00
CHANGELOG.md Bring DID/NFT effort into release/1.4.0 (#11662) 2022-05-27 13:47:08 -05:00
CODE_OF_CONDUCT.md Bram's edit to code_of_conduct and start new dev branch 2020-09-15 12:26:16 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md (#11393) 2022-05-05 08:17:59 -07:00
INSTALL.md Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
Install-gui.ps1 replaced npm install => npm ci (#9717) 2022-01-19 16:52:20 -08:00
Install.ps1 Support for Python 3.10 (#9930) 2022-04-26 12:37:01 -07:00
LICENSE 2021 year -> 2022 (#9829) 2022-01-15 19:41:56 -08:00
README.md Chia Seeder (#8991) 2021-11-27 18:30:25 -08:00
install-gui.sh more set -o errexit (#10468) 2022-03-17 09:13:27 -07:00
install-timelord.sh Add dependencies macos rhel chiavdf (#11142) 2022-04-12 10:51:29 -07:00
install.sh Write python version error to stderr (#11239) 2022-05-14 02:04:18 -07:00
installhelper.py more isort (#11401) 2022-05-05 08:17:38 -07:00
lgtm.yml flag lgtm issues in test code and benchmark code as well (#11445) 2022-05-05 14:22:56 -07:00
mypy.ini Test. 2022-06-01 14:29:49 +01:00
pylintrc Remove code related to no-longer-used websockets library (#11123) 2022-04-20 11:18:42 -07:00
pyproject.toml black the generated protocol messages code (#11786) 2022-06-08 10:21:03 -05:00
pytest.ini Add Windows CI (#10681) 2022-05-31 14:04:45 -05:00
run-py-tests.sh more set -o errexit (#10468) 2022-03-17 09:13:27 -07:00
setup.py Add Source and Changelog to project_urls (#11694) 2022-06-02 13:10:14 -05:00
start-gui.sh more set -o errexit (#10468) 2022-03-17 09:13:27 -07:00

README.md

chia-blockchain

Alt text

Current Release/main Development Branch/dev
Ubuntu Core Tests MacOS Core Tests Windows Installer on Windows 10 and Python 3.7 Ubuntu Core Tests MacOS Core Tests Windows Installer on Windows 10 and Python 3.7

GitHub contributors

Chia is a modern cryptocurrency built from scratch, designed to be efficient, decentralized, and secure. Here are some of the features and benefits:

  • Proof of space and time based consensus which allows anyone to farm with commodity hardware
  • Very easy to use full node and farmer GUI and cli (thousands of nodes active on mainnet)
  • Chia seeder, which maintains a list of reliable nodes within the Chia network via a built-in DNS server.
  • Simplified UTXO based transaction model, with small on-chain state
  • Lisp-style Turing-complete functional programming language for money related use cases
  • BLS keys and aggregate signatures (only one signature per block)
  • Pooling protocol that allows farmers to have control of making blocks
  • Support for light clients with fast, objective syncing
  • A growing community of farmers and developers around the world

Please check out the wiki and FAQ for information on this project.

Python 3.7+ is required. Make sure your default python version is >=3.7 by typing python3.

If you are behind a NAT, it can be difficult for peers outside your subnet to reach you when they start up. You can enable UPnP on your router or add a NAT (for IPv4 but not IPv6) and firewall rules to allow TCP port 8444 access to your peer. These methods tend to be router make/model specific.

Most users should only install harvesters, farmers, plotter, full nodes, and wallets. Setting up a seeder is best left to more advanced users. Building Timelords and VDFs is for sophisticated users, in most environments. Chia Network and additional volunteers are running sufficient Timelords for consensus.

Installing

Install instructions are available in the INSTALL section of the chia-blockchain repository wiki.

Running

Once installed, a Quick Start Guide is available from the repository wiki.