You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To install the chia-blockchain node, follow the instructions according to your operating system.
4
-
After installing, follow the remaining instructions in [README.md](README.md) to run the software.
3
+
Install instructions have been moved to the [INSTALL](https://github.com/Chia-Network/chia-blockchain/wiki/INSTALL) section of the repository [Wiki](https://github.com/Chia-Network/chia-blockchain/wiki)
5
4
6
-
### MacOS
7
-
Currently Catalina (10.15.x) is required.
8
-
Make sure [brew](https://brew.sh/) is available before starting the setup.
You will be prompted to reboot. Once that is complete, install Ubuntu 18.04 LTS from the Microsoft Store and run it and complete its initial install steps. You now have linux bash shell that can run linux native software on Windows.
52
-
53
-
Then follow the steps below which are the same as the usual Ubuntu instructions above.
You will need to download the Windows native Wallet and unzip into somewhere convenient in Windows. You may have to choose "More Info" and "Run Anyway" to be able to run the currently unsigned installer. This will place a Chia icon in your Start menu and on your Desktop that starts the Wallet UI.
Instead of `chia start wallet-ui &` as explained in the [README.md](README.md) you run `chia start wallet-server &` in Ubuntu/WSL 2 to allow the Wallet to connect to the Full Node running in Ubuntu/WSL 2. Once you've enabled `chia start wallet-server &` you can run "Chia" from the Start menu or your Desktop.
After installing, follow the remaining instructions in the [Quick Start Guide](https://github.com/Chia-Network/chia-blockchain/wiki/Quick-Start-Guide) to run the software.
Copy file name to clipboardExpand all lines: README.md
+10-81Lines changed: 10 additions & 81 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,101 +3,30 @@ Please check out the [wiki](https://github.com/Chia-Network/chia-blockchain/wiki
3
3
4
4
Python 3.7+ is required. Make sure your default python version is >=3.7 by typing `python3`.
5
5
6
-
If you are behind a NAT, it can be difficult for peers outside your subnet to reach you. You can enable
6
+
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
7
7
[UPnP](https://www.homenethowto.com/ports-and-nat/upnp-automatic-port-forward/) on your router or add a
8
-
NAT (for IPv4 but not IPv6) and firewall rules to allow TCP port 8444 access to your peer. These methods
9
-
tend to be router make/model specific.
8
+
NAT (for IPv4 but not IPv6) and firewall rules to allow TCP port 8444 access to your peer.
9
+
These methods tend to be router make/model specific.
10
10
11
-
For testnet most 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 time lords for testnet consensus.
11
+
Most 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 time lords for testnet consensus.
12
12
13
-
All configuration and plot data is stored in a directory structure at the $CHIA_ROOT environment variable or at ~/.chia/VERSION-DIR/ if that variable is not set. You can find databases, keys, plots, and logs there. You can set $CHIA_ROOT to the .chia directory in your home directory with `export CHIA_ROOT=~/.chia` and if you add it to your .bashrc or .zshrc to it will remain set across logouts and reboots.
13
+
# Installing
14
+
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).
14
15
15
-
## Install the code
16
-
To install chia-blockchain, follow [these install](INSTALL.md) instructions according to your operating system. This project only supports 64 bit operating systems.
16
+
#Running
17
+
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).
17
18
18
-
Remember that once you complete your install you **must be in the Python virtual environment** which you access from the chia-blockchain directory (or your home directory if you opted for a binary install) with the command `. ./activate`. Both dots are critical and once executed correctly your cli prompt will look something like `(venv) username@machine:~$` with ``(venv)`` prepended. Use `deactivate` should you want to exit the venv.
19
-
20
-
## Migrate or set up configuration files
21
-
```bash
22
-
chia init
23
-
```
24
-
25
-
## Generate keys
26
-
First, create some keys by running the following script if you don't already have keys:
27
-
```bash
28
-
chia generate keys
29
-
```
30
-
31
-
## Run a full node + wallet
32
-
To run a full node on port 8444, and connect to the testnet, run the following command. Logs are usually at ~/.chia/VERSION/logs/debug.log.
33
-
34
-
```bash
35
-
chia start node &
36
-
chia start wallet-gui &
37
-
```
38
-
If you're using Windows/WSL 2, you should instead run:
39
-
```bash
40
-
chia start node &
41
-
chia start wallet-server &
42
-
```
43
-
And then run `Chia` from the Chia Wallet Installer in Windows (not in Ubuntu/WSL 2.)
44
-
45
-
## Run a farmer + full node + wallet
46
-
In addition to running a full node, as explained above, you can also run a farmer.
47
-
Farmers are entities in the network who use their drive space to try to create
48
-
blocks (like Bitcoin's miners), and earn block rewards. First, you must generate some drive plots, which
49
-
can take a long time depending on the [size of the plots](https://github.com/Chia-Network/chia-blockchain/wiki/k-sizes)
50
-
(the k variable). To be competitive on the current network you will probably have to have a few k=29 or larger plots but a k=29 plot currently takes about 4.5 hours to plot on an [M.2 PCIe NVMe SSD](https://en.wikipedia.org/wiki/M.2).
51
-
Once you have a few plots, run the farmer + full node with the following commands. A full node is also started when you start the farmer.
52
-
53
-
You can change the working directory and output directory for plotting, with the "-t" (temp) and "-d" (destination) arguments to the `chia-create-plots` command.
54
-
```bash
55
-
chia-create-plots -k 29 -n 2
56
-
chia start farmer &
57
-
chia start wallet-gui &
58
-
```
59
-
If you're using Windows/WSL 2, you should instead run:
60
-
```bash
61
-
chia-create-plots -k 29 -n 2
62
-
chia start farmer &
63
-
chia start wallet-server &
64
-
```
65
-
Then run `Chia` from the Chia Windows Wallet installer in Windows (not in Ubuntu/WSL 2.)
66
-
67
-
68
-
## Run a timelord + full node + wallet
69
-
70
-
*Note*
71
-
If you want to run a timelord on Linux, see LINUX_TIMELORD.md.
72
-
73
-
Timelords execute sequential verifiable delay functions (proofs of time or VDFs), that get added to
74
-
blocks to make them valid. This requires fast CPUs and a few cores per VDF as well as completing the install steps above and running the following from the chia-blockchain directory:
75
-
```bash
76
-
. ./activate
77
-
sh install-timelord.sh
78
-
chia start timelord &
79
-
```
80
-
81
-
## Tips
19
+
# Tips
82
20
Ubuntu 18.04 LTS, 19.xx, Amazon Linux 2, and CentOS 7.7 or newer are the easiest linux install environments.
83
21
84
-
Windows users (and others) can [download Virtualbox](https://www.virtualbox.org/wiki/Downloads) and install [Ubuntu Desktop 18.04 LTS](https://ubuntu.com/download/desktop) in a virtual machine. This will allow you to run all of the chia tools and use the Wallet GUI. There are lots of good howtos on the web including [this one on installing Ubuntu 19.10 Desktop](https://techsviewer.com/how-to-install-ubuntu-19-10-on-virtualbox/).
85
-
86
22
UPnP is enabled by default, to open port 8444 for incoming connections. If this causes issues,
87
23
you can disable it in the configuration. Some routers may require port forwarding, or enabling
88
24
UPnP in the router configuration.
89
25
90
26
Due to the nature of proof of space lookups by the harvester in the current release you should limit
91
27
the number of plots on a physical drive to 50 or less. This limit will significantly increase soon.
92
28
93
-
You can also run the simulation, which runs all servers and multiple full nodes, locally. Note the the simulation is local only and requires installation of timelords and VDFs. The introducer will only know the local ips of the full nodes, so it cannot broadcast the correct
94
-
ips to external peers.
95
-
96
-
```bash
97
-
chia-start-sim
98
-
```
99
-
100
-
## uvloop
29
+
# uvloop
101
30
102
31
For potentially increased networking performance, install uvloop:
0 commit comments