nurazhar
/
xch-blockchain
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
xch-blockchain/README.md

54 lines
4.3 KiB
Markdown
Raw Permalink Normal View History

Integrate GH super linter - fix shell, markdown, python issues (#296) * Try super-linter * Fix lint issues, move to separate gh action * Fix md, shell * Ignore import-error for python - fix MDs * Disable standard-js, initial eslint config * Fix raises, remove prettier for now * skip pylint no-member check in src/util/byte_types.py line 40 * pyinstaller windows back to INFO * Disable powershell lint for now. * Disable css validation temporarily
2020-06-24 05:47:06 +02:00
# chia-blockchain
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Update the README to link to the Chia website (#14801) Mention and link to the Chia website in the README
2023-03-10 23:45:18 +01:00
[![Chia Network logo](https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg "Chia logo")](https://www.chia.net/)
Fix readme tables for PyPI Apparently PyPI is a bit pickier about blank lines before tables than GitHub is.
2020-09-17 03:35:10 +02:00
Update README for main-master change
2020-10-22 01:20:41 +02:00
| Current Release/main | Development Branch/dev |
Oops. Fix README.md
2020-05-06 07:07:09 +02:00
| :---: | :---: |
Various clean ups, spelling thanks @adamfiddler, isort (#1278) * Various clean ups, spelling thanks @adamfiddler, isort * Actually thank @adamfiddler * isort tests * Update changelog, readme, spec, spelling * Readme nit * locales * locales again
2021-03-13 23:57:41 +01:00
| [![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) |
README.md formatting And added a word
2019-12-05 19:43:24 +01:00
Move netspace calculations to rpc-server. Refactor cli.
2020-05-16 02:57:56 +02:00
![GitHub contributors](https://img.shields.io/github/contributors/Chia-Network/chia-blockchain?logo=GitHub)
Integrate GH super linter - fix shell, markdown, python issues (#296) * Try super-linter * Fix lint issues, move to separate gh action * Fix md, shell * Ignore import-error for python - fix MDs * Disable standard-js, initial eslint config * Fix raises, remove prettier for now * skip pylint no-member check in src/util/byte_types.py line 40 * pyinstaller windows back to INFO * Disable powershell lint for now. * Disable css validation temporarily
2020-06-24 05:47:06 +02:00
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Chia is a modern cryptocurrency built from scratch, designed to be efficient, decentralized, and secure. Here are some of the features and benefits:
Add some more info about the benefits of chia (#1454) * Add some more info about the benefits of chia * A few more tweaks
2021-03-23 18:40:19 +01:00
* [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)
Chia Seeder (#8991) * initial hack * crawler * add pytz * Checkpoint. * Catch some bugs. * Localhost dig working. * Checkpoint: return only high quality nodes. * Statistics. * Try improving finding reliable nodes. * Bug. * Move db to memory. * Timestamp in the last 5 days. * Increase crawl parameters, 180+ connections per sec. * Bug. * Optimize for DNS traffic. * Prepare for hosting. * Minimum height. * Typo. * Try catch everything. * dnslib. * Add db, format code. * nits. * No connections for the dns server. * Rename src -> chia * Fix some issues with v1.1 * Crawler task pool. * Optimize closing connections. * Split crawler and dns server. * Install instructions. * Catch startup bug. * Try a big timeout for lock aquire. * lint. * Lint. * Initial commit extended stats. * Simplify code. * Config. * Correct stats. * Be more restrictive in crawling. * Attempt to fix stats bug. * Add other peers port to config. * Update README for the config. * Simplify crawl task. * Fix bug on restarts. * Prevent log spamming. * More spam prevention. * Fix bug. * Ipv6 (#1) * Enable ipv6. * Fix bug. * Use numeric codes for QTYPE. * ANY working. * More spam prevention. * Try to improve IPv6 selection. * Log IPv6 available. * Try to crawl more aggresive for v6. * rename dns.py to crawler_dns.py so it doesn't conflict with imported package names * Remove pytz package off dependencies * Tidy-up ws_connection.py * Fix spelling * Reinstate chia-blockchain readme, with additional lines pertaining to the DNS introducer & crawler * More detailed info in the README wrt Chia Seeder * Nit * More memetic naming of Chia Seeder * Nit * Add entry points * Add entry in packages * Patch some methods on the upstream server * Update peer record fields * Standard library imports first * Crawler API check * Reconcile crawl store * Account for crawler_db_path in config * Await crawl store load DB and load reliable peers * Updates to crawler * Rename to dns_server * Crawler-specific overrides for the chia server * Edit comment * Undo changes to ChiaServer in view of crawler-specific overrides introduced in previous commit * Nit * Update service groups * Expand name maps, mostly * Fix the init config * Remove unused import * total_records unused at this stage * Remove ios_reliable in peer_reliability table * Remove row[20] entry * Split overly long line * Fix * Type hint for ns_records * Reconcile mismatch btw type int and uint64 * Type annotations in crawler * Check whether crawl store is set * Remove upnp_list * Lint * Chia Seeder CLI * Lint * Two white spaces * 3rd party package import * Cleaner way to handle overrides for ChiaServer method * Address linter warnings * Rename * Nits * Fix * Change port # * Most chia_seeder commands up and running * Rename * Progress of sorts * Fix * Improve legibility * Fix naming * Fix setup.py * Lint * None -> '' * Remove whitespace * Rename * Log ipv6 better. (#9227) * Log ipv6 better. * Lint. * - * Undo GUI changes * Another attempt * GUI changes Co-authored-by: Yostra <straya@chia.net> Co-authored-by: Florin Chirica <fchirica96@gmail.com> Co-authored-by: Chris Marslender <chrismarslender@gmail.com>
2021-11-28 03:30:25 +01:00
* [Chia seeder](https://github.com/Chia-Network/chia-blockchain/wiki/Chia-Seeder-User-Guide), which maintains a list of reliable nodes within the Chia network via a built-in DNS server.
bytes formatting simplify (#6021) * init * Add dash in README * add more test cases * whitespace around == * explicit return * add another large test case
2021-05-26 20:11:44 +02:00
* 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
Add some more info about the benefits of chia (#1454) * Add some more info about the benefits of chia * A few more tweaks
2021-03-23 18:40:19 +01:00
* BLS keys and aggregate signatures (only one signature per block)
[DOCS] Updated main readme to point to pooling guide (#7280)
2021-07-13 04:42:14 +02:00
* [Pooling protocol](https://github.com/Chia-Network/chia-blockchain/wiki/Pooling-User-Guide) that allows farmers to have control of making blocks
Add some more info about the benefits of chia (#1454) * Add some more info about the benefits of chia * A few more tweaks
2021-03-23 18:40:19 +01:00
* Support for light clients with fast, objective syncing
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
* A growing community of farmers and developers around the world
Add some more info about the benefits of chia (#1454) * Add some more info about the benefits of chia * A few more tweaks
2021-03-23 18:40:19 +01:00
Update the README to link to the Chia website (#14801) Mention and link to the Chia website in the README
2023-03-10 23:45:18 +01:00
Please check out the [Chia website](https://www.chia.net/), the [wiki](https://github.com/Chia-Network/chia-blockchain/wiki), and [FAQ](https://github.com/Chia-Network/chia-blockchain/wiki/FAQ) for
Reformat README.md and add "is compiling" badges
2020-04-27 01:18:21 +02:00
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.
Move Install and Quickstart to the repo wiki
2020-04-26 23:40:25 +02:00
These methods tend to be router make/model specific.
Some basic boilerplate, and start with plotter.py
2019-07-19 05:30:31 +02:00
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Most users should only install harvesters, farmers, plotter, full nodes, and wallets.
Chia Seeder (#8991) * initial hack * crawler * add pytz * Checkpoint. * Catch some bugs. * Localhost dig working. * Checkpoint: return only high quality nodes. * Statistics. * Try improving finding reliable nodes. * Bug. * Move db to memory. * Timestamp in the last 5 days. * Increase crawl parameters, 180+ connections per sec. * Bug. * Optimize for DNS traffic. * Prepare for hosting. * Minimum height. * Typo. * Try catch everything. * dnslib. * Add db, format code. * nits. * No connections for the dns server. * Rename src -> chia * Fix some issues with v1.1 * Crawler task pool. * Optimize closing connections. * Split crawler and dns server. * Install instructions. * Catch startup bug. * Try a big timeout for lock aquire. * lint. * Lint. * Initial commit extended stats. * Simplify code. * Config. * Correct stats. * Be more restrictive in crawling. * Attempt to fix stats bug. * Add other peers port to config. * Update README for the config. * Simplify crawl task. * Fix bug on restarts. * Prevent log spamming. * More spam prevention. * Fix bug. * Ipv6 (#1) * Enable ipv6. * Fix bug. * Use numeric codes for QTYPE. * ANY working. * More spam prevention. * Try to improve IPv6 selection. * Log IPv6 available. * Try to crawl more aggresive for v6. * rename dns.py to crawler_dns.py so it doesn't conflict with imported package names * Remove pytz package off dependencies * Tidy-up ws_connection.py * Fix spelling * Reinstate chia-blockchain readme, with additional lines pertaining to the DNS introducer & crawler * More detailed info in the README wrt Chia Seeder * Nit * More memetic naming of Chia Seeder * Nit * Add entry points * Add entry in packages * Patch some methods on the upstream server * Update peer record fields * Standard library imports first * Crawler API check * Reconcile crawl store * Account for crawler_db_path in config * Await crawl store load DB and load reliable peers * Updates to crawler * Rename to dns_server * Crawler-specific overrides for the chia server * Edit comment * Undo changes to ChiaServer in view of crawler-specific overrides introduced in previous commit * Nit * Update service groups * Expand name maps, mostly * Fix the init config * Remove unused import * total_records unused at this stage * Remove ios_reliable in peer_reliability table * Remove row[20] entry * Split overly long line * Fix * Type hint for ns_records * Reconcile mismatch btw type int and uint64 * Type annotations in crawler * Check whether crawl store is set * Remove upnp_list * Lint * Chia Seeder CLI * Lint * Two white spaces * 3rd party package import * Cleaner way to handle overrides for ChiaServer method * Address linter warnings * Rename * Nits * Fix * Change port # * Most chia_seeder commands up and running * Rename * Progress of sorts * Fix * Improve legibility * Fix naming * Fix setup.py * Lint * None -> '' * Remove whitespace * Rename * Log ipv6 better. (#9227) * Log ipv6 better. * Lint. * - * Undo GUI changes * Another attempt * GUI changes Co-authored-by: Yostra <straya@chia.net> Co-authored-by: Florin Chirica <fchirica96@gmail.com> Co-authored-by: Chris Marslender <chrismarslender@gmail.com>
2021-11-28 03:30:25 +01:00
Setting up a seeder is best left to more advanced users.
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Building Timelords and VDFs is for sophisticated users, in most environments.
Reformat README.md and add "is compiling" badges
2020-04-27 01:18:21 +02:00
Chia Network and additional volunteers are running sufficient Timelords
Various clean ups, spelling thanks @adamfiddler, isort (#1278) * Various clean ups, spelling thanks @adamfiddler, isort * Actually thank @adamfiddler * isort tests * Update changelog, readme, spec, spelling * Readme nit * locales * locales again
2021-03-13 23:57:41 +01:00
for consensus.
Separate timelord, add Windows/CentOS/AMZN (#62) 1.1.1 release * windows build instructions * install.sh newline fix \n wasn't as cross platform as it should be so reverted to an extra echo * Add CentOS to README.md Full CentOS 7.7 install instructions * mention blspy * confirmed boost 1.67.0 works on Ubuntu * Update README.md. * Fix problem with zip download. * Remove scm warning Revert install instructions due to scm fix * Update README and install scripts to separate timelord installation Do not install VDF server and its dependencies in install.sh, create a separate script install_timelord.sh for that. * Move installation of VDF server dependencies to install_timelord.sh * First and broken attempt at CentOS install * Working CentOS 7.7 install * typos in timelord explanation * Timlord/VDF build instructions Specifics for CentOS and MacOS * Various install tips and tricks * spelling error * Add AMZN linux 2 install * Add AMZN linux 2 timelord install Also clean up base install instructions * Combine TL for AMZN and CentOS * Nits for AMZN and CentOS * CentOS, AMZN timelord paralleling * Fix header layouts * Replace VDF server compilation scripts with Makefile * layout improvements * fast_vdf: Remove unused files * Partial ARM install support * missing l in lib * Fleshed out Windows/WSL installs And verified the method for upgrade to 19.x * Move MacOS install fullnode to bottom * Change to mongo "system-wide" * Add mongo start to WSL * Add actual upgrade for WSL/Ubuntu Co-authored-by: Mariano Sorgente <sorgente711@gmail.com> Co-authored-by: Rostislav Skudnov <skrostislav@gmail.com> Co-authored-by: Richard Kiss <him@richardkiss.com> Co-authored-by: wjblanke <wjb2002@flex.com>
2019-12-25 20:18:07 +01:00
Integrate GH super linter - fix shell, markdown, python issues (#296) * Try super-linter * Fix lint issues, move to separate gh action * Fix md, shell * Ignore import-error for python - fix MDs * Disable standard-js, initial eslint config * Fix raises, remove prettier for now * skip pylint no-member check in src/util/byte_types.py line 40 * pyinstaller windows back to INFO * Disable powershell lint for now. * Disable css validation temporarily
2020-06-24 05:47:06 +02:00
## Installing
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Reformat README.md and add "is compiling" badges
2020-04-27 01:18:21 +02:00
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).
Update README.
2020-03-29 23:29:39 +02:00
Integrate GH super linter - fix shell, markdown, python issues (#296) * Try super-linter * Fix lint issues, move to separate gh action * Fix md, shell * Ignore import-error for python - fix MDs * Disable standard-js, initial eslint config * Fix raises, remove prettier for now * skip pylint no-member check in src/util/byte_types.py line 40 * pyinstaller windows back to INFO * Disable powershell lint for now. * Disable css validation temporarily
2020-06-24 05:47:06 +02:00
## Running
Improve style consistency in root directory docs files (#4493) * Improve style consistency * black python required blank Co-authored-by: Nikolaj Kuntner <>
2021-05-12 22:12:30 +02:00
Reformat README.md and add "is compiling" badges
2020-04-27 01:18:21 +02:00
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).