mirror of
https://github.com/Chia-Network/chia-blockchain.git
synced 2024-09-21 00:24:37 +03:00
0b3124821f
* init * Add dash in README * add more test cases * whitespace around == * explicit return * add another large test case
53 lines
3.9 KiB
Markdown
53 lines
3.9 KiB
Markdown
# chia-blockchain
|
|
|
|
![Alt text](https://www.chia.net/img/chia_logo.svg)
|
|
|
|
| Current Release/main | Development Branch/dev |
|
|
| :---: | :---: |
|
|
| [![Ubuntu Core Tests](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-ubuntu-core.yml/badge.svg)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-ubuntu-core.yml) [![MacOS Core Tests](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-macos-core.yml/badge.svg)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-macos-core.yml) [![Windows Installer on Windows 10 and Python 3.7](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-windows-installer.yml/badge.svg)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-windows-installer.yml) | [![Ubuntu Core Tests](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-ubuntu-core.yml/badge.svg?branch=dev)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-ubuntu-core.yml) [![MacOS Core Tests](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-macos-core.yml/badge.svg?branch=dev)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-test-macos-core.yml) [![Windows Installer on Windows 10 and Python 3.7](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-windows-installer.yml/badge.svg?branch=dev)](https://github.com/Chia-Network/chia-blockchain/actions/workflows/build-windows-installer.yml) |
|
|
|
|
![GitHub contributors](https://img.shields.io/github/contributors/Chia-Network/chia-blockchain?logo=GitHub)
|
|
|
|
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](https://docs.google.com/document/d/1tmRIb7lgi4QfKkNaxuKOBHRmwbVlGL4f7EsBDr_5xZE/edit) 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](https://chialisp.com/) for money related use cases
|
|
* BLS keys and aggregate signatures (only one signature per block)
|
|
* [Pooling protocol](https://www.chia.net/2020/11/10/pools-in-chia.html) (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](https://github.com/Chia-Network/chia-blockchain/wiki)
|
|
and [FAQ](https://github.com/Chia-Network/chia-blockchain/wiki/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](https://www.homenethowto.com/ports-and-nat/upnp-automatic-port-forward/)
|
|
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](https://github.com/Chia-Network/chia-blockchain/wiki/INSTALL)
|
|
section of the
|
|
[chia-blockchain repository wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
|
|
|
|
## Running
|
|
|
|
Once installed, a
|
|
[Quick Start Guide](https://github.com/Chia-Network/chia-blockchain/wiki/Quick-Start-Guide)
|
|
is available from the repository
|
|
[wiki](https://github.com/Chia-Network/chia-blockchain/wiki).
|