Chia blockchain python implementation (full node, farmer, harvester, timelord, and wallet)
Go to file
Amine Khaldi d73e979720
Deprecate `chia plotters install` command (#13584) (#13643)
* Deprecated `chia plotters install` command

* Fixed lint errors

* Made it able to recognize plotter executables in venv

* Added install-plotter.sh

* Removed strings for debug

* Added install-plotter.ps1

* Fixed an issue where madmax plotter under venv dir was not recognized by 'chia plotters' command

* Added exec permission to install-plotter.sh

* Fixed issues found in install-plotter.sh

* Fixed lint errors

* Added `-p` option to install.sh/install.ps1

* Fixed lint errors

* Added nice deprecated warning

* Fixed a lint error

* Slightly improved branching

* Made log messages look nice

* Fixed an issue where install.sh/ps1 -p failed if virtual env is not acivated

Co-authored-by: Izumi Hoshino <admin@chiamine.jp>
2022-10-17 14:29:02 -05:00
.github Fix secret check (#13597) 2022-10-04 17:11:21 -05:00
benchmarks configure isort to add the future annotations import (#13327) 2022-09-30 03:40:22 -05:00
build_scripts configure isort to add the future annotations import (#13327) 2022-09-30 03:40:22 -05:00
chia Deprecate `chia plotters install` command (#13584) (#13643) 2022-10-17 14:29:02 -05:00
chia-blockchain-gui@17129c5154 Bump chia-blockchain-gui to 17129c5154 (#13593) 2022-10-04 09:55:02 -05:00
mozilla-ca@20aab1c28b adding ca updates (#12503) 2022-07-20 23:57:48 -05:00
tests feat: enable `create_signed_transaction` and `push_transaction` (#13466) 2022-10-08 20:54:20 -05:00
tools do not compile ChiaLisp at import time (#13609) 2022-10-13 11:32:51 -07: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 data layer - remove old .gitignore (#13198) 2022-08-30 02:59:54 -05:00
.gitmodules catchup: into main from long_lived/post_1.5.0 @ 916ccee549 (#12629) 2022-07-29 16:58:21 -05:00
.isort.cfg configure isort to add the future annotations import (#13327) 2022-09-30 03:40:22 -05:00
.markdown-lint.yml move all linter config to the root (#9830) 2022-01-19 11:38:11 -08:00
.pre-commit-config.yaml embrace click 8 (#13559) 2022-09-29 11:24:36 -05:00
BUILD_TIMELORD.md update permissions (#6061) 2021-05-26 11:33:26 -07:00
CHANGELOG.md Remove unreleased section from changelog (#13495) 2022-09-23 19:43:34 -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 run pylint directly (#12100) 2022-06-27 10:53:04 -05: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-plotter.ps1 Deprecate `chia plotters install` command (#13584) (#13643) 2022-10-17 14:29:02 -05:00
Install.ps1 Deprecate `chia plotters install` command (#13584) (#13643) 2022-10-17 14:29:02 -05:00
LICENSE 2021 year -> 2022 (#9829) 2022-01-15 19:41:56 -08:00
README.md logo-fix (#13610) 2022-10-07 15:51:31 -05:00
activated.ps1 Add .clvm.hex pre-commit check (#12050) 2022-09-12 16:08:55 -05:00
activated.py configure isort to add the future annotations import (#13327) 2022-09-30 03:40:22 -05:00
activated.sh pre-commit: Fix a venv activation issue on linux (#12822) 2022-08-09 18:27:11 -05:00
install-gui.sh more set -o errexit (#10468) 2022-03-17 09:13:27 -07:00
install-plotter.sh Deprecate `chia plotters install` command (#13584) (#13643) 2022-10-17 14:29:02 -05:00
install-timelord.sh make setup.py more normal, except in our exceptional case (#13214) 2022-09-16 15:58:11 -05:00
install.sh Deprecate `chia plotters install` command (#13584) (#13643) 2022-10-17 14:29:02 -05:00
installhelper.py configure isort to add the future annotations import (#13327) 2022-09-30 03:40:22 -05: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 Confirm equality of client and server RPC routes (#11765) 2022-09-26 11:18:46 -05:00
pylintrc run pylint directly (#12100) 2022-06-27 10:53:04 -05:00
pyproject.toml black the generated protocol messages code (#11786) 2022-06-08 10:21:03 -05:00
pytest.ini Merge commit '8b2f7ec24cdf22be2d5150f92b9f2c928b08120d' into checkpoint/long_lived_atari_from_main_8b2f7ec24cdf22be2d5150f92b9f2c928b08120d 2022-07-14 14:15:59 +01:00
run-py-tests.sh more set -o errexit (#10468) 2022-03-17 09:13:27 -07:00
setup.py Bump aiohttp from 3.8.1 to 3.8.3 (#13561) 2022-09-30 03:40:51 -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.