Chia blockchain python implementation (full node, farmer, harvester, timelord, and wallet)
Go to file
Kyle Altendorf 2a6564c0a7
move all linter config to the root (#9830)
This reduces duplication, symlinks, and makes the configurations
available by default for the linting tools.
2022-01-19 11:38:11 -08:00
.github move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
benchmarks revert allow-upgrades configuration option. It makes it significantly more complicated to do proper database migrations (#9768) 2022-01-13 14:53:27 -08:00
build_scripts Cleanup all global node modules + uninstall node to start fresh on each CI run (#9820) 2022-01-14 15:26:58 -06:00
chia Safer check for pool_list in config (#9810) 2022-01-19 11:35:24 -08:00
chia-blockchain-gui@bbc35f63e8 pinning to bbc35f63e848a1f5918ad942ed3a81861ac2093f for selector gui 2022-01-19 10:57:13 -08:00
mozilla-ca@b1b808ab93 Chia Seeder (#8991) 2021-11-27 18:30:25 -08:00
tests Set pools CI test timeout to 45 minutes (#9817) 2022-01-15 16:31:54 -08:00
tools add tool to analyze the chain from the blockchain database, and run all generator programs (#9616) 2021-12-21 10:20:17 -08:00
.flake8 move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
.gitignore Exclude Files created by wheel. (#9806) 2022-01-13 17:43:27 -08:00
.gitmodules Pools mainnet (#7047) 2021-06-29 14:21:25 -07:00
.isort.cfg move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
.markdown-lint.yml move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
.pre-commit-config.yaml Update pre-commit mypy to 0.930 (#9648) 2022-01-06 18:59:56 -08:00
BUILD_TIMELORD.md update permissions (#6061) 2021-05-26 11:33:26 -07:00
CHANGELOG.md changelog1.2.11 (#9137) 2021-11-04 17:17:00 -07: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 pre-commit: Add initial config and run it for all files (#7053) 2021-08-02 10:48:22 -07:00
INSTALL.md Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
Install-gui.ps1 Restore original CWD in Install-gui.ps1 (#8912) 2021-10-29 10:45:13 -07:00
Install.ps1 Avoid activating venv in Install.ps1 (#8927) 2021-10-29 10:44:46 -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
azure-pipelines.yml Make sure to fail CI when unable to get madMAx version (#9573) 2021-12-15 10:00:36 -06:00
install-gui.sh install-gui: Drop trailing whitespaces (#8723) 2021-10-05 09:47:57 -07:00
install-timelord.sh Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
install.sh Modifying install.sh to account for python3.10.x (#9633) 2021-12-21 10:14:16 -08:00
installhelper.py only use the last line of chia version output in installhelper.py (#8239) 2021-08-27 10:42:07 -07:00
lgtm.yml Fixed an issue where LGTM on chia-blockchain-gui did not work (#9750) 2022-01-10 20:56:46 -08:00
mypy.ini tweak mypy config (#9368) 2021-11-24 13:06:39 -08:00
pylintrc move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
pyproject.toml Plotting needs Mo memory (#620) 2021-01-12 17:02:22 -05:00
run-py-tests.sh Mypy issues on python 3.9.7 (#8554) 2021-09-22 10:44:03 -07:00
setup.py Bump dnslib from 0.9.14 to 0.9.17 (#9795) 2022-01-14 14:40:09 -08: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.