Skip to content

Commit

Permalink
Merge pull request #169 from EOSIO/develop
Browse files Browse the repository at this point in the history
Merge Develop
  • Loading branch information
dixia authored Mar 17, 2020
2 parents 449e834 + ed03778 commit efc1a65
Show file tree
Hide file tree
Showing 13 changed files with 277 additions and 36 deletions.
13 changes: 12 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"options": {
"docs_dir": "docs",
"disable_indices": true,
"exclude": ["get-involved"]
"exclude": ["get-involved", "05_community-developer-tools"]
}
},
{
Expand All @@ -33,6 +33,17 @@
"directory_nav_parent": "Resources"
}
},


{
"name": "collate_markdown",
"options": {
"docs_dir": "docs/05_community-developer-tools",
"output_dir": "05_community-developer-tools"
}
},


{
"name": "collate_markdown",
"options": {
Expand Down
2 changes: 1 addition & 1 deletion docs/02_getting-started/01_try-eosio.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ If you do not want to install `EOSIO` binaries on your local machine, or if you
You can give it a try in a matter of seconds [right now](https://gitpod.io/#https://github.com/EOSIO/eosio-web-ide) and you can read more details about it [on the eosio-web-ide project page](https://github.com/EOSIO/eosio-web-ide).

## What's Next?
- [Getting Started](./02_development-environment/02_introduction.md): Install EOSIO in your local development environment.
- [Get Started](./02_development-environment/02_introduction.md): Install EOSIO in your local development environment.
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,16 @@ info 2018-11-26T06:54:24.796 thread-0 http_plugin.cpp:554 add_handle
```
Press enter to continue

**Troubleshooting**

After entering `keosd &`, you may encounter this message:

```shell
"3120000 wallet_exception: Wallet exception Failed to lock access to wallet directory; is another keosd running?"
```

This is because another instance of `keosd` process might be running in the background. Kill all instances by `pkill keosd` and rerun `keosd &`.

### Step 1.2: Start nodeos

Start nodeos now:
Expand Down Expand Up @@ -52,9 +62,9 @@ These settings accomplish the following:
[[warning]]
| In the above configuration, CORS is enabled for `*` **for development purposes only**, you should **never** enable CORS for `*` on a node that is publicly accessible!

### Troubleshooting
**Troubleshooting**

If in the previous step, after starting `nodeos`, you see an error message similar to "Database dirty flag set (likely due to unclean shutdown): replay required" try to start `nodeos` with `--replay-blockchain`. More details on troubleshooting `nodeos` can be found [here](https://developers.eos.io/manuals/eos/latest/nodeos/troubleshooting/index).
After starting `nodeos`, if you see an error message similar to "Database dirty flag set (likely due to unclean shutdown): replay required", try to start `nodeos` with `--replay-blockchain`. More details on troubleshooting `nodeos` can be found [here](https://developers.eos.io/manuals/eos/latest/nodeos/troubleshooting/index).

## Step 2: Check the installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ It should return
},{
"key": "bob",
"first_name": "bob",
"last_name": "is a loser",
"last_name": "is a guy",
"age": 49,
"street": "doesnt exist",
"city": "somewhere",
Expand Down
9 changes: 7 additions & 2 deletions docs/02_getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
## Topics Covered in Getting Started
---
content_title: "Getting Started"
link_text: "Get Started"
---

- Installing eosio.cdt
- Using Keosd as a local development wallet
- Starting the Nodeos daemon
Expand All @@ -10,5 +14,6 @@
- Payable actions using EOSIO `notify` declarations

## What's next?

- [Try EOSIO](./01_try-eosio.md): Try EOSIO in your browser with Gitpod.
- [Getting Started](./02_development-environment/introduction.md): Install EOSIO in your local development environment.
- [Get Started](./02_development-environment/introduction.md): Install EOSIO in your local development environment.
4 changes: 1 addition & 3 deletions docs/03_tutorials/bios-boot-sequence.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@ Alternatively, if you would like to automate these steps, you can use the [bios-

If your goal is to go beyond and understand what the script is doing, you can follow this tutorial which will get you through the same steps explaining also along the way each step needed to go through.


### 1.1. Install the binaries

**Pre-compiled EOSIO Binaries**


For instructions to install the `nodeos` binaries, see the [Install EOSIO pre-compiled binaries](https://developers.eos.io/manuals/eos/latest/install/install-prebuilt-binaries) tutorial but do not start `nodeos` at this stage.

**EOSIO.CDT Binaries**
Expand Down Expand Up @@ -931,4 +929,4 @@ You can test various commands, create accounts, check balance on accounts, trans
For commands on creating new accounts, see the [`Create test accounts`](../02_getting-started/02_development-environment/07_create-test-accounts.md) tutorial.

For commands on issuing, allocating and transferring token between accounts, see the
[`Deploy, Issue and Transfer Tokens`getting-started/smart-contract-development/deploy-issue-and-transfer-tokens) tutorial.
[`Deploy, Issue and Transfer Tokens`](../02_getting-started/03_smart-contract-development/02_deploy-issue-and-transfer-tokens.md) section.
28 changes: 14 additions & 14 deletions docs/04_protocol/01_consensus_protocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,21 +148,21 @@ As an inter-chained sequence of blocks, the fundamental unit within the blockcha

Name | Type | Description
-|-|-
`timestamp` | `block_timestamp_type` | block creation time (before any transactions are included)
`timestamp` | `block_timestamp_type` | expected time slot this block is produced (ends in .000 or .500 seconds)
`producer` | `name` | account name for producer of this block
`confirmed` | `uint16_t` | non-zero if block confirmed by producer of this block
`previous` | `block_id_type` | block ID of the previous block
`transaction_mroot` | `checksum256_type` | merkle tree root hash of transaction receipts
`action_mroot` | `checksum256_type` | merkle tree root hash of action receipts
`schedule_version` | `uint32_t` | increments when new producer schedule is confirmed for next schedule round (must be `0`; field moved to `new_producers`)
`new_producers` | `producer_schedule_type` | holds schedule version, producer names and keys for new producer schedule (included in first block of schedule round)
`header_extensions` | `extensions_type` | extends header fields to support additional features
`producer_signature` | `signature_type` | digital signature from producer that created and signed block
`confirmed` | `uint16_t` | number of prior blocks confirmed by the producer of this block in current producer schedule
`previous` | `block_id_type` | block ID for previous block
`transaction_mroot` | `checksum256_type` | merkle tree root hash of transaction receipts included in block
`action_mroot` | `checksum256_type` | merkle tree root hash of action receipts included in block
`schedule_version` | `uint32_t` | number of times producer schedule has changed since genesis
`new_producers` | `producer_schedule_type` | holds producer names and keys for new proposed producer schedule; null if no change
`header_extensions` | `extensions_type` | extends block fields to support additional features (included in block ID calculation)
`producer_signature` | `signature_type` | digital signature by producer that created and signed block
`transactions` | array of `transaction_receipt` | list of valid transaction receipts included in block
`block_extensions` | `extension_type` | extends header fields to support additional features
`id` | `uint64_t` | UUID of this block ID (a function of block header and block number); can be used to query a transaction within the block
`block_num` | `uint32_t` | block number (sequential counter value since genesis block 0)
`ref_block_prefix` | `uint32_t` | lower 32 bits of `id`; used to prevent replay attacks
`block_extensions` | `extension_type` | extends block fields to support additional features (NOT included in block ID calculation)
`id` | `uint64_t` | UUID of this block ID (a function of block header and block number); can be used to query block for validation/retrieval purposes
`block_num` | `uint32_t` | block number (sequential counter value since genesis block 0); can be used to query block for validation/retrieval purposes
`ref_block_prefix` | `uint32_t` | lower 32 bits of block ID; used to prevent replay attacks

Some of the block fields are known in advance when the block is created, so they are added during block initialization. Others are computed and added during block finalization, such as the merkle root hashes for transactions and actions, the block number and block ID, the signature of the producer that created and signed the block, etc. (see [Network Peer Protocol: 3.1. Block ID](03_network_peer_protocol.md#31-block-id))

Expand Down Expand Up @@ -195,7 +195,7 @@ After the transactions have been pushed into the block and the block is finalize

### 5.2.4. Commit Block

After the block is signed, it is committed to the local chain. This pushes the block to the reversible block database (see [Network Peer Protocol: 2.2.1. Fork Database](03_network_peer_protocol.md#221-fork-database)). This makes the block available for syncing with other nodes for validation (see the [Network Peer Protocol](03_network_peer_protocol.md) for more information about block syncing).
After the block is signed, it is committed to the local chain. This pushes the block to the reversible block database (see [Network Peer Protocol: 2.2.3. Fork Database](03_network_peer_protocol.md#223-fork-database)). This makes the block available for syncing with other nodes for validation (see the [Network Peer Protocol](03_network_peer_protocol.md) for more information about block syncing).


## 5.3. Block Validation
Expand Down
Loading

0 comments on commit efc1a65

Please sign in to comment.