README.md 30.1 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
1. Amazon 2017.09 and higher.  
2. Fedora 25 and higher (Fedora 27 recommended).  
19
3. Ubuntu 16.04 (Ubuntu 16.10 recommended).  
20
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, Mint, & Ubuntu) for a local testnet](#autoubuntulocal)
      2. [Clean install Linux (Amazon, Centos, Fedora, Mint, & 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
   2. [Clean install Centos 7 and higher](#manualdepcentos)
   3. [Clean install Fedora 25 and higher](#manualdepfedora)
61 62
   4. [Clean install Mint 18](#manualdepubuntu)
   4. [Clean install Ubuntu 16](#manualdepubuntu)
63
   5. [Clean install MacOS Sierra 10.12 and higher](#manualdepmacos)
64

S
Serg Metelin 已提交
65 66
<a name="gettingstarted"></a>
## Getting Started
67
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 已提交
68

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

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

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

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

86
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.
87

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

90
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.
91

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

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

cd eos
99
./eosio_build.sh
100 101
```

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

```bash
sudo make install
```

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

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

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

cd eos
117

118
git checkout DAWN-2018-02-14
119
./eosio_build.sh
120 121
```

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

```bash
sudo make install
```

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

<a name="automaclocal"></a>
131
#### :no_entry: MacOS for a local testnet :no_entry:
132

133 134
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)
135

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

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

cd eos
142
./eosio_build.sh
143 144
```

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

```bash
make install
```

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

153
<a name="automacpublic"></a>
154
#### MacOS for the public testnet
155

156 157
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)
158

159
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.
160 161 162 163 164

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

cd eos
165

166
git checkout DAWN-2018-02-14
167
./eosio_build.sh
168 169
```

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

```bash
make install
```

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

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

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

184
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 已提交
185

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

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:

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

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

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

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 已提交
208 209 210 211 212

`-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`.

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

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

217 218
* eosiod - server-side blockchain node component
* eosioc - command line interface to interact with the blockchain
219 220
* 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 已提交
221

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

225
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 已提交
226

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

```
N
Nathan Hourt 已提交
230 231
# 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 已提交
232
 # Enable production on a stale chain, since a single-node test chain is pretty much always stale
N
Nathan Hourt 已提交
233 234
enable-stale-production = true
# Enable block production with the testnet producers
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
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 已提交
256
# Load the block producer plugin, so you can produce blocks
P
Pravin 已提交
257
plugin = eosio::producer_plugin
S
Serg Metelin 已提交
258
# Wallet plugin
P
Pravin 已提交
259
plugin = eosio::wallet_api_plugin
S
Serg Metelin 已提交
260
# As well as API and HTTP plugins
P
Pravin 已提交
261 262
plugin = eosio::chain_api_plugin
plugin = eosio::http_plugin
N
Nathan Hourt 已提交
263 264
```

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

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

```
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
274
...
S
Serg Metelin 已提交
275
```
J
Jonathan Giszczak 已提交
276 277 278 279
<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 已提交
280

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

284
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 已提交
285

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

S
Sandwich 已提交
289
First, run the node
S
Serg Metelin 已提交
290

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

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

299
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 已提交
300

301
```bash
302 303
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 已提交
304 305
```

306
For the purpose of this walkthrough, import the private key of the `eosio` 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 已提交
307

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

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

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

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

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

```
Private key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
327
Public key: EOSXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
328 329
```

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

333
Run the `create` command where `eosio` 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
334

335
```bash
336
./eosioc create account eosio currency PUBLIC_KEY_1 PUBLIC_KEY_2
337 338
```

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

S
Sandwich 已提交
341
Go ahead and check that the account was successfully created
342

343
```bash
344
./eosioc get account currency
345 346
```

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

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

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

```bash
362
./eosioc wallet import XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
363 364
```

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

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

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

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

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

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

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

385
```bash
386
./eosioc get code currency
S
Sandwich 已提交
387 388
```

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

394 395 396 397 398 399
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 已提交
400
Next verify the currency contract has the proper initial balance:
D
Daniel Larimer 已提交
401

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

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

417
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 已提交
418

419
The content of the message is `'{"from":"currency","to":"eosio","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 已提交
420

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

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

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

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

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

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

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

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

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

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

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

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

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

476
You should see the following response:
S
Serg Metelin 已提交
477

478
```bash
479 480
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 已提交
481 482
```

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

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

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

494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
<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
509 510
Launched eosd.
See testnet_np/stderr.txt for eosd output.
511 512 513
Synching requires at least 8 minutes, depending on network conditions.
```

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

```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
```

536 537
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.
538

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

542 543 544
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 已提交
545

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

549 550 551
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>
552
## Manual installation of the dependencies
553

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

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
562
* Boost 1.66
563 564 565 566
* OpenSSL
* LLVM 4.0
* [secp256k1-zkp (Cryptonomex branch)](https://github.com/cryptonomex/secp256k1-zkp.git)

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

Install the development toolkit:

```bash
573 574 575 576 577 578
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

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 640 641
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:
642 643 644
* Installation on Centos requires installing/enabling the Centos Software Collections
Repository.
[Centos SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL):
645 646 647 648 649 650 651

```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 \
652
				 bzip2-devel.x86_64 openssl-devel.x86_64 gmp-devel.x86_64 \
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
				 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
```

670
Install Boost 1.66:
671 672 673

```bash
cd ~
674 675
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
676
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
677
source ~/.bash_profile
678
cd boost_1_66_0/
679 680 681 682 683
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
```

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

685 686 687 688 689 690
```bash
cd ~
git clone https://github.com/cryptonomex/secp256k1-zkp.git
cd secp256k1-zkp
./autogen.sh
./configure
691
make -j$( nproc )
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706
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 ../
707 708
make -j$( nproc ) 
make install
709
```
710

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

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

716
Install the development toolkit:
717 718

```bash
719 720
sudo yum update
sudo yum install git gcc.x86_64 gcc-c++.x86_64 autoconf automake libtool make cmake.x86_64 \
721 722 723
				 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
724 725 726

```

727
Install Boost 1.66:
728 729

```bash
730 731 732 733 734 735 736 737
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
738 739 740
```

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

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

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

```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 ../
764
make -j$( nproc ) install
765 766
```

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

769
<a name="manualdepubuntu"></a>
770
### Clean install Ubuntu 16.04 & Linux Mint 18
771 772 773 774

Install the development toolkit:

```bash
775 776 777 778 779 780
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 \
781
                     autoconf libtool git mongodb
782 783 784 785 786 787
```

Install Boost 1.66:

```bash
cd ~
788
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
789 790
tar xjf boost_1.66.0.tar.bz2
cd boost_1_66_0/
791
echo "export BOOST_ROOT=$HOME/boost_1_66_0" >> ~/.bash_profile
792 793 794
source ~/.bash_profile
./bootstrap.sh "--prefix=$BOOST_ROOT"
./b2 install
795
source ~/.bash_profile
796 797
```

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
Install MongoDB C++ driver:

```bash
cd ~
curl -LO https://github.com/mongodb/mongo-c-driver/releases/download/1.9.3/mongo-c-driver-1.9.3.tar.gz
tar xf mongo-c-driver-1.9.3.tar.gz
cd mongo-c-driver-1.9.3
./configure --enable-ssl=openssl --disable-automatic-init-and-cleanup --prefix=/usr/local
make -j$( nproc )
sudo make install
git clone https://github.com/mongodb/mongo-cxx-driver.git --branch releases/stable --depth 1
cd mongo-cxx-driver/build
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local ..
sudo make -j$( nproc )
```

814 815 816 817 818 819 820 821
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
822
make
823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
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 ../
838
make -j4 install
839
```
840

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

843
<a name="manualdepmacos"></a>
844
### MacOS Sierra 10.12.6 & higher
845

846 847 848 849 850 851
macOS additional Dependencies:

* Brew
* Newest XCode

Upgrade your XCode to the newest version:
852 853

```bash
854 855 856 857
xcode-select --install
```

Install homebrew:
858

859 860
```bash
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
861 862
```

863
Install the dependencies:
864 865

```bash
866 867 868
brew update
brew install git automake libtool boost openssl llvm@4 gmp ninja gettext
brew link gettext --force
869 870 871 872 873 874 875 876 877 878
```

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
879
make -j$( sysctl -in machdep.cpu.core_count )
880 881 882
sudo make install
```

883
Build LLVM and clang for WASM:
884 885 886 887 888 889 890 891 892 893 894

```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 ../
895
make -j$( sysctl -in machdep.cpu.core_count )
896 897 898
make install
```

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