Go to file
Josh Stewart ee1d6fcdb6
Reduce websocket ping interval and timeout to avoid socket breaking
2021-06-01 16:25:23 +10:00
.github Bump github/super-linter from 3.15.5 to 4.0.2 (#6209) 2021-05-29 12:47:23 -07:00
build_scripts Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
chia Reduce websocket ping interval and timeout to avoid socket breaking 2021-06-01 16:25:23 +10:00
chia-blockchain-gui@444c6966fe Update gui (#5623) 2021-05-20 12:49:44 -07:00
mozilla-ca@6e8c42b3ef Move mozilla pin, GUI 2021-03-08 15:22:34 -08:00
tests bytes formatting simplify (#6021) 2021-05-26 11:11:44 -07:00
.flake8 Isort take 3 (#1213) 2021-03-09 18:27:27 -08:00
.gitignore Merge DID into main (#1720) 2021-04-06 19:31:44 -07:00
.gitmodules Mozilla ca (#1155) 2021-03-04 14:25:35 -08:00
.isort.cfg Isort take 3 (#1213) 2021-03-09 18:27:27 -08:00
BUILD_TIMELORD.md update permissions (#6061) 2021-05-26 11:33:26 -07:00
CHANGELOG.md Chia Blockchian 1.1.6 (#5644) 2021-05-20 19:28:09 -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 Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
INSTALL.md Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
LICENSE Copyright 2021 Chia Network in LICENSE (#3153) 2021-04-29 21:44:40 -07:00
README.md bytes formatting simplify (#6021) 2021-05-26 11:11:44 -07:00
azure-pipelines.yml Fix azure pipeline (ht Gene). 2021-04-04 21:41:39 -07:00
install-gui.sh Clearly prohibit root from installing the GUI (#5232) 2021-05-18 11:40:26 -07:00
install-timelord.sh Improve style consistency in root directory docs files (#4493) 2021-05-12 13:12:30 -07:00
install.sh Bump github/super-linter from 3.15.5 to 4.0.2 (#6209) 2021-05-29 12:47:23 -07:00
mypy.ini Ms.fixtest (#432) 2020-10-01 11:07:12 -07:00
pyproject.toml Plotting needs Mo memory (#620) 2021-01-12 17:02:22 -05:00
run-py-tests.sh Ms.mempool improvements (#1823) 2021-04-13 21:19:12 -07:00
setup.py updated vdf and pos (#6150) 2021-05-27 22:16:57 -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)
  • 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 (in development) 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. 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.