README.md 29.4 KB
Newer Older
1
## EOS.IO - The Most Powerful Infrastructure for Decentralized Applications
N
Nathan Hourt 已提交
2

3
[![Build Status](https://jenkins.eos.io/buildStatus/icon?job=eosio/master)](https://jenkins.eos.io/job/eosio/job/master/)
peterwillcn's avatar
peterwillcn 已提交
4

D
Daniel Larimer 已提交
5 6
Welcome to the EOS.IO source code repository!  EOS.IO software enables developers to create and deploy
high-performance, horizontally scalable, blockchain infrastructure upon which decentralized applications
7
can be built.
D
Daniel Larimer 已提交
8 9

This code is currently alpha-quality and under rapid development. That said,
10 11
there is plenty early experimenters can do including running a private multi-node test network and
developing applications (smart contracts).
D
Daniel Larimer 已提交
12

13 14
The public testnet described in the [wiki](https://github.com/EOSIO/eos/wiki/Testnet%3A%20Public) is running the `dawn-2.x` branch.  The `master` branch is no longer compatible with the public testnet.  Instructions are provided below for building either option.

15 16
### Supported Operating Systems
EOS.IO currently supports the following operating systems:  
17 18 19 20
1. Amazon 2017.09 and higher.  
2. Fedora 25 and higher (Fedora 27 recommended).  
3. Ubuntu 16.04 and higher (Ubuntu 16.10 recommended).  
4. MacOS Darwin 10.12 and higher (MacOS 10.13.x recommended).  
21

D
Daniel Larimer 已提交
22 23
# Resources
1. [EOS.IO Website](https://eos.io)
24 25
2. [Documentation](https://eosio.github.io/eos/)
3. [Blog](https://steemit.com/@eosio)
S
Sandwich 已提交
26
4. [Community Telegram Group](https://t.me/EOSProject)
27 28 29
5. [Developer Telegram Group](https://t.me/joinchat/EaEnSUPktgfoI-XPfMYtcQ)
6. [White Paper](https://github.com/EOSIO/Documentation/blob/master/TechnicalWhitePaper.md)
7. [Roadmap](https://github.com/EOSIO/Documentation/blob/master/Roadmap.md)
J
Jonathan Giszczak 已提交
30
8. [Wiki](https://github.com/EOSIO/eos/wiki)
N
Nathan Hourt 已提交
31

32 33 34
# Table of contents

1. [Getting Started](#gettingstarted)
S
Serg Metelin 已提交
35
2. [Setting up a build/development environment](#setup)
36
	1. [Automated build script](#autobuild)
37 38
      1. [Clean install Linux (Amazon, Centos, Fedora, & Ubuntu) for a local testnet](#autoubuntulocal)
      2. [Clean install Linux (Amazon, Centos, Fedora, & Ubuntu) for the public testnet](#autoubuntupublic)
39 40
      3. [MacOS for a local testnet](#automaclocal)
      4. [MacOS for the public testnet](#automacpublic)
S
Serg Metelin 已提交
41
3. [Building EOS and running a node](#runanode)
42 43 44
	1. [Getting the code](#getcode)
	2. [Building from source code](#build)
	3. [Creating and launching a single-node testnet](#singlenode)
J
Jonathan Giszczak 已提交
45
  4. [Next steps](#nextsteps)
S
Sandwich 已提交
46 47
4. [Example Currency Contract Walkthrough](#smartcontracts)
	1. [Example Contracts](#smartcontractexample)
48 49 50
	2. [Setting up a wallet and importing account key](#walletimport)
	3. [Creating accounts for your smart contracts](#createaccounts)
	4. [Upload sample contract to blockchain](#uploadsmartcontract)
51
	5. [Pushing a message to a sample contract](#pushamessage)
52 53
	6. [Reading Currency Contract Balance](#readingcontract)
5. [Running local testnet](#localtestnet)
54 55 56 57
6. [Running a node on the public testnet](#publictestnet)
7. [Doxygen documentation](#doxygen)
8. [Running EOS in Docker](#docker)
9. [Manual installation of the dependencies](#manualdep)
58
   1. [Clean install Amazon 2017.09 and higher](#manualdepamazon)
59 60 61 62
   2. [Clean install Centos 7 and higher](#manualdepcentos)
   3. [Clean install Fedora 25 and higher](#manualdepfedora)
   4. [Clean install Ubuntu 16.04 and higher](#manualdepubuntu)
   5. [Clean install MacOS Sierra 10.12 and higher](#manualdepmacos)
63

S
Serg Metelin 已提交
64 65
<a name="gettingstarted"></a>
## Getting Started
66
The following instructions detail the process of getting the software, building it, running a simple test network that produces blocks, account creation and uploading a sample contract to the blockchain.
N
Nathan Hourt 已提交
67

S
Serg Metelin 已提交
68 69
<a name="setup"></a>
## Setting up a build/development environment
70

71 72 73
<a name="autobuild"></a>
### Automated build script

P
pacificcode 已提交
74
Supported Operating Systems:  
75
1. Amazon 2017.09 and higher.  
76 77 78 79
2. Centos 7 and higher.  
3. Fedora 25 and higher (Fedora 27 recommended).  
4. Ubuntu 16.04 and higher (Ubuntu 16.10 recommended).  
5. MacOS Darwin 10.12 and higher (MacOS 10.13.x recommended).  
80

81
For Amazon, Centos, Fedora, Ubuntu & MacOS there is an automated build script that can install all dependencies and builds EOS.
82
We are working on supporting other Linux/Unix distributions in future releases.
83

84
Choose whether you will be building for a local testnet or for the public testnet and jump to the appropriate section below.  Clone the EOS repository recursively as described and run eosio_build.sh located in the root `eos` folder.
85

86 87
:warning: **As of February 2018, `master` is under heavy development and is not suitable for experimentation.** :warning:

88
We strongly recommend following the instructions for building the public testnet version for [Ubuntu](#autoubuntupublic) or [Mac OS X](#automacpublic). `master` is in pieces on the garage floor while we rebuild this hotrod. This notice will be removed when `master` is usable again. Your patience is appreciated.
89

90
<a name="autoubuntulocal"></a>
91
#### :no_entry: Clean install Linux (Amazon, Centos, Fedora & Ubuntu) for a local testnet :no_entry:
92 93 94 95 96

```bash
git clone https://github.com/eosio/eos --recursive

cd eos
97
./eosio_build.sh
98 99
```

J
Jonathan Giszczak 已提交
100 101 102 103 104 105
For ease of contract development, one further step is required:

```bash
sudo make install
```

106 107
Now you can proceed to the next step - [Creating and launching a single-node testnet](#singlenode)

108
<a name="autoubuntupublic"></a>
109
#### Clean install Linux (Amazon, Centos, Fedora & Ubuntu) for the public testnet
110

111 112 113 114
```bash
git clone https://github.com/eosio/eos --recursive

cd eos
115

116
git checkout DAWN-2018-02-14
117
./eosio_build.sh
118 119
```

J
Jonathan Giszczak 已提交
120 121 122 123 124 125
For ease of contract development, one further step is required:

```bash
sudo make install
```

126 127 128
Now you can proceed to the next step - [Running a node on the public testnet](#publictestnet)

<a name="automaclocal"></a>
129
#### :no_entry: MacOS for a local testnet :no_entry:
130

131 132
Before running the script make sure you have installed/updated XCode. Note: The build script
will install homebrew if it is not already installed on you system. [Homebrew Website](https://brew.sh)
133

134
Then clone the EOS repository recursively and run eosio_build.sh in the root `eos` folder.
135

136 137 138 139
```bash
git clone https://github.com/eosio/eos --recursive

cd eos
140
./eosio_build.sh
141 142
```

J
Jonathan Giszczak 已提交
143 144 145 146 147 148
For ease of contract development, one further step is required:

```bash
make install
```

149 150
Now you can proceed to the next step - [Creating and launching a single-node testnet](#singlenode)

151
<a name="automacpublic"></a>
152
#### MacOS for the public testnet
153

154 155
Before running the script make sure you have installed/updated XCode. Note: The build script
will install homebrew if it is not already installed on you system. [Homebrew Website](https://brew.sh)
156

157
Then clone the EOS repository recursively, checkout the branch that is compatible with the public testnet, and run eosio_build.sh in the root `eos` folder.
158 159 160 161 162

```bash
git clone https://github.com/eosio/eos --recursive

cd eos
163

164
git checkout DAWN-2018-02-14
165
./eosio_build.sh
166 167
```

J
Jonathan Giszczak 已提交
168 169 170 171 172 173
For ease of contract development, one further step is required:

```bash
make install
```

174 175
Now you can proceed to the next step - [Running a node on the public testnet](#publictestnet)

S
Serg Metelin 已提交
176
<a name="runanode"></a>
177
## Building EOS and running a node
S
Serg Metelin 已提交
178

S
Serg Metelin 已提交
179
<a name="getcode"></a>
180
### Getting the code
S
Serg Metelin 已提交
181

182
To download all of the code, download EOS source code and a recursion or two of submodules. The easiest way to get all of this is to do a recursive clone:
N
Nathan Hourt 已提交
183

184 185 186
```bash
git clone https://github.com/eosio/eos --recursive
```
N
Nathan Hourt 已提交
187 188 189

If a repo is cloned without the `--recursive` flag, the submodules can be retrieved after the fact by running this command from within the repo:

190 191 192
```bash
git submodule update --init --recursive
```
N
Nathan Hourt 已提交
193

S
Serg Metelin 已提交
194
<a name="build"></a>
195
### Building from source code
196

197
```bash
S
Serg Metelin 已提交
198
cd ~
199
git clone https://github.com/eosio/eos --recursive
S
Serg Metelin 已提交
200
mkdir -p ~/eos/build && cd ~/eos/build
A
Alessandro Siniscalchi 已提交
201
cmake -DBINARYEN_BIN=~/binaryen/bin -DWASM_ROOT=~/wasm-compiler/llvm -DOPENSSL_ROOT_DIR=/usr/local/opt/openssl -DOPENSSL_LIBRARIES=/usr/local/opt/openssl/lib ..
202
make -j$( nproc )
203 204 205
```

Out-of-source builds are also supported. To override clang's default choice in compiler, add these flags to the CMake command:
N
Nathan Hourt 已提交
206 207 208 209 210

`-DCMAKE_CXX_COMPILER=/path/to/c++ -DCMAKE_C_COMPILER=/path/to/cc`

For a debug build, add `-DCMAKE_BUILD_TYPE=Debug`. Other common build types include `Release` and `RelWithDebInfo`.

211
To run the test suite after building, run the `chain_test` executable in the `tests` folder.
N
Nathan Hourt 已提交
212

S
Serg Metelin 已提交
213 214
EOS comes with a number of programs you can find in `~/eos/build/programs`. They are listed below:

215 216
* eosiod - server-side blockchain node component
* eosioc - command line interface to interact with the blockchain
217 218
* eosiowd - EOS wallet
* eosio-launcher - application for nodes network composing and deployment; [more on eosio-launcher](https://github.com/EOSIO/eos/blob/master/testnet.md)
S
Serg Metelin 已提交
219

S
Serg Metelin 已提交
220
<a name="singlenode"></a>
221
### Creating and launching a single-node testnet
S
Serg Metelin 已提交
222

223
After successfully building the project, the `eosiod` binary should be present in the `build/programs/eosiod` directory. Run `eosiod` -- it will probably exit with an error, but if not, close it immediately with <kbd>Ctrl-C</kbd>. If it exited with an error, note that `eosiod` created a directory named `data-dir` containing the default configuration (`config.ini`) and some other internals. This default data storage path can be overridden by passing `--data-dir /path/to/data` to `eosiod`.  These instructions will continue to use the default directory.
N
Nathan Hourt 已提交
224

225
Edit the `config.ini` file, adding/updating the following settings to the defaults already in place:
N
Nathan Hourt 已提交
226 227

```
N
Nathan Hourt 已提交
228 229
# Load the testnet genesis state, which creates some initial block producers with the default key
genesis-json = /path/to/eos/source/genesis.json
S
Sandwich 已提交
230
 # Enable production on a stale chain, since a single-node test chain is pretty much always stale
N
Nathan Hourt 已提交
231 232
enable-stale-production = true
# Enable block production with the testnet producers
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
producer-name = inita
producer-name = initb
producer-name = initc
producer-name = initd
producer-name = inite
producer-name = initf
producer-name = initg
producer-name = inith
producer-name = initi
producer-name = initj
producer-name = initk
producer-name = initl
producer-name = initm
producer-name = initn
producer-name = inito
producer-name = initp
producer-name = initq
producer-name = initr
producer-name = inits
producer-name = initt
producer-name = initu
S
Serg Metelin 已提交
254
# Load the block producer plugin, so you can produce blocks
P
Pravin 已提交
255
plugin = eosio::producer_plugin
S
Serg Metelin 已提交
256
# Wallet plugin
P
Pravin 已提交
257
plugin = eosio::wallet_api_plugin
S
Serg Metelin 已提交
258
# As well as API and HTTP plugins
P
Pravin 已提交
259 260
plugin = eosio::chain_api_plugin
plugin = eosio::http_plugin
N
Nathan Hourt 已提交
261 262
```

263
Now it should be possible to run `eosiod` and see it begin producing blocks.
peterwillcn's avatar
peterwillcn 已提交
264

265
When running `eosiod` you should get log messages similar to below. It means the blocks are successfully produced.
S
Serg Metelin 已提交
266 267 268 269 270 271

```
1575001ms thread-0   chain_controller.cpp:235      _push_block          ] initm #1 @2017-09-04T04:26:15  | 0 trx, 0 pending, exectime_ms=0
1575001ms thread-0   producer_plugin.cpp:207       block_production_loo ] initm generated block #1 @ 2017-09-04T04:26:15 with 0 trxs  0 pending
1578001ms thread-0   chain_controller.cpp:235      _push_block          ] initc #2 @2017-09-04T04:26:18  | 0 trx, 0 pending, exectime_ms=0
1578001ms thread-0   producer_plugin.cpp:207       block_production_loo ] initc generated block #2 @ 2017-09-04T04:26:18 with 0 trxs  0 pending
272
...
S
Serg Metelin 已提交
273
```
J
Jonathan Giszczak 已提交
274 275 276 277
<a name="nextsteps"></a>
### Next Steps

Further documentation is available in the [wiki](https://github.com/EOSIO/eos/wiki). Wiki pages include detailed reference documentation for all programs and tools and the database schema and API. The wiki also includes a section describing smart contract development. A simple walkthrough of the "currency" contract follows.
S
Serg Metelin 已提交
278

S
Sandwich 已提交
279
<a name="smartcontracts"></a>
S
Sandwich 已提交
280
## Example "Currency" Contract Walkthrough
S
Serg Metelin 已提交
281

282
EOS comes with example contracts that can be uploaded and run for testing purposes. Next we demonstrate how to upload and interact with the sample contract "currency".
S
Serg Metelin 已提交
283

S
Serg Metelin 已提交
284
<a name="smartcontractexample"></a>
S
Sandwich 已提交
285
### Example smart contracts
286

S
Sandwich 已提交
287
First, run the node
S
Serg Metelin 已提交
288

289
```bash
290 291
cd ~/eos/build/programs/eosiod/
./eosiod
S
Serg Metelin 已提交
292
```
293

S
Serg Metelin 已提交
294
<a name="walletimport"></a>
295
### Setting up a wallet and importing account key
S
Serg Metelin 已提交
296

297
As you've previously added `plugin = eosio::wallet_api_plugin` into `config.ini`, EOS wallet will be running as a part of `eosiod` process. Every contract requires an associated account, so first, create a wallet.
S
Serg Metelin 已提交
298

299
```bash
300 301
cd ~/eos/build/programs/eosioc/
./eosioc wallet create # Outputs a password that you need to save to be able to lock/unlock the wallet
S
Serg Metelin 已提交
302 303
```

304
For the purpose of this walkthrough, import the private key of the `inita` account, a test account included within genesis.json, so that you're able to issue API commands under authority of an existing account. The private key referenced below is found within your `config.ini` and is provided to you for testing purposes.
S
Sandwich 已提交
305

S
Sandwich 已提交
306
```bash
307
./eosioc wallet import 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3
S
Sandwich 已提交
308
```
S
Serg Metelin 已提交
309

S
Serg Metelin 已提交
310
<a name="createaccounts"></a>
S
Sandwich 已提交
311
### Creating accounts for sample "currency" contract
S
Serg Metelin 已提交
312

S
Sandwich 已提交
313
First, generate some public/private key pairs that will be later assigned as `owner_key` and `active_key`.
314

315
```bash
316 317 318
cd ~/eos/build/programs/eosioc/
./eosioc create key # owner_key
./eosioc create key # active_key
319 320
```

S
Sandwich 已提交
321
This will output two pairs of public and private keys
322 323 324

```
Private key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
325
Public key: EOSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
326 327
```

S
Sandwich 已提交
328
**Important:**
329 330
Save the values for future reference.

S
Sandwich 已提交
331
Run the `create` command where `inita` is the account authorizing the creation of the `currency` account and `PUBLIC_KEY_1` and `PUBLIC_KEY_2` are the values generated by the `create key` command
332

333
```bash
334
./eosioc create account inita currency PUBLIC_KEY_1 PUBLIC_KEY_2
335 336
```

337
You should then get a JSON response back with a transaction ID confirming it was executed successfully.
338

S
Sandwich 已提交
339
Go ahead and check that the account was successfully created
340

341
```bash
342
./eosioc get account currency
343 344
```

345
If all went well, you will receive output similar to the following:
346 347 348

```json
{
349 350
  "account_name": "currency",
  "eos_balance": "0.0000 EOS",
351
  "staked_balance": "0.0001 EOS",
352 353 354
  "unstaking_balance": "0.0000 EOS",
  "last_unstaking_time": "2035-10-29T06:32:22",
...
355 356
```

S
Sandwich 已提交
357
Now import the active private key generated previously in the wallet:
358 359

```bash
360
./eosioc wallet import XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
361 362
```

S
Serg Metelin 已提交
363
<a name="uploadsmartcontract"></a>
364
### Upload sample "currency" contract to blockchain
365

S
Sandwich 已提交
366
Before uploading a contract, verify that there is no current contract:
D
Daniel Larimer 已提交
367

368
```bash
369
./eosioc get code currency
D
Daniel Larimer 已提交
370 371 372
code hash: 0000000000000000000000000000000000000000000000000000000000000000
```

S
Sandwich 已提交
373
With an account for a contract created, upload a sample contract:
374

375
```bash
376
./eosioc set contract currency ../../contracts/currency/currency.wast ../../contracts/currency/currency.abi
S
Serg Metelin 已提交
377 378
```

379
As a response you should get a JSON with a `transaction_id` field. Your contract was successfully uploaded!
S
Serg Metelin 已提交
380

381
You can also verify that the code has been set with the following command:
D
Daniel Larimer 已提交
382

383
```bash
384
./eosioc get code currency
S
Sandwich 已提交
385 386
```

387
It will return something like:
S
Sandwich 已提交
388
```bash
D
Daniel Larimer 已提交
389 390 391
code hash: 9b9db1a7940503a88535517049e64467a6e8f4e9e03af15e9968ec89dd794975
```

392 393 394 395 396 397
Before using the currency contract, you must issue the currency.

```bash
./eosioc push action currency issue '{"to":"currency","quantity":"1000.0000 CUR"}' --permission currency@active
```

S
Sandwich 已提交
398
Next verify the currency contract has the proper initial balance:
D
Daniel Larimer 已提交
399

400
```bash
401
./eosioc get table currency currency account
D
Daniel Larimer 已提交
402 403
{
  "rows": [{
404 405
     "currency": 1381319428,
     "balance": 10000000
D
Daniel Larimer 已提交
406 407 408 409 410 411
     }
  ],
  "more": false
}
```

S
Serg Metelin 已提交
412
<a name="pushamessage"></a>
413
### Transfering funds with the sample "currency" contract
414

415
Anyone can send any message to any contract at any time, but the contracts may reject messages which are not given necessary permission. Messages are not sent "from" anyone, they are sent "with permission of" one or more accounts and permission levels. The following commands show a "transfer" message being sent to the "currency" contract.
S
Serg Metelin 已提交
416

417
The content of the message is `'{"from":"currency","to":"inita","quantity":"20.0000 CUR","memo":"any string"}'`. In this case we are asking the currency contract to transfer funds from itself to someone else. This requires the permission of the currency contract.
S
Serg Metelin 已提交
418

419
```bash
420
./eosioc push action currency transfer '{"from":"currency","to":"inita","quantity":"20.0000 CUR","memo":"my first transfer"}' --permission currency@active
D
Daniel Larimer 已提交
421 422
```

423
Below is a generalization that shows the `currency` account is only referenced once, to specify which contract to deliver the `transfer` message to.
424 425

```bash
426
./eosioc push action currency transfer '{"from":"${usera}","to":"${userb}","quantity":"20.0000 CUR","memo":""}' --permission ${usera}@active
427 428
```

429
As confirmation of a successfully submitted transaction, you will receive JSON output that includes a `transaction_id` field.
D
Daniel Larimer 已提交
430

S
Serg Metelin 已提交
431
<a name="readingcontract"></a>
S
Sandwich 已提交
432
### Reading sample "currency" contract balance
433

434
So now check the state of both of the accounts involved in the previous transaction.
D
Daniel Larimer 已提交
435

436
```bash
437
./eosioc get table inita currency account
D
Daniel Larimer 已提交
438 439
{
  "rows": [{
440 441
      "currency": 1381319428,
      "balance": 200000
D
Daniel Larimer 已提交
442 443 444 445
       }
    ],
  "more": false
}
446
./eosioc get table currency currency account
D
Daniel Larimer 已提交
447 448
{
  "rows": [{
449 450
      "currency": 1381319428,
      "balance": 9800000
D
Daniel Larimer 已提交
451 452 453 454
    }
  ],
  "more": false
}
S
Serg Metelin 已提交
455 456
```

457
As expected, the receiving account **inita** now has a balance of **20** tokens, and the sending account now has **20** less tokens than its initial supply.
S
Sandwich 已提交
458

S
Serg Metelin 已提交
459
<a name="localtestnet"></a>
460
## Running multi-node local testnet
S
Serg Metelin 已提交
461

462
To run a local testnet you can use the `eosio-launcher` application provided in the `~/eos/build/programs/eosio-launcher` folder.
S
Serg Metelin 已提交
463

464
For testing purposes you will run two local production nodes talking to each other.
S
Serg Metelin 已提交
465

466
```bash
S
Serg Metelin 已提交
467 468
cd ~/eos/build
cp ../genesis.json ./
469
./programs/eosio-launcher/eosio-launcher -p2 --skip-signature
S
Serg Metelin 已提交
470 471
```

472
This command will generate two data folders for each instance of the node: `tn_data_00` and `tn_data_01`.
S
Serg Metelin 已提交
473

474
You should see the following response:
S
Serg Metelin 已提交
475

476
```bash
477 478
spawning child, programs/eosiod/eosiod --skip-transaction-signatures --data-dir tn_data_0
spawning child, programs/eosiod/eosiod --skip-transaction-signatures --data-dir tn_data_1
S
Serg Metelin 已提交
479 480
```

481
To confirm the nodes are running, run the following `eosioc` commands:
482
```bash
483 484 485
~/eos/build/programs/eosioc
./eosioc -p 8888 get info
./eosioc -p 8889 get info
S
Serg Metelin 已提交
486 487
```

488
For each command, you should get a JSON response with blockchain information.
S
Serg Metelin 已提交
489

490
You can read more on eosio-launcher and its settings [here](https://github.com/EOSIO/eos/blob/master/testnet.md)
S
Serg Metelin 已提交
491

492 493 494 495 496 497 498 499 500 501 502 503 504 505 506
<a name="publictestnet"></a>
## Running a local node connected to the public testnet

To run a local node connected to the public testnet operated by block.one, a script is provided.

```bash
cd ~/eos/build/scripts
./start_npnode.sh
```

This command will use the data folder provided for the instance called `testnet_np`.

You should see the following response:

```bash
507 508
Launched eosd.
See testnet_np/stderr.txt for eosd output.
509 510 511
Synching requires at least 8 minutes, depending on network conditions.
```

512
To confirm eosd operation and synchronization:
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533

```bash
tail -F testnet_np/stderr.txt
```

To exit tail, use Ctrl-C.  During synchronization, you will see log messages similar to:

```bash
3439731ms            chain_plugin.cpp:272          accept_block         ] Syncing Blockchain --- Got block: #200000 time: 2017-12-09T07:56:32 producer: initu
3454532ms            chain_plugin.cpp:272          accept_block         ] Syncing Blockchain --- Got block: #210000 time: 2017-12-09T13:29:52 producer: initc
```

Synchronization is complete when you see log messages similar to:

```bash
42467ms            net_plugin.cpp:1245           start_sync           ] Catching up with chain, our last req is 351734, theirs is 351962 peer ip-10-160-11-116:9876
42792ms            chain_controller.cpp:208      _push_block          ] initt #351947 @2017-12-12T22:59:44  | 0 trx, 0 pending, exectime_ms=0
42793ms            chain_controller.cpp:208      _push_block          ] inito #351948 @2017-12-12T22:59:46  | 0 trx, 0 pending, exectime_ms=0
42793ms            chain_controller.cpp:208      _push_block          ] initd #351949 @2017-12-12T22:59:48  | 0 trx, 0 pending, exectime_ms=0
```

534 535
This eosd instance listens on 127.0.0.1:8888 for http requests, on all interfaces at port 9877
for p2p requests, and includes the wallet plugins.
536

S
Serg Metelin 已提交
537
<a name="doxygen"></a>
538
## Doxygen documentation
S
Serg Metelin 已提交
539

540 541 542
You can find more detailed API documentation in the Doxygen reference.
For the `master` branch: https://eosio.github.io/eos/
For the public testnet branch: http://htmlpreview.github.io/?https://github.com/EOSIO/eos/blob/dawn-2.x/docs/index.html
S
Serg Metelin 已提交
543

S
Serg Metelin 已提交
544
<a name="docker"></a>
545
## Running EOS in Docker
peterwillcn's avatar
peterwillcn 已提交
546

547 548 549
You can find up to date information about EOS Docker in the [Docker Readme](https://github.com/EOSIO/eos/blob/master/Docker/README.md)

<a name="manualdep"></a>
550
## Manual installation of the dependencies
551

552
If you prefer to manually build dependencies, follow the steps below.
553 554 555 556 557 558 559

This project is written primarily in C++14 and uses CMake as its build system. An up-to-date Clang and the latest version of CMake is recommended.

Dependencies:

* Clang 4.0.0
* CMake 3.5.1
560
* Boost 1.66
561 562 563 564
* OpenSSL
* LLVM 4.0
* [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git)

565
<a name="manualdepamazon"></a>
566
### Clean install Amazon 2017.09 and higher
567 568 569 570

Install the development toolkit:

```bash
571 572 573 574 575 576
sudo yum update
sudo yum install git gcc72.x86_64 gcc72-c++.x86_64 autoconf automake libtool make bzip2 \
				 bzip2-devel.x86_64 openssl-devel.x86_64 gmp.x86_64 gmp-devel.x86_64 \
				 libstdc++72.x86_64 python27-devel.x86_64 libedit-devel.x86_64 \
				 ncurses-devel.x86_64 swig.x86_64 gettext-devel.x86_64

577 578
```

579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
Install CMake 3.10.2:

```bash
cd ~
curl -L -O https://cmake.org/files/v3.10/cmake-3.10.2.tar.gz
tar xf cmake-3.10.2.tar.gz
rm -f cmake-3.10.2.tar.gz
ln -s cmake-3.10.2/ cmake
cd cmake
./bootstrap
make
sudo make install
```

Install Boost 1.66:

```bash
cd ~
curl -L https://dl.bintray.com/boostorg/release/1.66.0/source/boost_1_66_0.tar.bz2 > boost_1.66.0.tar.bz2
tar xf boost_1.66.0.tar.bz2
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
source ~/.bash_profile
cd boost_1_66_0/
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
```

Install [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git):

```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
make -j$( nproc )
sudo make install
```

By default LLVM and clang do not include the WASM build target, so you will have to build it yourself:

```bash
mkdir  ~/wasm-compiler
cd ~/wasm-compiler
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/llvm.git
cd llvm/tools
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/clang.git
cd ..
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=.. -DLLVM_TARGETS_TO_BUILD= -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly -DCMAKE_BUILD_TYPE=Release ../
make -j$( nproc ) 
make install
```

Your environment is set up. Now you can <a href="#runanode">build EOS and run a node</a>.

<a name="manualdepcentos"></a>
### Clean install Centos 7 and higher

Install the development toolkit:
640 641 642
* Installation on Centos requires installing/enabling the Centos Software Collections
Repository.
[Centos SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL):
643 644 645 646 647 648 649

```bash
sudo yum --enablerepo=extras install centos-release-scl
sudo yum update
sudo yum install -y devtoolset-7
scl enable devtoolset-7 bash
sudo yum install git autoconf automake libtool make bzip2 \
650
				 bzip2-devel.x86_64 openssl-devel.x86_64 gmp-devel.x86_64 \
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
				 ocaml.x86_64 doxygen libicu-devel.x86_64 python27-devel.x86_64 \
				 gettext-devel.x86_64

```

Install CMake 3.10.2:

```bash
cd ~
curl -L -O https://cmake.org/files/v3.10/cmake-3.10.2.tar.gz
tar xf cmake-3.10.2.tar.gz
cd cmake-3.10.2
./bootstrap
make -j$( nproc )
sudo make install
```

668
Install Boost 1.66:
669 670 671

```bash
cd ~
672 673
curl -L https://dl.bintray.com/boostorg/release/1.66.0/source/boost_1_66_0.tar.bz2 > boost_1.66.0.tar.bz2
tar xf boost_1.66.0.tar.bz2
674
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
675
source ~/.bash_profile
676
cd boost_1_66_0/
677 678 679 680 681
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
```

Install [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git):
682

683 684 685 686 687 688
```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
689
make -j$( nproc )
690 691 692 693 694 695 696 697 698 699 700 701 702 703 704
sudo make install
```

By default LLVM and clang do not include the WASM build target, so you will have to build it yourself:

```bash
mkdir  ~/wasm-compiler
cd ~/wasm-compiler
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/llvm.git
cd llvm/tools
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/clang.git
cd ..
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=.. -DLLVM_TARGETS_TO_BUILD= -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly -DCMAKE_BUILD_TYPE=Release ../
705 706
make -j$( nproc ) 
make install
707
```
708

709
Your environment is set up. Now you can <a href="#runanode">build EOS and run a node</a>.
710

711
<a name="manualdepfedora"></a>
712
### Clean install Fedora 25 and higher
713

714
Install the development toolkit:
715 716

```bash
717 718
sudo yum update
sudo yum install git gcc.x86_64 gcc-c++.x86_64 autoconf automake libtool make cmake.x86_64 \
719 720 721
				 bzip2-devel.x86_64 openssl-devel.x86_64 gmp-devel.x86_64 \
				 libstdc++-devel.x86_64 python3-devel.x86_64 libedit.x86_64 \
				 ncurses-devel.x86_64 swig.x86_64 gettext-devel.x86_64
722 723 724

```

725
Install Boost 1.66:
726 727

```bash
728 729 730 731 732 733 734 735
cd ~
curl -L https://dl.bintray.com/boostorg/release/1.66.0/source/boost_1_66_0.tar.bz2 > boost_1.66.0.tar.bz2
tar xf boost_1.66.0.tar.bz2
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
source ~/.bash_profile
cd boost_1_66_0/
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
736 737 738
```

Install [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git):
739

740 741 742 743 744 745
```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
746
make -j$( nproc )
747 748 749
sudo make install
```

750
By default LLVM and clang do not include the WASM build target, so you will have to build it yourself:
751 752 753 754 755 756 757 758 759 760 761

```bash
mkdir  ~/wasm-compiler
cd ~/wasm-compiler
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/llvm.git
cd llvm/tools
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/clang.git
cd ..
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=.. -DLLVM_TARGETS_TO_BUILD= -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly -DCMAKE_BUILD_TYPE=Release ../
762
make -j$( nproc ) install
763 764
```

765
Your environment is set up. Now you can <a href="#runanode">build EOS and run a node</a>.
766

767
<a name="manualdepubuntu"></a>
768
### Clean install Ubuntu 16.04 & Higher
769 770 771 772

Install the development toolkit:

```bash
773 774 775 776 777 778 779
sudo apt-get update
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key|sudo apt-key add -
sudo apt-get install clang-4.0 lldb-4.0 libclang-4.0-dev cmake make \
                     libbz2-dev libssl-dev libgmp3-dev \
                     autotools-dev build-essential \
                     libbz2-dev libicu-dev python-dev \
                     autoconf libtool git
780 781 782 783 784 785
```

Install Boost 1.66:

```bash
cd ~
786
wget -c 'https://sourceforge.net/projects/boost/files/boost/1.66.0/boost_1_66_0.tar.bz2/download' -O boost_1.66.0.tar.bz2
787 788
tar xjf boost_1.66.0.tar.bz2
cd boost_1_66_0/
789
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
790 791 792
source ~/.bash_profile
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
793
source ~/.bash_profile
794 795 796 797 798 799 800 801 802 803
```

Install [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git):

```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
804
make
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
sudo make install
```

By default LLVM and clang do not include the WASM build target, so you will have to build it yourself:

```bash
mkdir  ~/wasm-compiler
cd ~/wasm-compiler
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/llvm.git
cd llvm/tools
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/clang.git
cd ..
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=.. -DLLVM_TARGETS_TO_BUILD= -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly -DCMAKE_BUILD_TYPE=Release ../
820
make -j4 install
821
```
822

823 824
Your environment is set up. Now you can <a href="#runanode">build EOS and run a node</a>.

825
<a name="manualdepmacos"></a>
826
### MacOS Sierra 10.12.6 & higher
827

828 829 830 831 832 833
macOS additional Dependencies:

* Brew
* Newest XCode

Upgrade your XCode to the newest version:
834 835

```bash
836 837 838 839
xcode-select --install
```

Install homebrew:
840

841 842
```bash
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
843 844
```

845
Install the dependencies:
846 847

```bash
848 849 850
brew update
brew install git automake libtool boost openssl llvm@4 gmp ninja gettext
brew link gettext --force
851 852 853 854 855 856 857 858 859 860
```

Install [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git):

```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
861
make -j$( sysctl -in machdep.cpu.core_count )
862 863 864
sudo make install
```

865
Build LLVM and clang for WASM:
866 867 868 869 870 871 872 873 874 875 876

```bash
mkdir  ~/wasm-compiler
cd ~/wasm-compiler
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/llvm.git
cd llvm/tools
git clone --depth 1 --single-branch --branch release_40 https://github.com/llvm-mirror/clang.git
cd ..
mkdir build
cd build
cmake -G "Unix Makefiles" -DCMAKE_INSTALL_PREFIX=.. -DLLVM_TARGETS_TO_BUILD= -DLLVM_EXPERIMENTAL_TARGETS_TO_BUILD=WebAssembly -DCMAKE_BUILD_TYPE=Release ../
877
make -j$( sysctl -in machdep.cpu.core_count )
878 879 880
make install
```

881
Your environment is set up. Now you can <a href="#runanode">build EOS and run a node</a>.