Minimal parachains part 2: Parachain statement and data routing (#173)

* dynamic inclusion threshold calculator

* collators interface

* collation helpers

* initial proposal-creation future

* create proposer when asked to propose

* remove local_availability duty

* statement table tracks includable parachain count

* beginnings of timing future

* finish proposal logic

* remove stray println

* extract shared table to separate module

* change ordering

* includability tracking

* fix doc

* initial changes to parachains module

* initialise dummy block before API calls

* give polkadot control over round proposer based on random seed

* propose only after enough candidates

* flesh out parachains module a bit more

* set_heads

* actually introduce set_heads to runtime

* update block_builder to accept parachains

* split block validity errors from real errors in evaluation

* update WASM runtimes

* polkadot-api methods for parachains additions

* delay evaluation until candidates are ready

* comments

* fix dynamic inclusion with zero initial

* test for includability tracker

* wasm validation of parachain candidates

* move primitives to primitives crate

* remove runtime-std dependency from codec

* adjust doc

* polkadot-parachain-primitives

* kill legacy polkadot-validator crate

* basic-add test chain

* test for basic_add parachain

* move to test-chains dir

* use wasm-build

* new wasm directory layout

* reorganize a bit more

* Fix for rh-minimal-parachain (#141)

* Remove extern "C"

We already encountered such behavior (bug?) in pwasm-std, I believe.

* Fix `panic_fmt` signature by adding `_col`

Wrong `panic_fmt` signature can inhibit some optimizations in LTO mode.

* Add linker flags and use wasm-gc in build script

Pass --import-memory to LLD to emit wasm binary with imported memory.

Also use wasm-gc instead of wasm-build.

* Fix effective_max.

I'm not sure why it was the way it was actually.

* Recompile wasm.

* Fix indent

* more basic_add tests

* validate parachain WASM

* produce statements on receiving statements

* tests for reactive statement production

* fix build

* add OOM lang item to runtime-io

* use dynamic_inclusion when evaluating as well

* fix update_includable_count

* remove dead code

* grumbles

* actually defer round_proposer logic

* update wasm

* address a few more grumbles

* schedule collation work as soon as BFT is started

* impl future in collator

* fix comment

* governance proposals for adding and removing parachains

* bump protocol version

* tear out polkadot-specific pieces of substrate-network

* extract out polkadot-specific stuff from substrate-network

* begin polkadot network subsystem

* grumbles

* update WASM checkins

* parse status from polkadot peer

* allow invoke of network specialization

* begin statement router implementation

* remove dependency on tokio-timer

* fix sanity check and have proposer factory create communication streams

* pull out statement routing from consensus library

* fix comments

* adjust typedefs

* extract consensus_gossip out of main network protocol handler

* port substrate-bft to new tokio

* port polkadot-consensus to new tokio

* fix typo

* start message processing task

* initial consensus network implementation

* remove known tracking from statement-table crate

* extract router into separate module

* defer statements until later

* double signature is invalid

* propagating statements

* grumbles

* request block data

* fix compilation

* embed new consensus network into service

* port demo CLI to tokio

* all test crates compile

* some tests for fetching block data

* whitespace

* adjusting some tokio stuff

* update exit-future

* remove overly noisy warning

* clean up collation work a bit

* address review grumbles

* fix lock order in protocol handler

* rebuild wasm artifacts

* tag AuthorityId::from_slice for std only

* address formatting grumbles

* rename event_loop to executor

* some more docs for polkadot-network crate
This commit is contained in:
Robert Habermeier
2018-07-06 14:17:03 +02:00
committed by GitHub
parent 5355956314
commit be5ff4e62f
62 changed files with 3424 additions and 2134 deletions
+47 -24
View File
@@ -321,7 +321,7 @@ dependencies = [
"substrate-rpc-servers 0.1.0", "substrate-rpc-servers 0.1.0",
"substrate-runtime-io 0.1.0", "substrate-runtime-io 0.1.0",
"substrate-state-machine 0.1.0", "substrate-state-machine 0.1.0",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"triehash 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", "triehash 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
@@ -618,7 +618,7 @@ dependencies = [
[[package]] [[package]]
name = "exit-future" name = "exit-future"
version = "0.1.0" version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [ dependencies = [
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -1409,6 +1409,7 @@ dependencies = [
"ed25519 0.1.0", "ed25519 0.1.0",
"env_logger 0.4.3 (registry+https://github.com/rust-lang/crates.io-index)", "env_logger 0.4.3 (registry+https://github.com/rust-lang/crates.io-index)",
"error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)", "error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)",
"exit-future 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"fdlimit 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)", "fdlimit 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
"lazy_static 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)", "lazy_static 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -1432,7 +1433,7 @@ dependencies = [
"substrate-state-machine 0.1.0", "substrate-state-machine 0.1.0",
"substrate-telemetry 0.2.0", "substrate-telemetry 0.2.0",
"time 0.1.40 (registry+https://github.com/rust-lang/crates.io-index)", "time 0.1.40 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"triehash 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", "triehash 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
@@ -1454,7 +1455,7 @@ version = "0.1.0"
dependencies = [ dependencies = [
"ed25519 0.1.0", "ed25519 0.1.0",
"error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)", "error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)",
"exit-future 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", "exit-future 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
"log 0.3.9 (registry+https://github.com/rust-lang/crates.io-index)", "log 0.3.9 (registry+https://github.com/rust-lang/crates.io-index)",
"parking_lot 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)", "parking_lot 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -1469,11 +1470,10 @@ dependencies = [
"substrate-client 0.1.0", "substrate-client 0.1.0",
"substrate-codec 0.1.0", "substrate-codec 0.1.0",
"substrate-keyring 0.1.0", "substrate-keyring 0.1.0",
"substrate-network 0.1.0",
"substrate-primitives 0.1.0", "substrate-primitives 0.1.0",
"substrate-runtime-primitives 0.1.0", "substrate-runtime-primitives 0.1.0",
"substrate-runtime-support 0.1.0", "substrate-runtime-support 0.1.0",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -1484,6 +1484,27 @@ dependencies = [
"substrate-executor 0.1.0", "substrate-executor 0.1.0",
] ]
[[package]]
name = "polkadot-network"
version = "0.1.0"
dependencies = [
"ed25519 0.1.0",
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
"log 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)",
"parking_lot 0.4.8 (registry+https://github.com/rust-lang/crates.io-index)",
"polkadot-api 0.1.0",
"polkadot-consensus 0.1.0",
"polkadot-primitives 0.1.0",
"serde 1.0.64 (registry+https://github.com/rust-lang/crates.io-index)",
"serde_derive 1.0.64 (registry+https://github.com/rust-lang/crates.io-index)",
"serde_json 1.0.19 (registry+https://github.com/rust-lang/crates.io-index)",
"substrate-bft 0.1.0",
"substrate-codec 0.1.0",
"substrate-network 0.1.0",
"substrate-primitives 0.1.0",
"tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
]
[[package]] [[package]]
name = "polkadot-parachain" name = "polkadot-parachain"
version = "0.1.0" version = "0.1.0"
@@ -1545,7 +1566,7 @@ dependencies = [
"clap 2.32.0 (registry+https://github.com/rust-lang/crates.io-index)", "clap 2.32.0 (registry+https://github.com/rust-lang/crates.io-index)",
"ed25519 0.1.0", "ed25519 0.1.0",
"error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)", "error-chain 0.12.0 (registry+https://github.com/rust-lang/crates.io-index)",
"exit-future 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", "exit-future 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
"hex-literal 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)", "hex-literal 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"lazy_static 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)", "lazy_static 1.0.1 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -1554,6 +1575,7 @@ dependencies = [
"polkadot-api 0.1.0", "polkadot-api 0.1.0",
"polkadot-consensus 0.1.0", "polkadot-consensus 0.1.0",
"polkadot-executor 0.1.0", "polkadot-executor 0.1.0",
"polkadot-network 0.1.0",
"polkadot-primitives 0.1.0", "polkadot-primitives 0.1.0",
"polkadot-runtime 0.1.0", "polkadot-runtime 0.1.0",
"polkadot-transaction-pool 0.1.0", "polkadot-transaction-pool 0.1.0",
@@ -1572,8 +1594,7 @@ dependencies = [
"substrate-runtime-primitives 0.1.0", "substrate-runtime-primitives 0.1.0",
"substrate-state-machine 0.1.0", "substrate-state-machine 0.1.0",
"substrate-telemetry 0.2.0", "substrate-telemetry 0.2.0",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-timer 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -1581,6 +1602,9 @@ name = "polkadot-statement-table"
version = "0.1.0" version = "0.1.0"
dependencies = [ dependencies = [
"polkadot-primitives 0.1.0", "polkadot-primitives 0.1.0",
"serde 1.0.64 (registry+https://github.com/rust-lang/crates.io-index)",
"serde_derive 1.0.64 (registry+https://github.com/rust-lang/crates.io-index)",
"substrate-codec 0.1.0",
"substrate-primitives 0.1.0", "substrate-primitives 0.1.0",
] ]
@@ -2099,8 +2123,7 @@ dependencies = [
"substrate-primitives 0.1.0", "substrate-primitives 0.1.0",
"substrate-runtime-primitives 0.1.0", "substrate-runtime-primitives 0.1.0",
"substrate-runtime-support 0.1.0", "substrate-runtime-support 0.1.0",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-timer 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -2301,7 +2324,7 @@ dependencies = [
"substrate-runtime-primitives 0.1.0", "substrate-runtime-primitives 0.1.0",
"substrate-state-machine 0.1.0", "substrate-state-machine 0.1.0",
"substrate-test-client 0.1.0", "substrate-test-client 0.1.0",
"tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -2737,7 +2760,7 @@ dependencies = [
[[package]] [[package]]
name = "tokio" name = "tokio"
version = "0.1.6" version = "0.1.7"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [ dependencies = [
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -2747,8 +2770,8 @@ dependencies = [
"tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-reactor 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-reactor 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-tcp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-tcp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-threadpool 0.1.3 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-threadpool 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-timer 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-timer 0.2.4 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-udp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-udp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
@@ -2763,11 +2786,11 @@ dependencies = [
"log 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)", "log 0.4.1 (registry+https://github.com/rust-lang/crates.io-index)",
"mio 0.6.14 (registry+https://github.com/rust-lang/crates.io-index)", "mio 0.6.14 (registry+https://github.com/rust-lang/crates.io-index)",
"scoped-tls 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", "scoped-tls 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)", "tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-executor 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-executor 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-reactor 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-reactor 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-timer 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-timer 0.2.4 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -2785,7 +2808,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [ dependencies = [
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-io 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)",
"tokio-threadpool 0.1.3 (registry+https://github.com/rust-lang/crates.io-index)", "tokio-threadpool 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)",
] ]
[[package]] [[package]]
@@ -2862,7 +2885,7 @@ dependencies = [
[[package]] [[package]]
name = "tokio-threadpool" name = "tokio-threadpool"
version = "0.1.3" version = "0.1.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [ dependencies = [
"crossbeam-deque 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)", "crossbeam-deque 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -2884,7 +2907,7 @@ dependencies = [
[[package]] [[package]]
name = "tokio-timer" name = "tokio-timer"
version = "0.2.3" version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
dependencies = [ dependencies = [
"futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)", "futures 0.1.21 (registry+https://github.com/rust-lang/crates.io-index)",
@@ -3290,7 +3313,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
"checksum ethereum-types 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)" = "9c48729b8aea8aedb12cf4cb2e5cef439fdfe2dda4a89e47eeebd15778ef53b6" "checksum ethereum-types 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)" = "9c48729b8aea8aedb12cf4cb2e5cef439fdfe2dda4a89e47eeebd15778ef53b6"
"checksum ethereum-types-serialize 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "4ac59a21a9ce98e188f3dace9eb67a6c4a3c67ec7fbc7218cb827852679dc002" "checksum ethereum-types-serialize 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "4ac59a21a9ce98e188f3dace9eb67a6c4a3c67ec7fbc7218cb827852679dc002"
"checksum ethkey 0.3.0 (git+https://github.com/paritytech/parity.git)" = "<none>" "checksum ethkey 0.3.0 (git+https://github.com/paritytech/parity.git)" = "<none>"
"checksum exit-future 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "6c30ec160f83d938faf4dd6fdaba4f42316f1bd3df76b902df2d824f47fa9db7" "checksum exit-future 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "9aa7b56cef68c4182db7212dece19cc9f6e2916cf9412e57e6cea53ec02f316d"
"checksum fdlimit 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "b1ee15a7050e5580b3712877157068ea713b245b080ff302ae2ca973cfcd9baa" "checksum fdlimit 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "b1ee15a7050e5580b3712877157068ea713b245b080ff302ae2ca973cfcd9baa"
"checksum fixed-hash 0.1.3 (git+https://github.com/rphmeier/primitives.git?branch=compile-for-wasm)" = "<none>" "checksum fixed-hash 0.1.3 (git+https://github.com/rphmeier/primitives.git?branch=compile-for-wasm)" = "<none>"
"checksum fixed-hash 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "b18d6fd718fb4396e7a9c93ac59ba7143501467ca7a143c145b5555a571d5576" "checksum fixed-hash 0.2.1 (registry+https://github.com/rust-lang/crates.io-index)" = "b18d6fd718fb4396e7a9c93ac59ba7143501467ca7a143c145b5555a571d5576"
@@ -3445,7 +3468,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
"checksum time 0.1.40 (registry+https://github.com/rust-lang/crates.io-index)" = "d825be0eb33fda1a7e68012d51e9c7f451dc1a69391e7fdc197060bb8c56667b" "checksum time 0.1.40 (registry+https://github.com/rust-lang/crates.io-index)" = "d825be0eb33fda1a7e68012d51e9c7f451dc1a69391e7fdc197060bb8c56667b"
"checksum timer 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)" = "31d42176308937165701f50638db1c31586f183f1aab416268216577aec7306b" "checksum timer 0.2.0 (registry+https://github.com/rust-lang/crates.io-index)" = "31d42176308937165701f50638db1c31586f183f1aab416268216577aec7306b"
"checksum tiny-keccak 1.4.2 (registry+https://github.com/rust-lang/crates.io-index)" = "e9175261fbdb60781fcd388a4d6cc7e14764a2b629a7ad94abb439aed223a44f" "checksum tiny-keccak 1.4.2 (registry+https://github.com/rust-lang/crates.io-index)" = "e9175261fbdb60781fcd388a4d6cc7e14764a2b629a7ad94abb439aed223a44f"
"checksum tokio 0.1.6 (registry+https://github.com/rust-lang/crates.io-index)" = "7d00555353b013e170ed8bc4e13f648a317d1fd12157dbcae13f7013f6cf29f5" "checksum tokio 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)" = "8ee337e5f4e501fc32966fec6fe0ca0cc1c237b0b1b14a335f8bfe3c5f06e286"
"checksum tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)" = "aeeffbbb94209023feaef3c196a41cbcdafa06b4a6f893f68779bb5e53796f71" "checksum tokio-core 0.1.17 (registry+https://github.com/rust-lang/crates.io-index)" = "aeeffbbb94209023feaef3c196a41cbcdafa06b4a6f893f68779bb5e53796f71"
"checksum tokio-executor 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "8cac2a7883ff3567e9d66bb09100d09b33d90311feca0206c7ca034bc0c55113" "checksum tokio-executor 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "8cac2a7883ff3567e9d66bb09100d09b33d90311feca0206c7ca034bc0c55113"
"checksum tokio-fs 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "76766830bbf9a2d5bfb50c95350d56a2e79e2c80f675967fff448bc615899708" "checksum tokio-fs 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "76766830bbf9a2d5bfb50c95350d56a2e79e2c80f675967fff448bc615899708"
@@ -3455,9 +3478,9 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
"checksum tokio-retry 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "f05746ae87dca83a2016b4f5dba5b237b897dd12fd324f60afe282112f16969a" "checksum tokio-retry 0.1.1 (registry+https://github.com/rust-lang/crates.io-index)" = "f05746ae87dca83a2016b4f5dba5b237b897dd12fd324f60afe282112f16969a"
"checksum tokio-service 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "24da22d077e0f15f55162bdbdc661228c1581892f52074fb242678d015b45162" "checksum tokio-service 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "24da22d077e0f15f55162bdbdc661228c1581892f52074fb242678d015b45162"
"checksum tokio-tcp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ec9b094851aadd2caf83ba3ad8e8c4ce65a42104f7b94d9e6550023f0407853f" "checksum tokio-tcp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "ec9b094851aadd2caf83ba3ad8e8c4ce65a42104f7b94d9e6550023f0407853f"
"checksum tokio-threadpool 0.1.3 (registry+https://github.com/rust-lang/crates.io-index)" = "5783254b10c7c84a56f62c74766ef7e5b83d1f13053218c7cab8d3f2c826fa0e" "checksum tokio-threadpool 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)" = "b3c3873a6d8d0b636e024e77b9a82eaab6739578a06189ecd0e731c7308fbc5d"
"checksum tokio-timer 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "6131e780037787ff1b3f8aad9da83bca02438b72277850dd6ad0d455e0e20efc" "checksum tokio-timer 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)" = "6131e780037787ff1b3f8aad9da83bca02438b72277850dd6ad0d455e0e20efc"
"checksum tokio-timer 0.2.3 (registry+https://github.com/rust-lang/crates.io-index)" = "535fed0ccee189f3d48447587697ba3fd234b3dbbb091f0ec4613ddfec0a7c4c" "checksum tokio-timer 0.2.4 (registry+https://github.com/rust-lang/crates.io-index)" = "028b94314065b90f026a21826cffd62a4e40a92cda3e5c069cc7b02e5945f5e9"
"checksum tokio-tls 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)" = "772f4b04e560117fe3b0a53e490c16ddc8ba6ec437015d91fa385564996ed913" "checksum tokio-tls 0.1.4 (registry+https://github.com/rust-lang/crates.io-index)" = "772f4b04e560117fe3b0a53e490c16ddc8ba6ec437015d91fa385564996ed913"
"checksum tokio-udp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "137bda266504893ac4774e0ec4c2108f7ccdbcb7ac8dced6305fe9e4e0b5041a" "checksum tokio-udp 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "137bda266504893ac4774e0ec4c2108f7ccdbcb7ac8dced6305fe9e4e0b5041a"
"checksum trace-time 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5aea07da6582e957c6e737eeb63a5af79e648eeeaaaba8fd9a417f1124bafa41" "checksum trace-time 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)" = "5aea07da6582e957c6e737eeb63a5af79e648eeeaaaba8fd9a417f1124bafa41"
+3 -1
View File
@@ -18,12 +18,14 @@ members = [
"polkadot/collator", "polkadot/collator",
"polkadot/consensus", "polkadot/consensus",
"polkadot/executor", "polkadot/executor",
"polkadot/parachain", "polkadot/network",
"polkadot/primitives", "polkadot/primitives",
"polkadot/runtime", "polkadot/runtime",
"polkadot/service", "polkadot/service",
"polkadot/statement-table", "polkadot/statement-table",
"polkadot/transaction-pool", "polkadot/transaction-pool",
"polkadot/service",
"substrate/bft", "substrate/bft",
"substrate/client", "substrate/client",
"substrate/client/db", "substrate/client/db",
+1 -1
View File
@@ -13,7 +13,7 @@ futures = "0.1.17"
error-chain = "0.12" error-chain = "0.12"
hex-literal = "0.1" hex-literal = "0.1"
log = "0.3" log = "0.3"
tokio-core = "0.1.12" tokio = "0.1.7"
triehash = "0.1" triehash = "0.1"
substrate-client = { path = "../../substrate/client" } substrate-client = { path = "../../substrate/client" }
substrate-codec = { path = "../../substrate/codec" } substrate-codec = { path = "../../substrate/codec" }
+6 -5
View File
@@ -22,7 +22,7 @@ extern crate ctrlc;
extern crate ed25519; extern crate ed25519;
extern crate env_logger; extern crate env_logger;
extern crate futures; extern crate futures;
extern crate tokio_core; extern crate tokio;
extern crate triehash; extern crate triehash;
extern crate substrate_client as client; extern crate substrate_client as client;
extern crate substrate_codec as codec; extern crate substrate_codec as codec;
@@ -53,6 +53,7 @@ use demo_runtime::{Block, BlockId, UncheckedExtrinsic, GenesisConfig,
ConsensusConfig, CouncilConfig, DemocracyConfig, SessionConfig, StakingConfig, ConsensusConfig, CouncilConfig, DemocracyConfig, SessionConfig, StakingConfig,
TimestampConfig}; TimestampConfig};
use futures::{Future, Sink, Stream}; use futures::{Future, Sink, Stream};
use tokio::runtime::Runtime;
struct DummyPool; struct DummyPool;
impl extrinsic_pool::api::ExtrinsicPool<UncheckedExtrinsic, BlockId, Hash> for DummyPool { impl extrinsic_pool::api::ExtrinsicPool<UncheckedExtrinsic, BlockId, Hash> for DummyPool {
@@ -155,11 +156,10 @@ pub fn run<I, T>(args: I) -> error::Result<()> where
}; };
let client = Arc::new(client::new_in_mem::<_, Block, _>(executor, genesis_config)?); let client = Arc::new(client::new_in_mem::<_, Block, _>(executor, genesis_config)?);
let mut core = ::tokio_core::reactor::Core::new().expect("Unable to spawn event loop."); let mut runtime = Runtime::new()?;
let _rpc_servers = { let _rpc_servers = {
let handler = || { let handler = || {
let chain = rpc::apis::chain::Chain::new(client.clone(), core.remote()); let chain = rpc::apis::chain::Chain::new(client.clone(), runtime.executor());
let author = rpc::apis::author::Author::new(client.clone(), Arc::new(DummyPool)); let author = rpc::apis::author::Author::new(client.clone(), Arc::new(DummyPool));
rpc::rpc_handler::<Block, _, _, _, _>(client.clone(), chain, author, DummySystem) rpc::rpc_handler::<Block, _, _, _, _>(client.clone(), chain, author, DummySystem)
}; };
@@ -178,7 +178,8 @@ pub fn run<I, T>(args: I) -> error::Result<()> where
ctrlc::CtrlC::set_handler(move || { ctrlc::CtrlC::set_handler(move || {
exit_send.clone().send(()).wait().expect("Error sending exit notification"); exit_send.clone().send(()).wait().expect("Error sending exit notification");
}); });
core.run(exit.into_future()).expect("Error running informant event loop");
runtime.block_on(exit.into_future()).expect("Error running informant event loop");
return Ok(()) return Ok(())
} }
+2 -1
View File
@@ -18,13 +18,14 @@ lazy_static = "1.0"
triehash = "0.1" triehash = "0.1"
ed25519 = { path = "../../substrate/ed25519" } ed25519 = { path = "../../substrate/ed25519" }
app_dirs = "1.2" app_dirs = "1.2"
tokio-core = "0.1.12" tokio = "0.1.7"
futures = "0.1.17" futures = "0.1.17"
ctrlc = { git = "https://github.com/paritytech/rust-ctrlc.git" } ctrlc = { git = "https://github.com/paritytech/rust-ctrlc.git" }
fdlimit = "0.1" fdlimit = "0.1"
parking_lot = "0.4" parking_lot = "0.4"
serde_json = "1.0" serde_json = "1.0"
serde = "1.0" serde = "1.0"
exit-future = "0.1"
substrate-client = { path = "../../substrate/client" } substrate-client = { path = "../../substrate/client" }
substrate-codec = { path = "../../substrate/codec" } substrate-codec = { path = "../../substrate/codec" }
substrate-network = { path = "../../substrate/network" } substrate-network = { path = "../../substrate/network" }
+8 -8
View File
@@ -17,9 +17,10 @@
//! Console informant. Prints sync progress and block events. Runs on the calling thread. //! Console informant. Prints sync progress and block events. Runs on the calling thread.
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use futures::stream::Stream; use futures::{Future, Stream};
use service::{Service, Components}; use service::{Service, Components};
use tokio_core::reactor; use tokio::runtime::TaskExecutor;
use tokio::timer::Interval;
use network::{SyncState, SyncProvider}; use network::{SyncState, SyncProvider};
use polkadot_primitives::Block; use polkadot_primitives::Block;
use state_machine; use state_machine;
@@ -28,13 +29,12 @@ use client::{self, BlockchainEvents};
const TIMER_INTERVAL_MS: u64 = 5000; const TIMER_INTERVAL_MS: u64 = 5000;
/// Spawn informant on the event loop /// Spawn informant on the event loop
pub fn start<C>(service: &Service<C>, handle: reactor::Handle) pub fn start<C>(service: &Service<C>, exit: ::exit_future::Exit, handle: TaskExecutor)
where where
C: Components, C: Components,
client::error::Error: From<<<<C as Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>, client::error::Error: From<<<<C as Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>,
{ {
let interval = reactor::Interval::new_at(Instant::now(), Duration::from_millis(TIMER_INTERVAL_MS), &handle) let interval = Interval::new(Instant::now(), Duration::from_millis(TIMER_INTERVAL_MS));
.expect("Error creating informant timer");
let network = service.network(); let network = service.network();
let client = service.client(); let client = service.client();
@@ -73,8 +73,8 @@ pub fn start<C>(service: &Service<C>, handle: reactor::Handle)
telemetry!("txpool.import"; "mem_usage" => status.mem_usage, "count" => status.transaction_count, "sender" => status.senders); telemetry!("txpool.import"; "mem_usage" => status.mem_usage, "count" => status.transaction_count, "sender" => status.senders);
Ok(()) Ok(())
}); });
handle.spawn(display_notifications);
handle.spawn(display_block_import); let informant_work = display_notifications.join3(display_block_import, display_txpool_import);
handle.spawn(display_txpool_import); handle.spawn(exit.until(informant_work).map(|_| ()));
} }
+31 -16
View File
@@ -25,7 +25,7 @@ extern crate ansi_term;
extern crate regex; extern crate regex;
extern crate time; extern crate time;
extern crate futures; extern crate futures;
extern crate tokio_core; extern crate tokio;
extern crate ctrlc; extern crate ctrlc;
extern crate fdlimit; extern crate fdlimit;
extern crate ed25519; extern crate ed25519;
@@ -50,6 +50,7 @@ extern crate slog; // needed until we can reexport `slog_info` from `substrate_t
#[macro_use] #[macro_use]
extern crate substrate_telemetry; extern crate substrate_telemetry;
extern crate polkadot_transaction_pool as txpool; extern crate polkadot_transaction_pool as txpool;
extern crate exit_future;
#[macro_use] #[macro_use]
extern crate lazy_static; extern crate lazy_static;
@@ -76,9 +77,8 @@ use codec::Slicable;
use client::BlockOrigin; use client::BlockOrigin;
use runtime_primitives::generic::SignedBlock; use runtime_primitives::generic::SignedBlock;
use futures::sync::mpsc; use futures::Future;
use futures::{Sink, Future, Stream}; use tokio::runtime::Runtime;
use tokio_core::reactor;
use service::PruningMode; use service::PruningMode;
const DEFAULT_TELEMETRY_URL: &str = "ws://telemetry.polkadot.io:1024"; const DEFAULT_TELEMETRY_URL: &str = "ws://telemetry.polkadot.io:1024";
@@ -188,13 +188,14 @@ pub fn run<I, T>(args: I) -> error::Result<()> where
let role = let role =
if matches.is_present("collator") { if matches.is_present("collator") {
info!("Starting collator"); info!("Starting collator");
service::Role::COLLATOR // TODO [rob]: collation node implementation
service::Role::FULL
} else if matches.is_present("light") { } else if matches.is_present("light") {
info!("Starting (light)"); info!("Starting (light)");
service::Role::LIGHT service::Role::LIGHT
} else if matches.is_present("validator") || matches.is_present("dev") { } else if matches.is_present("validator") || matches.is_present("dev") {
info!("Starting validator"); info!("Starting validator");
service::Role::VALIDATOR service::Role::AUTHORITY
} else { } else {
info!("Starting (heavy)"); info!("Starting (heavy)");
service::Role::FULL service::Role::FULL
@@ -231,6 +232,9 @@ pub fn run<I, T>(args: I) -> error::Result<()> where
chain_name: config.chain_spec.name().to_owned(), chain_name: config.chain_spec.name().to_owned(),
}; };
let mut runtime = Runtime::new()?;
let executor = runtime.executor();
let _guard = if matches.is_present("telemetry") || matches.value_of("telemetry-url").is_some() { let _guard = if matches.is_present("telemetry") || matches.value_of("telemetry-url").is_some() {
let name = config.name.clone(); let name = config.name.clone();
let chain_name = config.chain_spec.name().to_owned(); let chain_name = config.chain_spec.name().to_owned();
@@ -250,11 +254,14 @@ pub fn run<I, T>(args: I) -> error::Result<()> where
None None
}; };
let core = reactor::Core::new().expect("tokio::Core could not be created");
match role == service::Role::LIGHT { match role == service::Role::LIGHT {
true => run_until_exit(core, service::new_light(config)?, &matches, sys_conf), true => run_until_exit(&mut runtime, service::new_light(config, executor)?, &matches, sys_conf)?,
false => run_until_exit(core, service::new_full(config)?, &matches, sys_conf), false => run_until_exit(&mut runtime, service::new_full(config, executor)?, &matches, sys_conf)?,
} }
// TODO: hard exit if this stalls?
runtime.shutdown_on_idle().wait().expect("failed to shut down event loop");
Ok(())
} }
fn build_spec(matches: &clap::ArgMatches) -> error::Result<()> { fn build_spec(matches: &clap::ArgMatches) -> error::Result<()> {
@@ -370,29 +377,37 @@ fn import_blocks(matches: &clap::ArgMatches) -> error::Result<()> {
Ok(()) Ok(())
} }
fn run_until_exit<C>(mut core: reactor::Core, service: service::Service<C>, matches: &clap::ArgMatches, sys_conf: SystemConfiguration) -> error::Result<()> fn run_until_exit<C>(runtime: &mut Runtime, service: service::Service<C>, matches: &clap::ArgMatches, sys_conf: SystemConfiguration) -> error::Result<()>
where where
C: service::Components, C: service::Components,
client::error::Error: From<<<<C as service::Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>, client::error::Error: From<<<<C as service::Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>,
{ {
let exit = { let exit = {
// can't use signal directly here because CtrlC takes only `Fn`. let (exit_send, exit) = exit_future::signal();
let (exit_send, exit) = mpsc::channel(1); let exit_send = ::std::cell::RefCell::new(Some(exit_send));
ctrlc::CtrlC::set_handler(move || { ctrlc::CtrlC::set_handler(move || {
exit_send.clone().send(()).wait().expect("Error sending exit notification"); let exit_send = exit_send
.try_borrow_mut()
.expect("only borrowed in non-reetrant signal handler; qed")
.take();
if let Some(signal) = exit_send {
signal.fire();
}
}); });
exit exit
}; };
informant::start(&service, core.handle()); let executor = runtime.executor();
informant::start(&service, exit.clone(), executor.clone());
let _rpc_servers = { let _rpc_servers = {
let http_address = parse_address("127.0.0.1:9933", "rpc-port", matches)?; let http_address = parse_address("127.0.0.1:9933", "rpc-port", matches)?;
let ws_address = parse_address("127.0.0.1:9944", "ws-port", matches)?; let ws_address = parse_address("127.0.0.1:9944", "ws-port", matches)?;
let handler = || { let handler = || {
let chain = rpc::apis::chain::Chain::new(service.client(), core.remote()); let chain = rpc::apis::chain::Chain::new(service.client(), executor.clone());
let author = rpc::apis::author::Author::new(service.client(), service.transaction_pool()); let author = rpc::apis::author::Author::new(service.client(), service.transaction_pool());
rpc::rpc_handler::<Block, _, _, _, _>( rpc::rpc_handler::<Block, _, _, _, _>(
service.client(), service.client(),
@@ -407,7 +422,7 @@ fn run_until_exit<C>(mut core: reactor::Core, service: service::Service<C>, matc
) )
}; };
core.run(exit.into_future()).expect("Error running informant event loop"); let _ = exit.wait();
Ok(()) Ok(())
} }
+1 -1
View File
@@ -9,5 +9,5 @@ futures = "0.1.17"
substrate-codec = { path = "../../substrate/codec", version = "0.1" } substrate-codec = { path = "../../substrate/codec", version = "0.1" }
substrate-primitives = { path = "../../substrate/primitives", version = "0.1" } substrate-primitives = { path = "../../substrate/primitives", version = "0.1" }
polkadot-runtime = { path = "../runtime", version = "0.1" } polkadot-runtime = { path = "../runtime", version = "0.1" }
polkadot-parachain = { path = "../parachain", version = "0.1" }
polkadot-primitives = { path = "../primitives", version = "0.1" } polkadot-primitives = { path = "../primitives", version = "0.1" }
polkadot-parachain = { path = "../parachain", version = "0.1" }
+7 -7
View File
@@ -85,7 +85,7 @@ pub trait RelayChainContext {
/// Collate the necessary ingress queue using the given context. /// Collate the necessary ingress queue using the given context.
pub fn collate_ingress<'a, R>(relay_context: R) pub fn collate_ingress<'a, R>(relay_context: R)
-> Box<Future<Item=ConsolidatedIngress, Error=R::Error> + 'a> -> impl Future<Item=ConsolidatedIngress, Error=R::Error> + 'a
where where
R: RelayChainContext, R: RelayChainContext,
R::Error: 'a, R::Error: 'a,
@@ -106,7 +106,7 @@ pub fn collate_ingress<'a, R>(relay_context: R)
// and then by the parachain ID. // and then by the parachain ID.
// //
// then transform that into the consolidated egress queue. // then transform that into the consolidated egress queue.
Box::new(stream::futures_unordered(egress_fetch) stream::futures_unordered(egress_fetch)
.fold(BTreeMap::new(), |mut map, (routing_id, egresses)| { .fold(BTreeMap::new(), |mut map, (routing_id, egresses)| {
for (depth, egress) in egresses.into_iter().rev().enumerate() { for (depth, egress) in egresses.into_iter().rev().enumerate() {
let depth = -(depth as i64); let depth = -(depth as i64);
@@ -117,19 +117,19 @@ pub fn collate_ingress<'a, R>(relay_context: R)
}) })
.map(|ordered| ordered.into_iter().map(|((_, id), egress)| (id, egress))) .map(|ordered| ordered.into_iter().map(|((_, id), egress)| (id, egress)))
.map(|i| i.collect::<Vec<_>>()) .map(|i| i.collect::<Vec<_>>())
.map(ConsolidatedIngress)) .map(ConsolidatedIngress)
} }
/// Produce a candidate for the parachain. /// Produce a candidate for the parachain.
pub fn collate<'a, R, P>(local_id: ParaId, relay_context: R, para_context: P) pub fn collate<'a, R: 'a, P>(local_id: ParaId, relay_context: R, para_context: P)
-> Box<Future<Item=parachain::Candidate, Error=R::Error> + 'a> -> impl Future<Item=parachain::Candidate, Error=R::Error> + 'a
where where
R: RelayChainContext, R: RelayChainContext,
R::Error: 'a, R::Error: 'a,
R::FutureEgress: 'a, R::FutureEgress: 'a,
P: ParachainContext + 'a, P: ParachainContext + 'a,
{ {
Box::new(collate_ingress(relay_context).map(move |ingress| { collate_ingress(relay_context).map(move |ingress| {
let (block_data, _, signature) = para_context.produce_candidate( let (block_data, _, signature) = para_context.produce_candidate(
ingress.0.iter().flat_map(|&(id, ref msgs)| msgs.iter().cloned().map(move |msg| (id, msg))) ingress.0.iter().flat_map(|&(id, ref msgs)| msgs.iter().cloned().map(move |msg| (id, msg)))
); );
@@ -140,7 +140,7 @@ pub fn collate<'a, R, P>(local_id: ParaId, relay_context: R, para_context: P)
block: block_data, block: block_data,
unprocessed_ingress: ingress, unprocessed_ingress: ingress,
} }
})) })
} }
#[cfg(test)] #[cfg(test)]
+4 -3
View File
@@ -6,7 +6,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
[dependencies] [dependencies]
futures = "0.1.17" futures = "0.1.17"
parking_lot = "0.4" parking_lot = "0.4"
tokio-core = "0.1.12" tokio = "0.1.7"
ed25519 = { path = "../../substrate/ed25519" } ed25519 = { path = "../../substrate/ed25519" }
error-chain = "0.12" error-chain = "0.12"
log = "0.3" log = "0.3"
@@ -22,7 +22,8 @@ substrate-bft = { path = "../../substrate/bft" }
substrate-codec = { path = "../../substrate/codec" } substrate-codec = { path = "../../substrate/codec" }
substrate-primitives = { path = "../../substrate/primitives" } substrate-primitives = { path = "../../substrate/primitives" }
substrate-runtime-support = { path = "../../substrate/runtime-support" } substrate-runtime-support = { path = "../../substrate/runtime-support" }
substrate-network = { path = "../../substrate/network" }
substrate-keyring = { path = "../../substrate/keyring" }
substrate-client = { path = "../../substrate/client" } substrate-client = { path = "../../substrate/client" }
substrate-runtime-primitives = { path = "../../substrate/runtime/primitives" } substrate-runtime-primitives = { path = "../../substrate/runtime/primitives" }
[dev-dependencies]
substrate-keyring = { path = "../../substrate/keyring" }
+5 -15
View File
@@ -23,7 +23,7 @@ use std::sync::Arc;
use polkadot_api::PolkadotApi; use polkadot_api::PolkadotApi;
use polkadot_primitives::{Hash, AccountId, BlockId}; use polkadot_primitives::{Hash, AccountId, BlockId};
use polkadot_primitives::parachain::{Id as ParaId, Chain, BlockData, Extrinsic, CandidateReceipt}; use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt};
use futures::prelude::*; use futures::prelude::*;
@@ -55,7 +55,7 @@ pub trait Collators: Clone {
/// ///
/// This future is fused. /// This future is fused.
pub struct CollationFetch<C: Collators, P: PolkadotApi> { pub struct CollationFetch<C: Collators, P: PolkadotApi> {
parachain: Option<ParaId>, parachain: ParaId,
relay_parent_hash: Hash, relay_parent_hash: Hash,
relay_parent: BlockId, relay_parent: BlockId,
collators: C, collators: C,
@@ -65,16 +65,13 @@ pub struct CollationFetch<C: Collators, P: PolkadotApi> {
impl<C: Collators, P: PolkadotApi> CollationFetch<C, P> { impl<C: Collators, P: PolkadotApi> CollationFetch<C, P> {
/// Create a new collation fetcher for the given chain. /// Create a new collation fetcher for the given chain.
pub fn new(parachain: Chain, relay_parent: BlockId, relay_parent_hash: Hash, collators: C, client: Arc<P>) -> Self { pub fn new(parachain: ParaId, relay_parent: BlockId, relay_parent_hash: Hash, collators: C, client: Arc<P>) -> Self {
CollationFetch { CollationFetch {
relay_parent_hash, relay_parent_hash,
relay_parent, relay_parent,
collators, collators,
client, client,
parachain: match parachain { parachain,
Chain::Parachain(id) => Some(id),
Chain::Relay => None,
},
live_fetch: None, live_fetch: None,
} }
} }
@@ -85,26 +82,19 @@ impl<C: Collators, P: PolkadotApi> Future for CollationFetch<C, P> {
type Error = C::Error; type Error = C::Error;
fn poll(&mut self) -> Poll<(Collation, Extrinsic), C::Error> { fn poll(&mut self) -> Poll<(Collation, Extrinsic), C::Error> {
let parachain = match self.parachain.as_ref() {
Some(p) => p.clone(),
None => return Ok(Async::NotReady),
};
loop { loop {
let x = { let x = {
let parachain = self.parachain.clone();
let (r, c) = (self.relay_parent_hash, &self.collators); let (r, c) = (self.relay_parent_hash, &self.collators);
let poll = self.live_fetch let poll = self.live_fetch
.get_or_insert_with(move || c.collate(parachain, r).into_future()) .get_or_insert_with(move || c.collate(parachain, r).into_future())
.poll(); .poll();
if let Err(_) = poll { self.parachain = None }
try_ready!(poll) try_ready!(poll)
}; };
match validate_collation(&*self.client, &self.relay_parent, &x) { match validate_collation(&*self.client, &self.relay_parent, &x) {
Ok(()) => { Ok(()) => {
self.parachain = None;
// TODO: generate extrinsic while verifying. // TODO: generate extrinsic while verifying.
return Ok(Async::Ready((x, Extrinsic))); return Ok(Async::Ready((x, Extrinsic)));
} }
@@ -61,7 +61,7 @@ impl DynamicInclusion {
/// would be enough, or `None` if it is sufficient now. /// would be enough, or `None` if it is sufficient now.
/// ///
/// Panics if `now` is earlier than the `start`. /// Panics if `now` is earlier than the `start`.
pub fn acceptable_in(&self, now: Instant, included: usize) -> Option<Duration> { pub fn acceptable_in(&self, now: Instant, included: usize) -> Option<Instant> {
let elapsed = now.duration_since(self.start); let elapsed = now.duration_since(self.start);
let elapsed = duration_to_micros(&elapsed); let elapsed = duration_to_micros(&elapsed);
@@ -70,7 +70,8 @@ impl DynamicInclusion {
if elapsed >= valid_after { if elapsed >= valid_after {
None None
} else { } else {
Some(Duration::from_millis((valid_after - elapsed) as u64 / 1000)) let until = Duration::from_millis((valid_after - elapsed) as u64 / 1000);
Some(now + until)
} }
} }
} }
@@ -104,7 +105,7 @@ mod tests {
Duration::from_millis(4000), Duration::from_millis(4000),
); );
assert_eq!(dynamic.acceptable_in(now, 5), Some(Duration::from_millis(2000))); assert_eq!(dynamic.acceptable_in(now, 5), Some(now + Duration::from_millis(2000)));
assert!(dynamic.acceptable_in(now + Duration::from_millis(2000), 5).is_none()); assert!(dynamic.acceptable_in(now + Duration::from_millis(2000), 5).is_none());
assert!(dynamic.acceptable_in(now + Duration::from_millis(3000), 5).is_none()); assert!(dynamic.acceptable_in(now + Duration::from_millis(3000), 5).is_none());
assert!(dynamic.acceptable_in(now + Duration::from_millis(4000), 5).is_none()); assert!(dynamic.acceptable_in(now + Duration::from_millis(4000), 5).is_none());
+1 -1
View File
@@ -37,7 +37,7 @@ error_chain! {
description("Proposer destroyed before finishing proposing or evaluating"), description("Proposer destroyed before finishing proposing or evaluating"),
display("Proposer destroyed before finishing proposing or evaluating"), display("Proposer destroyed before finishing proposing or evaluating"),
} }
Timer(e: String) { Timer(e: ::tokio::timer::Error) {
description("Failed to register or resolve async timer."), description("Failed to register or resolve async timer."),
display("Timer failed: {}", e), display("Timer failed: {}", e),
} }
+192 -167
View File
@@ -44,11 +44,10 @@ extern crate substrate_codec as codec;
extern crate substrate_primitives as primitives; extern crate substrate_primitives as primitives;
extern crate substrate_runtime_support as runtime_support; extern crate substrate_runtime_support as runtime_support;
extern crate substrate_runtime_primitives as runtime_primitives; extern crate substrate_runtime_primitives as runtime_primitives;
extern crate substrate_network; extern crate substrate_client as client;
extern crate exit_future; extern crate exit_future;
extern crate tokio_core; extern crate tokio;
extern crate substrate_client as client;
#[macro_use] #[macro_use]
extern crate error_chain; extern crate error_chain;
@@ -67,33 +66,32 @@ use std::sync::Arc;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use codec::Slicable; use codec::Slicable;
use table::generic::Statement as GenericStatement;
use runtime_support::Hashable;
use polkadot_api::PolkadotApi; use polkadot_api::PolkadotApi;
use polkadot_primitives::{Hash, Block, BlockId, BlockNumber, Header, Timestamp}; use polkadot_primitives::{Hash, Block, BlockId, BlockNumber, Header, Timestamp, SessionKey};
use polkadot_primitives::parachain::{Id as ParaId, Chain, DutyRoster, BlockData, Extrinsic as ParachainExtrinsic, CandidateReceipt}; use polkadot_primitives::parachain::{Id as ParaId, Chain, DutyRoster, BlockData, Extrinsic as ParachainExtrinsic, CandidateReceipt, CandidateSignature};
use polkadot_runtime::BareExtrinsic;
use primitives::AuthorityId; use primitives::AuthorityId;
use transaction_pool::{TransactionPool}; use transaction_pool::TransactionPool;
use tokio_core::reactor::{Handle, Timeout, Interval}; use tokio::runtime::TaskExecutor;
use tokio::timer::{Delay, Interval};
use futures::prelude::*; use futures::prelude::*;
use futures::future::{self, Shared}; use futures::future;
use collation::CollationFetch; use collation::CollationFetch;
use dynamic_inclusion::DynamicInclusion; use dynamic_inclusion::DynamicInclusion;
pub use self::collation::{Collators, Collation}; pub use self::collation::{validate_collation, Collators, Collation};
pub use self::error::{ErrorKind, Error}; pub use self::error::{ErrorKind, Error};
pub use self::shared_table::{SharedTable, StatementSource, StatementProducer, ProducedStatements}; pub use self::shared_table::{SharedTable, StatementProducer, ProducedStatements, Statement, SignedStatement, GenericStatement};
pub use service::Service; pub use service::Service;
mod collation;
mod dynamic_inclusion; mod dynamic_inclusion;
mod evaluation; mod evaluation;
mod error; mod error;
mod service; mod service;
mod shared_table; mod shared_table;
pub mod collation;
// block size limit. // block size limit.
const MAX_TRANSACTIONS_SIZE: usize = 4 * 1024 * 1024; const MAX_TRANSACTIONS_SIZE: usize = 4 * 1024 * 1024;
@@ -108,8 +106,9 @@ pub trait TableRouter: Clone {
/// Future that resolves when extrinsic candidate data is fetched. /// Future that resolves when extrinsic candidate data is fetched.
type FetchExtrinsic: IntoFuture<Item=ParachainExtrinsic,Error=Self::Error>; type FetchExtrinsic: IntoFuture<Item=ParachainExtrinsic,Error=Self::Error>;
/// Note local candidate data, making it available on the network to other validators. /// Call with local candidate data. This will make the data available on the network,
fn local_candidate_data(&self, hash: Hash, block_data: BlockData, extrinsic: ParachainExtrinsic); /// and sign, import, and broadcast a statement about the candidate.
fn local_candidate(&self, candidate: CandidateReceipt, block_data: BlockData, extrinsic: ParachainExtrinsic);
/// Fetch block data for a specific candidate. /// Fetch block data for a specific candidate.
fn fetch_block_data(&self, candidate: &CandidateReceipt) -> Self::FetchCandidate; fn fetch_block_data(&self, candidate: &CandidateReceipt) -> Self::FetchCandidate;
@@ -118,23 +117,28 @@ pub trait TableRouter: Clone {
fn fetch_extrinsic_data(&self, candidate: &CandidateReceipt) -> Self::FetchExtrinsic; fn fetch_extrinsic_data(&self, candidate: &CandidateReceipt) -> Self::FetchExtrinsic;
} }
/// A long-lived network which can create statement table routing instances. /// A long-lived network which can create parachain statement and BFT message routing processes on demand.
pub trait Network { pub trait Network {
/// The table router type. This should handle importing of any statements, /// The table router type. This should handle importing of any statements,
/// routing statements to peers, and driving completion of any `StatementProducers`. /// routing statements to peers, and driving completion of any `StatementProducers`.
type TableRouter: TableRouter; type TableRouter: TableRouter;
/// The input stream of BFT messages. Should never logically conclude.
type Input: Stream<Item=bft::Communication<Block>,Error=Error>;
/// The output sink of BFT messages. Messages sent here should eventually pass to all
/// current authorities.
type Output: Sink<SinkItem=bft::Communication<Block>,SinkError=Error>;
/// Instantiate a table router using the given shared table. /// Instantiate a table router using the given shared table and task executor.
fn table_router(&self, table: Arc<SharedTable>) -> Self::TableRouter; fn communication_for(&self, validators: &[SessionKey], table: Arc<SharedTable>, task_executor: TaskExecutor) -> (Self::TableRouter, Self::Input, Self::Output);
} }
/// Information about a specific group. /// Information about a specific group.
#[derive(Debug, Clone, Default)] #[derive(Debug, Clone, Default)]
pub struct GroupInfo { pub struct GroupInfo {
/// Authorities meant to check validity of candidates. /// Authorities meant to check validity of candidates.
pub validity_guarantors: HashSet<AuthorityId>, pub validity_guarantors: HashSet<SessionKey>,
/// Authorities meant to check availability of candidate data. /// Authorities meant to check availability of candidate data.
pub availability_guarantors: HashSet<AuthorityId>, pub availability_guarantors: HashSet<SessionKey>,
/// Number of votes needed for validity. /// Number of votes needed for validity.
pub needed_validity: usize, pub needed_validity: usize,
/// Number of votes needed for availability. /// Number of votes needed for availability.
@@ -144,20 +148,21 @@ pub struct GroupInfo {
/// Sign a table statement against a parent hash. /// Sign a table statement against a parent hash.
/// The actual message signed is the encoded statement concatenated with the /// The actual message signed is the encoded statement concatenated with the
/// parent hash. /// parent hash.
pub fn sign_table_statement(statement: &table::Statement, key: &ed25519::Pair, parent_hash: &Hash) -> ed25519::Signature { pub fn sign_table_statement(statement: &Statement, key: &ed25519::Pair, parent_hash: &Hash) -> CandidateSignature {
use polkadot_primitives::parachain::Statement as RawStatement; let mut encoded = statement.encode();
let raw = match *statement {
GenericStatement::Candidate(ref c) => RawStatement::Candidate(c.clone()),
GenericStatement::Valid(h) => RawStatement::Valid(h),
GenericStatement::Invalid(h) => RawStatement::Invalid(h),
GenericStatement::Available(h) => RawStatement::Available(h),
};
let mut encoded = raw.encode();
encoded.extend(&parent_hash.0); encoded.extend(&parent_hash.0);
key.sign(&encoded) key.sign(&encoded).into()
}
/// Check signature on table statement.
pub fn check_statement(statement: &Statement, signature: &CandidateSignature, signer: SessionKey, parent_hash: &Hash) -> bool {
use runtime_primitives::traits::Verify;
let mut encoded = statement.encode();
encoded.extend(&parent_hash.0);
signature.verify(&encoded[..], &signer.into())
} }
fn make_group_info(roster: DutyRoster, authorities: &[AuthorityId], local_id: AuthorityId) -> Result<(HashMap<ParaId, GroupInfo>, LocalDuty), Error> { fn make_group_info(roster: DutyRoster, authorities: &[AuthorityId], local_id: AuthorityId) -> Result<(HashMap<ParaId, GroupInfo>, LocalDuty), Error> {
@@ -217,41 +222,43 @@ fn make_group_info(roster: DutyRoster, authorities: &[AuthorityId], local_id: Au
} }
} }
fn timer_error(e: &::std::io::Error) -> Error {
ErrorKind::Timer(format!("{}", e)).into()
}
/// Polkadot proposer factory. /// Polkadot proposer factory.
pub struct ProposerFactory<C, N, P> { pub struct ProposerFactory<C, N, P> {
/// The client instance. /// The client instance.
pub client: Arc<C>, pub client: Arc<P>,
/// The transaction pool. /// The transaction pool.
pub transaction_pool: Arc<TransactionPool<C>>, pub transaction_pool: Arc<TransactionPool<P>>,
/// The backing network handle. /// The backing network handle.
pub network: N, pub network: N,
/// Parachain collators. /// Parachain collators.
pub collators: P, pub collators: C,
/// The timer used to schedule proposal intervals. /// handle to remote task executor
pub handle: Handle, pub handle: TaskExecutor,
/// The duration after which parachain-empty blocks will be allowed. /// The duration after which parachain-empty blocks will be allowed.
pub parachain_empty_duration: Duration, pub parachain_empty_duration: Duration,
} }
impl<C, N, P> bft::ProposerFactory<Block> for ProposerFactory<C, N, P> impl<C, N, P> bft::Environment<Block> for ProposerFactory<C, N, P>
where where
C: PolkadotApi + Send + Sync, C: Collators + Send + 'static,
N: Network, N: Network,
P: Collators, P: PolkadotApi + Send + Sync + 'static,
<C::Collation as IntoFuture>::Future: Send + 'static,
N::TableRouter: Send + 'static,
{ {
type Proposer = Proposer<C, N::TableRouter, P>; type Proposer = Proposer<P>;
type Input = N::Input;
type Output = N::Output;
type Error = Error; type Error = Error;
fn init(&self, parent_header: &Header, authorities: &[AuthorityId], sign_with: Arc<ed25519::Pair>) -> Result<Self::Proposer, Error> { fn init(&self,
use std::time::Duration; parent_header: &Header,
authorities: &[AuthorityId],
sign_with: Arc<ed25519::Pair>
) -> Result<(Self::Proposer, Self::Input, Self::Output), Error> {
const DELAY_UNTIL: Duration = Duration::from_millis(5000); const DELAY_UNTIL: Duration = Duration::from_millis(5000);
let parent_hash = parent_header.blake2_256().into(); let parent_hash = parent_header.hash().into();
let id = BlockId::hash(parent_hash); let id = BlockId::hash(parent_hash);
let duty_roster = self.client.duty_roster(&id)?; let duty_roster = self.client.duty_roster(&id)?;
@@ -267,70 +274,116 @@ impl<C, N, P> bft::ProposerFactory<Block> for ProposerFactory<C, N, P>
let n_parachains = active_parachains.len(); let n_parachains = active_parachains.len();
let table = Arc::new(SharedTable::new(group_info, sign_with.clone(), parent_hash)); let table = Arc::new(SharedTable::new(group_info, sign_with.clone(), parent_hash));
let router = self.network.table_router(table.clone()); let (router, input, output) = self.network.communication_for(
let dynamic_inclusion = DynamicInclusion::new( authorities,
n_parachains, table.clone(),
Instant::now(), self.handle.clone()
self.parachain_empty_duration.clone(),
); );
let timeout = Timeout::new(DELAY_UNTIL, &self.handle) let now = Instant::now();
.map_err(|e| timer_error(&e))?; let dynamic_inclusion = DynamicInclusion::new(
n_parachains,
now,
self.parachain_empty_duration.clone(),
);
debug!(target: "bft", "Initialising consensus proposer. Refusing to evaluate for {:?} from now.", debug!(target: "bft", "Initialising consensus proposer. Refusing to evaluate for {:?} from now.",
DELAY_UNTIL); DELAY_UNTIL);
// TODO [PoC-2]: kick off collation process. let validation_para = match local_duty.validation {
Ok(Proposer { Chain::Relay => None,
Chain::Parachain(id) => Some(id),
};
let collation_work = validation_para.map(|para| CollationFetch::new(
para,
id.clone(),
parent_hash.clone(),
self.collators.clone(),
self.client.clone(),
));
let drop_signal = dispatch_collation_work(
router.clone(),
&self.handle,
collation_work,
);
let proposer = Proposer {
client: self.client.clone(), client: self.client.clone(),
collators: self.collators.clone(),
delay: timeout.shared(),
handle: self.handle.clone(),
dynamic_inclusion, dynamic_inclusion,
local_duty,
local_key: sign_with, local_key: sign_with,
minimum_delay: now + DELAY_UNTIL,
parent_hash, parent_hash,
parent_id: id, parent_id: id,
parent_number: parent_header.number, parent_number: parent_header.number,
random_seed, random_seed,
router,
table, table,
transaction_pool: self.transaction_pool.clone(), transaction_pool: self.transaction_pool.clone(),
}) _drop_signal: drop_signal,
};
Ok((proposer, input, output))
} }
} }
// dispatch collation work to be done in the background. returns a signal object
// that should fire when the collation work is no longer necessary (e.g. when the proposer object is dropped)
fn dispatch_collation_work<R, C, P>(
router: R,
handle: &TaskExecutor,
work: Option<CollationFetch<C, P>>,
) -> exit_future::Signal where
C: Collators + Send + 'static,
P: PolkadotApi + Send + Sync + 'static,
<C::Collation as IntoFuture>::Future: Send + 'static,
R: TableRouter + Send + 'static,
{
let (signal, exit) = exit_future::signal();
let handled_work = work.then(move |result| match result {
Ok(Some((collation, extrinsic))) => {
router.local_candidate(collation.receipt, collation.block_data, extrinsic);
Ok(())
}
Ok(None) => Ok(()),
Err(_e) => {
warn!(target: "consensus", "Failed to collate candidate");
Ok(())
}
});
let cancellable_work = handled_work.select(exit).then(|_| Ok(()));
// spawn onto thread pool.
handle.spawn(cancellable_work);
signal
}
struct LocalDuty { struct LocalDuty {
validation: Chain, validation: Chain,
} }
/// The Polkadot proposer logic. /// The Polkadot proposer logic.
pub struct Proposer<C: PolkadotApi, R, P> { pub struct Proposer<C: PolkadotApi> {
client: Arc<C>, client: Arc<C>,
collators: P,
delay: Shared<Timeout>,
dynamic_inclusion: DynamicInclusion, dynamic_inclusion: DynamicInclusion,
handle: Handle,
local_duty: LocalDuty,
local_key: Arc<ed25519::Pair>, local_key: Arc<ed25519::Pair>,
minimum_delay: Instant,
parent_hash: Hash, parent_hash: Hash,
parent_id: BlockId, parent_id: BlockId,
parent_number: BlockNumber, parent_number: BlockNumber,
random_seed: Hash, random_seed: Hash,
router: R,
table: Arc<SharedTable>, table: Arc<SharedTable>,
transaction_pool: Arc<TransactionPool<C>>, transaction_pool: Arc<TransactionPool<C>>,
_drop_signal: exit_future::Signal,
} }
impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P> impl<C> bft::Proposer<Block> for Proposer<C>
where where
C: PolkadotApi + Send + Sync, C: PolkadotApi + Send + Sync,
R: TableRouter,
P: Collators,
{ {
type Error = Error; type Error = Error;
type Create = future::Either< type Create = future::Either<
CreateProposal<C, R, P>, CreateProposal<C>,
future::FutureResult<Block, Error>, future::FutureResult<Block, Error>,
>; >;
type Evaluate = Box<Future<Item=bool, Error=Error>>; type Evaluate = Box<Future<Item=bool, Error=Error>>;
@@ -339,32 +392,24 @@ impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P>
const ATTEMPT_PROPOSE_EVERY: Duration = Duration::from_millis(100); const ATTEMPT_PROPOSE_EVERY: Duration = Duration::from_millis(100);
let initial_included = self.table.includable_count(); let initial_included = self.table.includable_count();
let now = Instant::now();
let enough_candidates = self.dynamic_inclusion.acceptable_in( let enough_candidates = self.dynamic_inclusion.acceptable_in(
Instant::now(), now,
initial_included, initial_included,
).unwrap_or_default(); ).unwrap_or_else(|| now + Duration::from_millis(1));
let timing = { let minimum_delay = if self.minimum_delay > now + ATTEMPT_PROPOSE_EVERY {
let delay = self.delay.clone(); Some(Delay::new(self.minimum_delay))
let dynamic_inclusion = self.dynamic_inclusion.clone(); } else {
let make_timing = move |handle| -> Result<ProposalTiming, ::std::io::Error> { None
let attempt_propose = Interval::new(ATTEMPT_PROPOSE_EVERY, handle)?; };
let enough_candidates = Timeout::new(enough_candidates, handle)?;
Ok(ProposalTiming {
attempt_propose,
enough_candidates,
dynamic_inclusion,
minimum_delay: Some(delay),
last_included: initial_included,
})
};
match make_timing(&self.handle) { let timing = ProposalTiming {
Ok(timing) => timing, attempt_propose: Interval::new(now + ATTEMPT_PROPOSE_EVERY, ATTEMPT_PROPOSE_EVERY),
Err(e) => { enough_candidates: Delay::new(enough_candidates),
return future::Either::B(future::err(timer_error(&e))); dynamic_inclusion: self.dynamic_inclusion.clone(),
} minimum_delay,
} last_included: initial_included,
}; };
future::Either::A(CreateProposal { future::Either::A(CreateProposal {
@@ -373,15 +418,7 @@ impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P>
parent_id: self.parent_id.clone(), parent_id: self.parent_id.clone(),
client: self.client.clone(), client: self.client.clone(),
transaction_pool: self.transaction_pool.clone(), transaction_pool: self.transaction_pool.clone(),
collation: CollationFetch::new(
self.local_duty.validation,
self.parent_id.clone(),
self.parent_hash.clone(),
self.collators.clone(),
self.client.clone()
),
table: self.table.clone(), table: self.table.clone(),
router: self.router.clone(),
timing, timing,
}) })
} }
@@ -415,9 +452,7 @@ impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P>
}; };
let vote_delays = { let vote_delays = {
// delay casting vote until able (according to minimum block time) let now = Instant::now();
let minimum_delay = self.delay.clone()
.map_err(|e| timer_error(&*e));
let included_candidate_hashes = proposal let included_candidate_hashes = proposal
.parachain_heads() .parachain_heads()
@@ -431,33 +466,35 @@ impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P>
// the duration at which the given number of parachains is acceptable. // the duration at which the given number of parachains is acceptable.
let count_delay = self.dynamic_inclusion.acceptable_in( let count_delay = self.dynamic_inclusion.acceptable_in(
Instant::now(), now,
proposal.parachain_heads().len(), proposal.parachain_heads().len(),
); );
// the duration until the given timestamp is current // the duration until the given timestamp is current
let proposed_timestamp = proposal.timestamp(); let proposed_timestamp = proposal.timestamp();
let timestamp_delay = if proposed_timestamp > current_timestamp { let timestamp_delay = if proposed_timestamp > current_timestamp {
Some(Duration::from_secs(proposed_timestamp - current_timestamp)) Some(now + Duration::from_secs(proposed_timestamp - current_timestamp))
} else { } else {
None None
}; };
// delay casting vote until able according to minimum block time,
// timestamp delay, and count delay.
// construct a future from the maximum of the two durations. // construct a future from the maximum of the two durations.
let temporary_delay = match ::std::cmp::max(timestamp_delay, count_delay) { let max_delay = [timestamp_delay, count_delay, Some(self.minimum_delay)]
Some(duration) => { .iter()
let maybe_timeout = Timeout::new(duration, &self.handle); .cloned()
.max()
.expect("iterator not empty; thus max returns `Some`; qed");
let f = future::result(maybe_timeout) let temporary_delay = match max_delay {
.and_then(|timeout| timeout) Some(duration) => future::Either::A(
.map_err(|e| timer_error(&e)); Delay::new(duration).map_err(|e| Error::from(ErrorKind::Timer(e)))
),
future::Either::A(f)
}
None => future::Either::B(future::ok(())), None => future::Either::B(future::ok(())),
}; };
minimum_delay.join3(includability_tracker, temporary_delay) includability_tracker.join(temporary_delay)
}; };
// evaluate whether the block is actually valid. // evaluate whether the block is actually valid.
@@ -497,7 +534,7 @@ impl<C, R, P> bft::Proposer<Block> for Proposer<C, R, P>
use bft::generic::Misbehavior as GenericMisbehavior; use bft::generic::Misbehavior as GenericMisbehavior;
use runtime_primitives::bft::{MisbehaviorKind, MisbehaviorReport}; use runtime_primitives::bft::{MisbehaviorKind, MisbehaviorReport};
use runtime_primitives::MaybeUnsigned; use runtime_primitives::MaybeUnsigned;
use polkadot_runtime::{Call, Extrinsic, UncheckedExtrinsic, ConsensusCall}; use polkadot_runtime::{Call, Extrinsic, BareExtrinsic, UncheckedExtrinsic, ConsensusCall};
let local_id = self.local_key.public().0.into(); let local_id = self.local_key.public().0.into();
let mut next_index = { let mut next_index = {
@@ -569,71 +606,59 @@ fn current_timestamp() -> Timestamp {
struct ProposalTiming { struct ProposalTiming {
attempt_propose: Interval, attempt_propose: Interval,
dynamic_inclusion: DynamicInclusion, dynamic_inclusion: DynamicInclusion,
enough_candidates: Timeout, enough_candidates: Delay,
minimum_delay: Option<Shared<Timeout>>, minimum_delay: Option<Delay>,
last_included: usize, last_included: usize,
} }
impl ProposalTiming { impl ProposalTiming {
// whether it's time to attempt a proposal. // whether it's time to attempt a proposal.
// shouldn't be called outside of the context of a task. // shouldn't be called outside of the context of a task.
fn poll(&mut self, included: usize) -> Poll<(), Error> { fn poll(&mut self, included: usize) -> Poll<(), ErrorKind> {
// first drain from the interval so when the minimum delay is up // first drain from the interval so when the minimum delay is up
// we don't have any notifications built up. // we don't have any notifications built up.
// //
// this interval is just meant to produce periodic task wakeups // this interval is just meant to produce periodic task wakeups
// that lead to the `dynamic_inclusion` getting updated as necessary. // that lead to the `dynamic_inclusion` getting updated as necessary.
if let Async::Ready(x) = self.attempt_propose.poll() if let Async::Ready(x) = self.attempt_propose.poll().map_err(ErrorKind::Timer)? {
.map_err(|e| timer_error(&e))?
{
x.expect("timer still alive; intervals never end; qed"); x.expect("timer still alive; intervals never end; qed");
} }
if let Some(ref mut min) = self.minimum_delay { if let Some(ref mut min) = self.minimum_delay {
try_ready!(min.poll().map_err(|e| timer_error(&*e))); try_ready!(min.poll().map_err(ErrorKind::Timer));
} }
self.minimum_delay = None; // after this point, the future must have completed. self.minimum_delay = None; // after this point, the future must have completed.
if included == self.last_included { if included == self.last_included {
return self.enough_candidates.poll().map_err(|e| timer_error(&e)); return self.enough_candidates.poll().map_err(ErrorKind::Timer);
} }
// the amount of includable candidates has changed. schedule a wakeup // the amount of includable candidates has changed. schedule a wakeup
// if it's not sufficient anymore. // if it's not sufficient anymore.
let now = Instant::now(); match self.dynamic_inclusion.acceptable_in(Instant::now(), included) {
match self.dynamic_inclusion.acceptable_in(now, included) { Some(instant) => {
Some(duration) => {
self.last_included = included; self.last_included = included;
self.enough_candidates.reset(now + duration); self.enough_candidates.reset(instant);
self.enough_candidates.poll().map_err(|e| timer_error(&e)) self.enough_candidates.poll().map_err(ErrorKind::Timer)
}
None => {
Ok(Async::Ready(()))
} }
None => Ok(Async::Ready(())),
} }
} }
} }
/// Future which resolves upon the creation of a proposal. /// Future which resolves upon the creation of a proposal.
pub struct CreateProposal<C: PolkadotApi, R, P: Collators> { pub struct CreateProposal<C: PolkadotApi> {
parent_hash: Hash, parent_hash: Hash,
parent_number: BlockNumber, parent_number: BlockNumber,
parent_id: BlockId, parent_id: BlockId,
client: Arc<C>, client: Arc<C>,
transaction_pool: Arc<TransactionPool<C>>, transaction_pool: Arc<TransactionPool<C>>,
collation: CollationFetch<P, C>,
router: R,
table: Arc<SharedTable>, table: Arc<SharedTable>,
timing: ProposalTiming, timing: ProposalTiming,
} }
impl<C, R, P> CreateProposal<C, R, P> impl<C> CreateProposal<C> where C: PolkadotApi {
where
C: PolkadotApi,
R: TableRouter,
P: Collators,
{
fn propose_with(&self, candidates: Vec<CandidateReceipt>) -> Result<Block, Error> { fn propose_with(&self, candidates: Vec<CandidateReceipt>) -> Result<Block, Error> {
use polkadot_api::BlockBuilder; use polkadot_api::BlockBuilder;
use runtime_primitives::traits::{Hashing, BlakeTwo256}; use runtime_primitives::traits::{Hashing, BlakeTwo256};
@@ -702,35 +727,17 @@ impl<C, R, P> CreateProposal<C, R, P>
} }
} }
impl<C, R, P> Future for CreateProposal<C, R, P> impl<C> Future for CreateProposal<C> where C: PolkadotApi {
where
C: PolkadotApi,
R: TableRouter,
P: Collators,
{
type Item = Block; type Item = Block;
type Error = Error; type Error = Error;
fn poll(&mut self) -> Poll<Block, Error> { fn poll(&mut self) -> Poll<Block, Error> {
// 1. poll local collation future. // 1. try to propose if we have enough includable candidates and other
match self.collation.poll() {
Ok(Async::Ready((collation, extrinsic))) => {
let hash = collation.receipt.hash();
self.router.local_candidate_data(hash, collation.block_data, extrinsic);
// TODO: if we are an availability guarantor also, we should produce an availability statement.
self.table.sign_and_import(&self.router, GenericStatement::Candidate(collation.receipt));
}
Ok(Async::NotReady) => {},
Err(_) => {}, // TODO: handle this failure to collate.
}
// 2. try to propose if we have enough includable candidates and other
// delays have concluded. // delays have concluded.
let included = self.table.includable_count(); let included = self.table.includable_count();
try_ready!(self.timing.poll(included)); try_ready!(self.timing.poll(included));
// 3. propose // 2. propose
let proposed_candidates = self.table.with_proposal(|proposed_set| { let proposed_candidates = self.table.with_proposal(|proposed_set| {
proposed_set.into_iter().cloned().collect() proposed_set.into_iter().cloned().collect()
}); });
@@ -738,3 +745,21 @@ impl<C, R, P> Future for CreateProposal<C, R, P>
self.propose_with(proposed_candidates).map(Async::Ready) self.propose_with(proposed_candidates).map(Async::Ready)
} }
} }
#[cfg(test)]
mod tests {
use super::*;
use substrate_keyring::Keyring;
#[test]
fn sign_and_check_statement() {
let statement: Statement = GenericStatement::Valid([1; 32].into());
let parent_hash = [2; 32].into();
let sig = sign_table_statement(&statement, &Keyring::Alice.pair(), &parent_hash);
assert!(check_statement(&statement, &sig, Keyring::Alice.to_raw_public().into(), &parent_hash));
assert!(!check_statement(&statement, &sig, Keyring::Alice.to_raw_public().into(), &[0xff; 32].into()));
assert!(!check_statement(&statement, &sig, Keyring::Bob.to_raw_public().into(), &parent_hash));
}
}
+40 -235
View File
@@ -18,6 +18,10 @@
/// Consensus service. A long runnung service that manages BFT agreement and parachain /// Consensus service. A long runnung service that manages BFT agreement and parachain
/// candidate agreement over the network. /// candidate agreement over the network.
///
/// This uses a handle to an underlying thread pool to dispatch heavy work
/// such as candidate verification while performing event-driven work
/// on a local event loop.
use std::thread; use std::thread;
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
@@ -27,197 +31,37 @@ use bft::{self, BftService};
use client::{BlockchainEvents, ChainHead}; use client::{BlockchainEvents, ChainHead};
use ed25519; use ed25519;
use futures::prelude::*; use futures::prelude::*;
use futures::{future, Canceled};
use polkadot_api::LocalPolkadotApi; use polkadot_api::LocalPolkadotApi;
use polkadot_primitives::{BlockId, Block, Header, Hash, AccountId}; use polkadot_primitives::{Block, Header};
use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt};
use primitives::AuthorityId;
use runtime_support::Hashable;
use substrate_network as net;
use tokio_core::reactor;
use transaction_pool::TransactionPool; use transaction_pool::TransactionPool;
use super::{TableRouter, SharedTable, ProposerFactory}; use tokio::executor::current_thread::TaskExecutor as LocalThreadHandle;
use tokio::runtime::TaskExecutor as ThreadPoolHandle;
use tokio::runtime::current_thread::Runtime as LocalRuntime;
use tokio::timer::Interval;
use super::{Network, Collators, ProposerFactory};
use error; use error;
const TIMER_DELAY_MS: u64 = 5000; const TIMER_DELAY_MS: u64 = 5000;
const TIMER_INTERVAL_MS: u64 = 500; const TIMER_INTERVAL_MS: u64 = 500;
struct BftSink<E> { // spin up an instance of BFT agreement on the current thread's executor.
network: Arc<net::ConsensusService<Block>>, // panics if there is no current thread executor.
parent_hash: Hash,
_e: ::std::marker::PhantomData<E>,
}
struct Messages {
network_stream: net::BftMessageStream<Block>,
local_id: AuthorityId,
authorities: Vec<AuthorityId>,
}
impl Stream for Messages {
type Item = bft::Communication<Block>;
type Error = bft::Error;
fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
// check the network
loop {
match self.network_stream.poll() {
Err(_) => return Err(bft::InputStreamConcluded.into()),
Ok(Async::NotReady) => return Ok(Async::NotReady),
Ok(Async::Ready(None)) => return Ok(Async::NotReady), // the input stream for agreements is never meant to logically end.
Ok(Async::Ready(Some(message))) => {
match process_message(message, &self.local_id, &self.authorities) {
Ok(Some(message)) => return Ok(Async::Ready(Some(message))),
Ok(None) => {} // ignored local message.
Err(e) => {
debug!("Message validation failed: {:?}", e);
}
}
}
}
}
}
}
fn process_message(msg: net::LocalizedBftMessage<Block>, local_id: &AuthorityId, authorities: &[AuthorityId]) -> Result<Option<bft::Communication<Block>>, bft::Error> {
Ok(Some(match msg.message {
net::generic_message::BftMessage::Consensus(c) => bft::generic::Communication::Consensus(match c {
net::generic_message::SignedConsensusMessage::Propose(proposal) => bft::generic::LocalizedMessage::Propose({
if &proposal.sender == local_id { return Ok(None) }
let proposal = bft::generic::LocalizedProposal {
round_number: proposal.round_number as usize,
proposal: proposal.proposal,
digest: proposal.digest,
sender: proposal.sender,
digest_signature: ed25519::LocalizedSignature {
signature: proposal.digest_signature,
signer: proposal.sender.into(),
},
full_signature: ed25519::LocalizedSignature {
signature: proposal.full_signature,
signer: proposal.sender.into(),
}
};
bft::check_proposal(authorities, &msg.parent_hash, &proposal)?;
trace!(target: "bft", "importing proposal message for round {} from {}", proposal.round_number, proposal.sender);
proposal
}),
net::generic_message::SignedConsensusMessage::Vote(vote) => bft::generic::LocalizedMessage::Vote({
if &vote.sender == local_id { return Ok(None) }
let vote = bft::generic::LocalizedVote {
sender: vote.sender,
signature: ed25519::LocalizedSignature {
signature: vote.signature,
signer: vote.sender.into(),
},
vote: match vote.vote {
net::generic_message::ConsensusVote::Prepare(r, h) => bft::generic::Vote::Prepare(r as usize, h),
net::generic_message::ConsensusVote::Commit(r, h) => bft::generic::Vote::Commit(r as usize, h),
net::generic_message::ConsensusVote::AdvanceRound(r) => bft::generic::Vote::AdvanceRound(r as usize),
}
};
bft::check_vote::<Block>(authorities, &msg.parent_hash, &vote)?;
trace!(target: "bft", "importing vote {:?} from {}", vote.vote, vote.sender);
vote
}),
}),
net::generic_message::BftMessage::Auxiliary(a) => {
let justification = bft::UncheckedJustification::<Hash>::from(a);
// TODO: get proper error
let justification: Result<_, bft::Error> = bft::check_prepare_justification::<Block>(authorities, msg.parent_hash, justification)
.map_err(|_| bft::ErrorKind::InvalidJustification.into());
bft::generic::Communication::Auxiliary(justification?)
},
}))
}
impl<E> Sink for BftSink<E> {
type SinkItem = bft::Communication<Block>;
// TODO: replace this with the ! type when that's stabilized
type SinkError = E;
fn start_send(&mut self, message: bft::Communication<Block>) -> ::futures::StartSend<bft::Communication<Block>, E> {
let network_message = net::generic_message::LocalizedBftMessage {
message: match message {
bft::generic::Communication::Consensus(c) => net::generic_message::BftMessage::Consensus(match c {
bft::generic::LocalizedMessage::Propose(proposal) => net::generic_message::SignedConsensusMessage::Propose(net::generic_message::SignedConsensusProposal {
round_number: proposal.round_number as u32,
proposal: proposal.proposal,
digest: proposal.digest,
sender: proposal.sender,
digest_signature: proposal.digest_signature.signature,
full_signature: proposal.full_signature.signature,
}),
bft::generic::LocalizedMessage::Vote(vote) => net::generic_message::SignedConsensusMessage::Vote(net::generic_message::SignedConsensusVote {
sender: vote.sender,
signature: vote.signature.signature,
vote: match vote.vote {
bft::generic::Vote::Prepare(r, h) => net::generic_message::ConsensusVote::Prepare(r as u32, h),
bft::generic::Vote::Commit(r, h) => net::generic_message::ConsensusVote::Commit(r as u32, h),
bft::generic::Vote::AdvanceRound(r) => net::generic_message::ConsensusVote::AdvanceRound(r as u32),
}
}),
}),
bft::generic::Communication::Auxiliary(justification) => net::generic_message::BftMessage::Auxiliary(justification.uncheck().into()),
},
parent_hash: self.parent_hash,
};
self.network.send_bft_message(network_message);
Ok(::futures::AsyncSink::Ready)
}
fn poll_complete(&mut self) -> ::futures::Poll<(), E> {
Ok(Async::Ready(()))
}
}
struct Network(Arc<net::ConsensusService<Block>>);
impl super::Network for Network {
type TableRouter = Router;
fn table_router(&self, _table: Arc<SharedTable>) -> Self::TableRouter {
Router {
network: self.0.clone()
}
}
}
fn start_bft<F, C>( fn start_bft<F, C>(
header: &Header, header: &Header,
handle: reactor::Handle,
client: &bft::Authorities<Block>,
network: Arc<net::ConsensusService<Block>>,
bft_service: &BftService<Block, F, C>, bft_service: &BftService<Block, F, C>,
) where ) where
F: bft::ProposerFactory<Block> + 'static, F: bft::Environment<Block> + 'static,
C: bft::BlockImport<Block> + bft::Authorities<Block> + 'static, C: bft::BlockImport<Block> + bft::Authorities<Block> + 'static,
<F as bft::ProposerFactory<Block>>::Error: ::std::fmt::Debug, F::Error: ::std::fmt::Debug,
<F::Proposer as bft::Proposer<Block>>::Error: ::std::fmt::Display + Into<error::Error>, <F::Proposer as bft::Proposer<Block>>::Error: ::std::fmt::Display + Into<error::Error>,
{ {
let parent_hash = header.hash(); let mut handle = LocalThreadHandle::current();
if bft_service.live_agreement().map_or(false, |h| h == parent_hash) { match bft_service.build_upon(&header) {
return; Ok(Some(bft)) => if let Err(e) = handle.spawn_local(Box::new(bft)) {
} debug!(target: "bft", "Couldn't initialize BFT agreement: {:?}", e);
let authorities = match client.authorities(&BlockId::hash(parent_hash)) { },
Ok(authorities) => authorities,
Err(e) => {
debug!("Error reading authorities: {:?}", e);
return;
}
};
let input = Messages {
network_stream: network.bft_messages(parent_hash),
local_id: bft_service.local_id(),
authorities,
};
let output = BftSink { network: network, parent_hash: parent_hash, _e: Default::default() };
match bft_service.build_upon(&header, input.map_err(Into::into), output) {
Ok(Some(bft)) => handle.spawn(bft),
Ok(None) => {}, Ok(None) => {},
Err(e) => debug!(target: "bft", "BFT agreement error: {:?}", e), Err(e) => debug!(target: "bft", "BFT agreement error: {:?}", e),
} }
@@ -231,54 +75,56 @@ pub struct Service {
impl Service { impl Service {
/// Create and start a new instance. /// Create and start a new instance.
pub fn new<A, C>( pub fn new<A, C, N>(
client: Arc<C>, client: Arc<C>,
api: Arc<A>, api: Arc<A>,
network: Arc<net::ConsensusService<Block>>, network: N,
transaction_pool: Arc<TransactionPool<A>>, transaction_pool: Arc<TransactionPool<A>>,
thread_pool: ThreadPoolHandle,
parachain_empty_duration: Duration, parachain_empty_duration: Duration,
key: ed25519::Pair, key: ed25519::Pair,
) -> Service ) -> Service
where where
A: LocalPolkadotApi + Send + Sync + 'static, A: LocalPolkadotApi + Send + Sync + 'static,
C: BlockchainEvents<Block> + ChainHead<Block> + bft::BlockImport<Block> + bft::Authorities<Block> + Send + Sync + 'static, C: BlockchainEvents<Block> + ChainHead<Block> + bft::BlockImport<Block> + bft::Authorities<Block> + Send + Sync + 'static,
N: Network + Collators + Send + 'static,
N::TableRouter: Send + 'static,
<N::Collation as IntoFuture>::Future: Send + 'static,
{ {
let (signal, exit) = ::exit_future::signal(); let (signal, exit) = ::exit_future::signal();
let thread = thread::spawn(move || { let thread = thread::spawn(move || {
let mut core = reactor::Core::new().expect("tokio::Core could not be created"); let mut runtime = LocalRuntime::new().expect("Could not create local runtime");
let key = Arc::new(key); let key = Arc::new(key);
let factory = ProposerFactory { let factory = ProposerFactory {
client: api.clone(), client: api.clone(),
transaction_pool: transaction_pool.clone(), transaction_pool: transaction_pool.clone(),
network: Network(network.clone()), collators: network.clone(),
collators: NoCollators, network,
parachain_empty_duration, parachain_empty_duration,
handle: core.handle(), handle: thread_pool,
}; };
let bft_service = Arc::new(BftService::new(client.clone(), key, factory)); let bft_service = Arc::new(BftService::new(client.clone(), key, factory));
let notifications = { let notifications = {
let handle = core.handle();
let network = network.clone();
let client = client.clone(); let client = client.clone();
let bft_service = bft_service.clone(); let bft_service = bft_service.clone();
client.import_notification_stream().for_each(move |notification| { client.import_notification_stream().for_each(move |notification| {
if notification.is_new_best { if notification.is_new_best {
start_bft(&notification.header, handle.clone(), &*client, network.clone(), &*bft_service); start_bft(&notification.header, &*bft_service);
} }
Ok(()) Ok(())
}) })
}; };
let interval = reactor::Interval::new_at( let interval = Interval::new(
Instant::now() + Duration::from_millis(TIMER_DELAY_MS), Instant::now() + Duration::from_millis(TIMER_DELAY_MS),
Duration::from_millis(TIMER_INTERVAL_MS), Duration::from_millis(TIMER_INTERVAL_MS),
&core.handle(), );
).expect("it is always possible to create an interval with valid params");
let mut prev_best = match client.best_block_header() { let mut prev_best = match client.best_block_header() {
Ok(header) => header.blake2_256(), Ok(header) => header.hash(),
Err(e) => { Err(e) => {
warn!("Cant's start consensus service. Error reading best block header: {:?}", e); warn!("Cant's start consensus service. Error reading best block header: {:?}", e);
return; return;
@@ -288,15 +134,13 @@ impl Service {
let timed = { let timed = {
let c = client.clone(); let c = client.clone();
let s = bft_service.clone(); let s = bft_service.clone();
let n = network.clone();
let handle = core.handle();
interval.map_err(|e| debug!("Timer error: {:?}", e)).for_each(move |_| { interval.map_err(|e| debug!("Timer error: {:?}", e)).for_each(move |_| {
if let Ok(best_block) = c.best_block_header() { if let Ok(best_block) = c.best_block_header() {
let hash = best_block.blake2_256(); let hash = best_block.hash();
if hash == prev_best { if hash == prev_best {
debug!("Starting consensus round after a timeout"); debug!("Starting consensus round after a timeout");
start_bft(&best_block, handle.clone(), &*c, n.clone(), &*s); start_bft(&best_block, &*s);
} }
prev_best = hash; prev_best = hash;
} }
@@ -304,9 +148,9 @@ impl Service {
}) })
}; };
core.handle().spawn(notifications); runtime.spawn(notifications);
core.handle().spawn(timed); runtime.spawn(timed);
if let Err(e) = core.run(exit) { if let Err(e) = runtime.block_on(exit) {
debug!("BFT event loop error {:?}", e); debug!("BFT event loop error {:?}", e);
} }
}); });
@@ -328,42 +172,3 @@ impl Drop for Service {
} }
} }
} }
// Collators implementation which never collates anything.
// TODO: do a real implementation.
#[derive(Clone, Copy)]
struct NoCollators;
impl ::collation::Collators for NoCollators {
type Error = ();
type Collation = future::Empty<::collation::Collation, ()>;
fn collate(&self, _parachain: ParaId, _relay_parent: Hash) -> Self::Collation {
future::empty()
}
fn note_bad_collator(&self, _collator: AccountId) { }
}
#[derive(Clone)]
struct Router {
network: Arc<net::ConsensusService<Block>>,
}
impl TableRouter for Router {
type Error = Canceled;
type FetchCandidate = future::Empty<BlockData, Self::Error>;
type FetchExtrinsic = future::FutureResult<Extrinsic, Self::Error>;
fn local_candidate_data(&self, _hash: Hash, _block_data: BlockData, _extrinsic: Extrinsic) {
// TODO
}
fn fetch_block_data(&self, _candidate: &CandidateReceipt) -> Self::FetchCandidate {
future::empty()
}
fn fetch_extrinsic_data(&self, _candidate: &CandidateReceipt) -> Self::FetchExtrinsic {
future::ok(Extrinsic)
}
}
@@ -21,11 +21,9 @@ use std::collections::{HashMap, HashSet};
use std::sync::Arc; use std::sync::Arc;
use table::{self, Table, Context as TableContextTrait}; use table::{self, Table, Context as TableContextTrait};
use table::generic::Statement as GenericStatement;
use collation::Collation; use collation::Collation;
use polkadot_primitives::Hash; use polkadot_primitives::{Hash, SessionKey};
use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt}; use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt};
use primitives::AuthorityId;
use parking_lot::Mutex; use parking_lot::Mutex;
use futures::{future, prelude::*}; use futures::{future, prelude::*};
@@ -36,6 +34,8 @@ use self::includable::IncludabilitySender;
mod includable; mod includable;
pub use self::includable::Includable; pub use self::includable::Includable;
pub use table::{SignedStatement, Statement};
pub use table::generic::Statement as GenericStatement;
struct TableContext { struct TableContext {
parent_hash: Hash, parent_hash: Hash,
@@ -44,11 +44,11 @@ struct TableContext {
} }
impl table::Context for TableContext { impl table::Context for TableContext {
fn is_member_of(&self, authority: &AuthorityId, group: &ParaId) -> bool { fn is_member_of(&self, authority: &SessionKey, group: &ParaId) -> bool {
self.groups.get(group).map_or(false, |g| g.validity_guarantors.contains(authority)) self.groups.get(group).map_or(false, |g| g.validity_guarantors.contains(authority))
} }
fn is_availability_guarantor_of(&self, authority: &AuthorityId, group: &ParaId) -> bool { fn is_availability_guarantor_of(&self, authority: &SessionKey, group: &ParaId) -> bool {
self.groups.get(group).map_or(false, |g| g.availability_guarantors.contains(authority)) self.groups.get(group).map_or(false, |g| g.availability_guarantors.contains(authority))
} }
@@ -61,7 +61,7 @@ impl table::Context for TableContext {
} }
impl TableContext { impl TableContext {
fn local_id(&self) -> AuthorityId { fn local_id(&self) -> SessionKey {
self.key.public().into() self.key.public().into()
} }
@@ -76,14 +76,6 @@ impl TableContext {
} }
} }
/// Source of statements
pub enum StatementSource {
/// Locally produced statement.
Local,
/// Received statement from remote source, with optional sender.
Remote(Option<AuthorityId>),
}
// A shared table object. // A shared table object.
struct SharedTableInner { struct SharedTableInner {
table: Table<TableContext>, table: Table<TableContext>,
@@ -96,28 +88,21 @@ struct SharedTableInner {
impl SharedTableInner { impl SharedTableInner {
// Import a single statement. Provide a handle to a table router and a function // Import a single statement. Provide a handle to a table router and a function
// used to determine if a referenced candidate is valid. // used to determine if a referenced candidate is valid.
fn import_statement<R: TableRouter, C: FnMut(Collation) -> bool>( //
// the statement producer, if any, will produce only statements concerning the same candidate
// as the one just imported
fn import_remote_statement<R: TableRouter>(
&mut self, &mut self,
context: &TableContext, context: &TableContext,
router: &R, router: &R,
statement: table::SignedStatement, statement: table::SignedStatement,
statement_source: StatementSource, ) -> Option<StatementProducer<
check_candidate: C,
) -> StatementProducer<
<R::FetchCandidate as IntoFuture>::Future, <R::FetchCandidate as IntoFuture>::Future,
<R::FetchExtrinsic as IntoFuture>::Future, <R::FetchExtrinsic as IntoFuture>::Future,
C, >> {
> { let summary = match self.table.import_statement(context, statement) {
// this blank producer does nothing until we attach some futures
// and set a candidate digest.
let received_from = match statement_source {
StatementSource::Local => return Default::default(),
StatementSource::Remote(from) => from,
};
let summary = match self.table.import_statement(context, statement, received_from) {
Some(summary) => summary, Some(summary) => summary,
None => return Default::default(), None => return None,
}; };
self.update_trackers(&summary.candidate, context); self.update_trackers(&summary.candidate, context);
@@ -159,7 +144,6 @@ impl SharedTableInner {
fetch_block_data, fetch_block_data,
fetch_extrinsic, fetch_extrinsic,
evaluate: checking_validity, evaluate: checking_validity,
check_candidate,
}) })
} }
} }
@@ -167,10 +151,10 @@ impl SharedTableInner {
None None
}; };
StatementProducer { work.map(|work| StatementProducer {
produced_statements: Default::default(), produced_statements: Default::default(),
work, work
} })
} }
fn update_trackers(&mut self, candidate: &Hash, context: &TableContext) { fn update_trackers(&mut self, candidate: &Hash, context: &TableContext) {
@@ -199,71 +183,78 @@ pub struct ProducedStatements {
} }
/// Future that produces statements about a specific candidate. /// Future that produces statements about a specific candidate.
pub struct StatementProducer<D: Future, E: Future, C> { pub struct StatementProducer<D: Future, E: Future> {
produced_statements: ProducedStatements, produced_statements: ProducedStatements,
work: Option<Work<D, E, C>>, work: Work<D, E>,
} }
struct Work<D: Future, E: Future, C> { impl<D: Future, E: Future> StatementProducer<D, E> {
candidate_receipt: CandidateReceipt, /// Attach a function for verifying fetched collation to the statement producer.
fetch_block_data: future::Fuse<D>, /// This will transform it into a future.
fetch_extrinsic: Option<future::Fuse<E>>, ///
evaluate: bool, /// The collation-checking function should return `true` if known to be valid,
check_candidate: C /// `false` if known to be invalid, and `None` if unable to determine.
} pub fn prime<C: FnMut(Collation) -> Option<bool>>(self, check_candidate: C) -> PrimedStatementProducer<D, E, C> {
PrimedStatementProducer {
impl<D: Future, E: Future, C> Default for StatementProducer<D, E, C> { inner: self,
fn default() -> Self { check_candidate,
StatementProducer {
produced_statements: Default::default(),
work: None,
} }
} }
} }
impl<D, E, C, Err> Future for StatementProducer<D, E, C> struct Work<D: Future, E: Future> {
candidate_receipt: CandidateReceipt,
fetch_block_data: future::Fuse<D>,
fetch_extrinsic: Option<future::Fuse<E>>,
evaluate: bool,
}
/// Primed statement producer.
pub struct PrimedStatementProducer<D: Future, E: Future, C> {
inner: StatementProducer<D, E>,
check_candidate: C,
}
impl<D, E, C, Err> Future for PrimedStatementProducer<D, E, C>
where where
D: Future<Item=BlockData,Error=Err>, D: Future<Item=BlockData,Error=Err>,
E: Future<Item=Extrinsic,Error=Err>, E: Future<Item=Extrinsic,Error=Err>,
C: FnMut(Collation) -> bool, C: FnMut(Collation) -> Option<bool>,
{ {
type Item = ProducedStatements; type Item = ProducedStatements;
type Error = Err; type Error = Err;
fn poll(&mut self) -> Poll<ProducedStatements, Err> { fn poll(&mut self) -> Poll<ProducedStatements, Err> {
let work = match self.work { let work = &mut self.inner.work;
Some(ref mut work) => work,
None => return Ok(Async::Ready(::std::mem::replace(&mut self.produced_statements, Default::default()))),
};
if let Async::Ready(block_data) = work.fetch_block_data.poll()? { if let Async::Ready(block_data) = work.fetch_block_data.poll()? {
self.produced_statements.block_data = Some(block_data.clone()); self.inner.produced_statements.block_data = Some(block_data.clone());
if work.evaluate { if work.evaluate {
let is_good = (work.check_candidate)(Collation { let is_good = (self.check_candidate)(Collation {
block_data, block_data,
receipt: work.candidate_receipt.clone(), receipt: work.candidate_receipt.clone(),
}); });
let hash = work.candidate_receipt.hash(); let hash = work.candidate_receipt.hash();
self.produced_statements.validity = Some(if is_good { self.inner.produced_statements.validity = match is_good {
GenericStatement::Valid(hash) Some(true) => Some(GenericStatement::Valid(hash)),
} else { Some(false) => Some(GenericStatement::Invalid(hash)),
GenericStatement::Invalid(hash) None => None,
}); };
} }
} }
if let Some(ref mut fetch_extrinsic) = work.fetch_extrinsic { if let Some(ref mut fetch_extrinsic) = work.fetch_extrinsic {
if let Async::Ready(extrinsic) = fetch_extrinsic.poll()? { if let Async::Ready(extrinsic) = fetch_extrinsic.poll()? {
self.produced_statements.extrinsic = Some(extrinsic); self.inner.produced_statements.extrinsic = Some(extrinsic);
} }
} }
let done = self.produced_statements.block_data.is_some() && { let done = self.inner.produced_statements.block_data.is_some() && {
if work.evaluate { if work.evaluate {
true true
} else if self.produced_statements.extrinsic.is_some() { } else if self.inner.produced_statements.extrinsic.is_some() {
self.produced_statements.availability = self.inner.produced_statements.availability =
Some(GenericStatement::Available(work.candidate_receipt.hash())); Some(GenericStatement::Available(work.candidate_receipt.hash()));
true true
@@ -273,7 +264,7 @@ impl<D, E, C, Err> Future for StatementProducer<D, E, C>
}; };
if done { if done {
Ok(Async::Ready(::std::mem::replace(&mut self.produced_statements, Default::default()))) Ok(Async::Ready(::std::mem::replace(&mut self.inner.produced_statements, Default::default())))
} else { } else {
Ok(Async::NotReady) Ok(Async::NotReady)
} }
@@ -313,29 +304,60 @@ impl SharedTable {
} }
} }
/// Get the parent hash this table should hold statements localized to.
pub fn consensus_parent_hash(&self) -> &Hash {
&self.context.parent_hash
}
/// Get the local validator session key.
pub fn session_key(&self) -> SessionKey {
self.context.local_id()
}
/// Get group info. /// Get group info.
pub fn group_info(&self) -> &HashMap<ParaId, GroupInfo> { pub fn group_info(&self) -> &HashMap<ParaId, GroupInfo> {
&self.context.groups &self.context.groups
} }
/// Import a single statement. Provide a handle to a table router /// Import a single statement with remote source, whose signature has already been checked.
/// for dispatching any other requests which come up. ///
pub fn import_statement<R: TableRouter, C: FnMut(Collation) -> bool>( /// The statement producer, if any, will produce only statements concerning the same candidate
/// as the one just imported
pub fn import_remote_statement<R: TableRouter>(
&self, &self,
router: &R, router: &R,
statement: table::SignedStatement, statement: table::SignedStatement,
received_from: StatementSource, ) -> Option<StatementProducer<
check_candidate: C, <R::FetchCandidate as IntoFuture>::Future,
) -> StatementProducer<<R::FetchCandidate as IntoFuture>::Future, <R::FetchExtrinsic as IntoFuture>::Future, C> { <R::FetchExtrinsic as IntoFuture>::Future,
self.inner.lock().import_statement(&*self.context, router, statement, received_from, check_candidate) >> {
self.inner.lock().import_remote_statement(&*self.context, router, statement)
}
/// Import many statements at once.
///
/// Provide an iterator yielding remote, pre-checked statements.
///
/// The statement producer, if any, will produce only statements concerning the same candidate
/// as the one just imported
pub fn import_remote_statements<R, I, U>(&self, router: &R, iterable: I) -> U
where
R: TableRouter,
I: IntoIterator<Item=table::SignedStatement>,
U: ::std::iter::FromIterator<Option<StatementProducer<
<R::FetchCandidate as IntoFuture>::Future,
<R::FetchExtrinsic as IntoFuture>::Future,
>>>,
{
let mut inner = self.inner.lock();
iterable.into_iter().map(move |statement| {
inner.import_remote_statement(&*self.context, router, statement)
}).collect()
} }
/// Sign and import a local statement. /// Sign and import a local statement.
pub fn sign_and_import<R: TableRouter>( pub fn sign_and_import(&self, statement: table::Statement) -> SignedStatement {
&self,
router: &R,
statement: table::Statement,
) {
let proposed_digest = match statement { let proposed_digest = match statement {
GenericStatement::Candidate(ref c) => Some(c.hash()), GenericStatement::Candidate(ref c) => Some(c.hash()),
_ => None, _ => None,
@@ -348,36 +370,8 @@ impl SharedTable {
inner.proposed_digest = proposed_digest; inner.proposed_digest = proposed_digest;
} }
let producer = inner.import_statement( inner.table.import_statement(&*self.context, signed_statement.clone());
&*self.context, signed_statement
router,
signed_statement,
StatementSource::Local,
|_| true,
);
assert!(producer.work.is_none(), "local statement import never leads to additional work; qed");
}
/// Import many statements at once.
///
/// Provide an iterator yielding pairs of (statement, statement_source).
pub fn import_statements<R, I, C, U>(&self, router: &R, iterable: I) -> U
where
R: TableRouter,
I: IntoIterator<Item=(table::SignedStatement, StatementSource, C)>,
C: FnMut(Collation) -> bool,
U: ::std::iter::FromIterator<StatementProducer<
<R::FetchCandidate as IntoFuture>::Future,
<R::FetchExtrinsic as IntoFuture>::Future,
C,
>>,
{
let mut inner = self.inner.lock();
iterable.into_iter().map(move |(statement, statement_source, check_candidate)| {
inner.import_statement(&*self.context, router, statement, statement_source, check_candidate)
}).collect()
} }
/// Execute a closure using a specific candidate. /// Execute a closure using a specific candidate.
@@ -406,15 +400,10 @@ impl SharedTable {
} }
/// Get all witnessed misbehavior. /// Get all witnessed misbehavior.
pub fn get_misbehavior(&self) -> HashMap<AuthorityId, table::Misbehavior> { pub fn get_misbehavior(&self) -> HashMap<SessionKey, table::Misbehavior> {
self.inner.lock().table.get_misbehavior().clone() self.inner.lock().table.get_misbehavior().clone()
} }
/// Fill a statement batch.
pub fn fill_batch<B: table::StatementBatch>(&self, batch: &mut B) {
self.inner.lock().table.fill_batch(batch);
}
/// Track includability of a given set of candidate hashes. /// Track includability of a given set of candidate hashes.
pub fn track_includability<I>(&self, iterable: I) -> Includable pub fn track_includability<I>(&self, iterable: I) -> Includable
where I: IntoIterator<Item=Hash> where I: IntoIterator<Item=Hash>
@@ -446,17 +435,12 @@ mod tests {
type FetchCandidate = ::futures::future::Empty<BlockData,()>; type FetchCandidate = ::futures::future::Empty<BlockData,()>;
type FetchExtrinsic = ::futures::future::Empty<Extrinsic,()>; type FetchExtrinsic = ::futures::future::Empty<Extrinsic,()>;
/// Note local candidate data, making it available on the network to other validators. fn local_candidate(&self, _candidate: CandidateReceipt, _block_data: BlockData, _extrinsic: Extrinsic) {
fn local_candidate_data(&self, _hash: Hash, _block_data: BlockData, _extrinsic: Extrinsic) {
} }
/// Fetch block data for a specific candidate.
fn fetch_block_data(&self, _candidate: &CandidateReceipt) -> Self::FetchCandidate { fn fetch_block_data(&self, _candidate: &CandidateReceipt) -> Self::FetchCandidate {
::futures::future::empty() ::futures::future::empty()
} }
/// Fetch extrinsic data for a specific candidate.
fn fetch_extrinsic_data(&self, _candidate: &CandidateReceipt) -> Self::FetchExtrinsic { fn fetch_extrinsic_data(&self, _candidate: &CandidateReceipt) -> Self::FetchExtrinsic {
::futures::future::empty() ::futures::future::empty()
} }
@@ -490,6 +474,7 @@ mod tests {
balance_uploads: Vec::new(), balance_uploads: Vec::new(),
egress_queue_roots: Vec::new(), egress_queue_roots: Vec::new(),
fees: 1_000_000, fees: 1_000_000,
block_data_hash: [2; 32].into(),
}; };
let candidate_statement = GenericStatement::Candidate(candidate); let candidate_statement = GenericStatement::Candidate(candidate);
@@ -501,15 +486,13 @@ mod tests {
sender: validity_other, sender: validity_other,
}; };
let producer = shared_table.import_statement( let producer = shared_table.import_remote_statement(
&DummyRouter, &DummyRouter,
signed_statement, signed_statement,
StatementSource::Remote(None), ).expect("candidate and local validity group are same");
|_| true,
);
assert!(producer.work.is_some(), "candidate and local validity group are same"); assert!(producer.work.evaluate, "should evaluate validity");
assert!(producer.work.as_ref().unwrap().evaluate, "should evaluate validity"); assert!(producer.work.fetch_extrinsic.is_none(), "should not fetch extrinsic");
} }
#[test] #[test]
@@ -540,6 +523,7 @@ mod tests {
balance_uploads: Vec::new(), balance_uploads: Vec::new(),
egress_queue_roots: Vec::new(), egress_queue_roots: Vec::new(),
fees: 1_000_000, fees: 1_000_000,
block_data_hash: [2; 32].into(),
}; };
let candidate_statement = GenericStatement::Candidate(candidate); let candidate_statement = GenericStatement::Candidate(candidate);
@@ -551,15 +535,12 @@ mod tests {
sender: validity_other, sender: validity_other,
}; };
let producer = shared_table.import_statement( let producer = shared_table.import_remote_statement(
&DummyRouter, &DummyRouter,
signed_statement, signed_statement,
StatementSource::Remote(None), ).expect("should produce work");
|_| true,
);
assert!(producer.work.is_some(), "candidate and local availability group are same"); assert!(producer.work.fetch_extrinsic.is_some(), "should fetch extrinsic when guaranteeing availability");
assert!(producer.work.as_ref().unwrap().fetch_extrinsic.is_some(), "should fetch extrinsic when guaranteeing availability"); assert!(!producer.work.evaluate, "should not evaluate validity");
assert!(!producer.work.as_ref().unwrap().evaluate, "should not evaluate validity");
} }
} }
+22
View File
@@ -0,0 +1,22 @@
[package]
name = "polkadot-network"
version = "0.1.0"
authors = ["Parity Technologies <admin@parity.io>"]
description = "Polkadot-specific networking protocol"
[dependencies]
serde = "1.0"
serde_derive = "1.0"
serde_json = "1.0"
parking_lot = "0.4"
polkadot-api = { path = "../api" }
polkadot-consensus = { path = "../consensus" }
polkadot-primitives = { path = "../primitives" }
substrate-bft = { path = "../../substrate/bft" }
substrate-codec = { path = "../../substrate/codec" }
substrate-network = { path = "../../substrate/network" }
substrate-primitives = { path = "../../substrate/primitives" }
ed25519 = { path = "../../substrate/ed25519" }
futures = "0.1"
tokio = "0.1.7"
log = "0.4"
+313
View File
@@ -0,0 +1,313 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! The "consensus" networking code built on top of the base network service.
//! This fulfills the `polkadot_consensus::Network` trait, providing a hook to be called
//! each time consensus begins on a new chain head.
use bft;
use ed25519;
use substrate_network::{self as net, generic_message as msg};
use substrate_network::consensus_gossip::ConsensusMessage;
use polkadot_api::{PolkadotApi, LocalPolkadotApi};
use polkadot_consensus::{Network, SharedTable, Collators, Collation};
use polkadot_primitives::{AccountId, Block, Hash, SessionKey};
use polkadot_primitives::parachain::Id as ParaId;
use futures::{future, prelude::*};
use futures::sync::mpsc;
use std::sync::Arc;
use tokio::runtime::TaskExecutor;
use parking_lot::Mutex;
use super::{Message, NetworkService, Knowledge, CurrentConsensus};
use router::Router;
/// Sink for output BFT messages.
pub struct BftSink<E> {
network: Arc<NetworkService>,
parent_hash: Hash,
_marker: ::std::marker::PhantomData<E>,
}
impl<E> Sink for BftSink<E> {
type SinkItem = bft::Communication<Block>;
// TODO: replace this with the ! type when that's stabilized
type SinkError = E;
fn start_send(&mut self, message: bft::Communication<Block>) -> ::futures::StartSend<bft::Communication<Block>, E> {
let network_message = net::LocalizedBftMessage {
message: match message {
bft::generic::Communication::Consensus(c) => msg::BftMessage::Consensus(match c {
bft::generic::LocalizedMessage::Propose(proposal) => msg::SignedConsensusMessage::Propose(msg::SignedConsensusProposal {
round_number: proposal.round_number as u32,
proposal: proposal.proposal,
digest: proposal.digest,
sender: proposal.sender,
digest_signature: proposal.digest_signature.signature,
full_signature: proposal.full_signature.signature,
}),
bft::generic::LocalizedMessage::Vote(vote) => msg::SignedConsensusMessage::Vote(msg::SignedConsensusVote {
sender: vote.sender,
signature: vote.signature.signature,
vote: match vote.vote {
bft::generic::Vote::Prepare(r, h) => msg::ConsensusVote::Prepare(r as u32, h),
bft::generic::Vote::Commit(r, h) => msg::ConsensusVote::Commit(r as u32, h),
bft::generic::Vote::AdvanceRound(r) => msg::ConsensusVote::AdvanceRound(r as u32),
}
}),
}),
bft::generic::Communication::Auxiliary(justification) => msg::BftMessage::Auxiliary(justification.uncheck().into()),
},
parent_hash: self.parent_hash,
};
self.network.with_spec(
move |spec, ctx| spec.consensus_gossip.multicast_bft_message(ctx, network_message)
);
Ok(::futures::AsyncSink::Ready)
}
fn poll_complete(&mut self) -> ::futures::Poll<(), E> {
Ok(Async::Ready(()))
}
}
// check signature and authority validity of message.
fn process_bft_message(msg: msg::LocalizedBftMessage<Block, Hash>, local_id: &SessionKey, authorities: &[SessionKey]) -> Result<Option<bft::Communication<Block>>, bft::Error> {
Ok(Some(match msg.message {
msg::BftMessage::Consensus(c) => bft::generic::Communication::Consensus(match c {
msg::SignedConsensusMessage::Propose(proposal) => bft::generic::LocalizedMessage::Propose({
if &proposal.sender == local_id { return Ok(None) }
let proposal = bft::generic::LocalizedProposal {
round_number: proposal.round_number as usize,
proposal: proposal.proposal,
digest: proposal.digest,
sender: proposal.sender,
digest_signature: ed25519::LocalizedSignature {
signature: proposal.digest_signature,
signer: ed25519::Public(proposal.sender.into()),
},
full_signature: ed25519::LocalizedSignature {
signature: proposal.full_signature,
signer: ed25519::Public(proposal.sender.into()),
}
};
bft::check_proposal(authorities, &msg.parent_hash, &proposal)?;
trace!(target: "bft", "importing proposal message for round {} from {}", proposal.round_number, Hash::from(proposal.sender.0));
proposal
}),
msg::SignedConsensusMessage::Vote(vote) => bft::generic::LocalizedMessage::Vote({
if &vote.sender == local_id { return Ok(None) }
let vote = bft::generic::LocalizedVote {
sender: vote.sender,
signature: ed25519::LocalizedSignature {
signature: vote.signature,
signer: ed25519::Public(vote.sender.0),
},
vote: match vote.vote {
msg::ConsensusVote::Prepare(r, h) => bft::generic::Vote::Prepare(r as usize, h),
msg::ConsensusVote::Commit(r, h) => bft::generic::Vote::Commit(r as usize, h),
msg::ConsensusVote::AdvanceRound(r) => bft::generic::Vote::AdvanceRound(r as usize),
}
};
bft::check_vote::<Block>(authorities, &msg.parent_hash, &vote)?;
trace!(target: "bft", "importing vote {:?} from {}", vote.vote, Hash::from(vote.sender.0));
vote
}),
}),
msg::BftMessage::Auxiliary(a) => {
let justification = bft::UncheckedJustification::from(a);
// TODO: get proper error
let justification: Result<_, bft::Error> = bft::check_prepare_justification::<Block>(authorities, msg.parent_hash, justification)
.map_err(|_| bft::ErrorKind::InvalidJustification.into());
bft::generic::Communication::Auxiliary(justification?)
},
}))
}
// task that processes all gossipped consensus messages,
// checking signatures
struct MessageProcessTask<P: PolkadotApi> {
inner_stream: mpsc::UnboundedReceiver<ConsensusMessage<Block>>,
bft_messages: mpsc::UnboundedSender<bft::Communication<Block>>,
validators: Vec<SessionKey>,
table_router: Router<P>,
}
impl<P: LocalPolkadotApi + Send + Sync + 'static> MessageProcessTask<P> {
fn process_message(&self, msg: ConsensusMessage<Block>) -> Option<Async<()>> {
match msg {
ConsensusMessage::Bft(msg) => {
let local_id = self.table_router.session_key();
match process_bft_message(msg, &local_id, &self.validators[..]) {
Ok(Some(msg)) => {
if let Err(_) = self.bft_messages.unbounded_send(msg) {
// if the BFT receiving stream has ended then
// we should just bail.
trace!(target: "bft", "BFT message stream appears to have closed");
return Some(Async::Ready(()));
}
}
Ok(None) => {} // ignored local message
Err(e) => {
debug!("Message validation failed: {:?}", e);
}
}
}
ConsensusMessage::ChainSpecific(msg, _) => {
if let Ok(Message::Statement(parent_hash, statement)) = ::serde_json::from_slice(&msg) {
if ::polkadot_consensus::check_statement(&statement.statement, &statement.signature, statement.sender, &parent_hash) {
self.table_router.import_statement(statement);
}
}
}
}
None
}
}
impl<P: LocalPolkadotApi + Send + Sync + 'static> Future for MessageProcessTask<P> {
type Item = ();
type Error = ();
fn poll(&mut self) -> Poll<(), ()> {
loop {
match self.inner_stream.poll() {
Ok(Async::Ready(Some(val))) => if let Some(async) = self.process_message(val) {
return Ok(async);
},
Ok(Async::Ready(None)) => return Ok(Async::Ready(())),
Ok(Async::NotReady) => (),
Err(e) => debug!(target: "p_net", "Error getting consensus message: {:?}", e),
}
}
}
}
/// Input stream from the consensus network.
pub struct InputAdapter {
input: mpsc::UnboundedReceiver<bft::Communication<Block>>,
}
impl Stream for InputAdapter {
type Item = bft::Communication<Block>;
type Error = ::polkadot_consensus::Error;
fn poll(&mut self) -> Poll<Option<Self::Item>, Self::Error> {
match self.input.poll() {
Err(_) | Ok(Async::Ready(None)) => Err(bft::InputStreamConcluded.into()),
Ok(x) => Ok(x)
}
}
}
/// Wrapper around the network service
pub struct ConsensusNetwork<P> {
network: Arc<NetworkService>,
api: Arc<P>,
}
impl<P> ConsensusNetwork<P> {
/// Create a new consensus networking object.
pub fn new(network: Arc<NetworkService>, api: Arc<P>) -> Self {
ConsensusNetwork { network, api }
}
}
impl<P> Clone for ConsensusNetwork<P> {
fn clone(&self) -> Self {
ConsensusNetwork {
network: self.network.clone(),
api: self.api.clone(),
}
}
}
/// A long-lived network which can create parachain statement and BFT message routing processes on demand.
impl<P: LocalPolkadotApi + Send + Sync + 'static> Network for ConsensusNetwork<P> {
type TableRouter = Router<P>;
/// The input stream of BFT messages. Should never logically conclude.
type Input = InputAdapter;
/// The output sink of BFT messages. Messages sent here should eventually pass to all
/// current validators.
type Output = BftSink<::polkadot_consensus::Error>;
/// Instantiate a table router using the given shared table.
fn communication_for(&self, validators: &[SessionKey], table: Arc<SharedTable>, task_executor: TaskExecutor) -> (Self::TableRouter, Self::Input, Self::Output) {
let parent_hash = table.consensus_parent_hash().clone();
let sink = BftSink {
network: self.network.clone(),
parent_hash,
_marker: Default::default(),
};
let (bft_send, bft_recv) = mpsc::unbounded();
let knowledge = Arc::new(Mutex::new(Knowledge::new()));
let local_session_key = table.session_key();
let table_router = Router::new(
table,
self.network.clone(),
self.api.clone(),
task_executor.clone(),
parent_hash,
knowledge.clone(),
);
// spin up a task in the background that processes all incoming statements
// TODO: propagate statements on a timer?
let process_task = self.network.with_spec(|spec, ctx| {
spec.new_consensus(ctx, CurrentConsensus {
knowledge,
parent_hash,
local_session_key,
session_keys: Default::default(),
});
MessageProcessTask {
inner_stream: spec.consensus_gossip.messages_for(parent_hash),
bft_messages: bft_send,
validators: validators.to_vec(),
table_router: table_router.clone(),
}
});
match process_task {
Some(task) => task_executor.spawn(task),
None => warn!(target: "p_net", "Cannot process incoming messages: network appears to be down"),
}
(table_router, InputAdapter { input: bft_recv }, sink)
}
}
impl<P: LocalPolkadotApi + Send + Sync + 'static> Collators for ConsensusNetwork<P> {
type Error = ();
type Collation = future::Empty<Collation, ()>;
fn collate(&self, _parachain: ParaId, _relay_parent: Hash) -> Self::Collation {
future::empty()
}
fn note_bad_collator(&self, _collator: AccountId) { }
}
+488
View File
@@ -0,0 +1,488 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! Polkadot-specific network implementation.
//!
//! This manages gossip of consensus messages for BFT and for parachain statements,
//! parachain block and extrinsic data fetching, communication between collators and validators,
//! and more.
extern crate serde;
#[macro_use]
extern crate serde_derive;
extern crate serde_json;
extern crate substrate_bft as bft;
extern crate substrate_codec as codec;
extern crate substrate_network;
extern crate substrate_primitives;
extern crate polkadot_api;
extern crate polkadot_consensus;
extern crate polkadot_primitives;
extern crate ed25519;
extern crate futures;
extern crate parking_lot;
extern crate tokio;
#[macro_use]
extern crate log;
mod router;
pub mod consensus;
use codec::Slicable;
use futures::sync::oneshot;
use parking_lot::Mutex;
use polkadot_consensus::{Statement, SignedStatement, GenericStatement};
use polkadot_primitives::{Block, SessionKey, Hash};
use polkadot_primitives::parachain::{Id as ParaId, BlockData, Extrinsic, CandidateReceipt};
use substrate_network::{PeerId, RequestId, Context};
use substrate_network::consensus_gossip::ConsensusGossip;
use substrate_network::{message, generic_message};
use substrate_network::specialization::Specialization;
use substrate_network::StatusMessage as GenericFullStatus;
use std::collections::{HashMap, HashSet};
use std::sync::Arc;
#[cfg(test)]
mod tests;
/// Polkadot protocol id.
pub const DOT_PROTOCOL_ID: ::substrate_network::ProtocolId = *b"dot";
type FullStatus = GenericFullStatus<Block>;
/// Specialization of the network service for the polkadot protocol.
pub type NetworkService = ::substrate_network::Service<Block, PolkadotProtocol>;
/// Status of a Polkadot node.
#[derive(Debug, PartialEq, Eq, Clone)]
pub struct Status {
collating_for: Option<ParaId>,
}
impl Slicable for Status {
fn encode(&self) -> Vec<u8> {
let mut v = Vec::new();
match self.collating_for {
Some(ref id) => {
v.push(1);
id.using_encoded(|s| v.extend(s));
}
None => {
v.push(0);
}
}
v
}
fn decode<I: ::codec::Input>(input: &mut I) -> Option<Self> {
let collating_for = match input.read_byte()? {
0 => None,
1 => Some(ParaId::decode(input)?),
_ => return None,
};
Some(Status { collating_for })
}
}
struct BlockDataRequest {
attempted_peers: HashSet<SessionKey>,
consensus_parent: Hash,
candidate_hash: Hash,
block_data_hash: Hash,
sender: oneshot::Sender<BlockData>,
}
struct PeerInfo {
status: Status,
validator: bool,
session_keys: HashMap<Hash, SessionKey>,
}
#[derive(Default)]
struct KnowledgeEntry {
knows_block_data: Vec<SessionKey>,
knows_extrinsic: Vec<SessionKey>,
block_data: Option<BlockData>,
extrinsic: Option<Extrinsic>,
}
/// Tracks knowledge of peers.
struct Knowledge {
candidates: HashMap<Hash, KnowledgeEntry>,
}
impl Knowledge {
pub fn new() -> Self {
Knowledge {
candidates: HashMap::new(),
}
}
fn note_statement(&mut self, from: SessionKey, statement: &Statement) {
match *statement {
GenericStatement::Candidate(ref c) => {
let mut entry = self.candidates.entry(c.hash()).or_insert_with(Default::default);
entry.knows_block_data.push(from);
entry.knows_extrinsic.push(from);
}
GenericStatement::Available(ref hash) => {
let mut entry = self.candidates.entry(*hash).or_insert_with(Default::default);
entry.knows_block_data.push(from);
entry.knows_extrinsic.push(from);
}
GenericStatement::Valid(ref hash) | GenericStatement::Invalid(ref hash) => self.candidates.entry(*hash)
.or_insert_with(Default::default)
.knows_block_data
.push(from),
}
}
fn note_candidate(&mut self, hash: Hash, block_data: Option<BlockData>, extrinsic: Option<Extrinsic>) {
let entry = self.candidates.entry(hash).or_insert_with(Default::default);
entry.block_data = entry.block_data.take().or(block_data);
entry.extrinsic = entry.extrinsic.take().or(extrinsic);
}
}
struct CurrentConsensus {
knowledge: Arc<Mutex<Knowledge>>,
parent_hash: Hash,
session_keys: HashMap<SessionKey, PeerId>,
local_session_key: SessionKey,
}
impl CurrentConsensus {
// get locally stored block data for a candidate.
fn block_data(&self, hash: &Hash) -> Option<BlockData> {
self.knowledge.lock().candidates.get(hash)
.and_then(|entry| entry.block_data.clone())
}
fn peer_disconnected(&mut self, peer: &PeerInfo) {
if let Some(key) = peer.session_keys.get(&self.parent_hash) {
self.session_keys.remove(key);
}
}
}
/// Polkadot-specific messages.
#[derive(Serialize, Deserialize)]
pub enum Message {
/// signed statement and localized parent hash.
Statement(Hash, SignedStatement),
/// Tell the peer your session key for the current block.
// TODO: do this with a random challenge protocol
SessionKey(Hash, SessionKey),
/// Requesting parachain block data by candidate hash.
RequestBlockData(RequestId, Hash),
/// Provide block data by candidate hash or nothing if unknown.
BlockData(RequestId, Option<BlockData>),
}
fn send_polkadot_message(ctx: &mut Context<Block>, to: PeerId, message: Message) {
let encoded = ::serde_json::to_vec(&message).expect("serialization of messages infallible; qed");
ctx.send_message(to, generic_message::Message::ChainSpecific(encoded))
}
/// Polkadot protocol attachment for substrate.
pub struct PolkadotProtocol {
peers: HashMap<PeerId, PeerInfo>,
consensus_gossip: ConsensusGossip<Block>,
collators: HashMap<ParaId, Vec<PeerId>>,
collating_for: Option<ParaId>,
live_consensus: Option<CurrentConsensus>,
in_flight: HashMap<(RequestId, PeerId), BlockDataRequest>,
pending: Vec<BlockDataRequest>,
next_req_id: u64,
}
impl PolkadotProtocol {
/// Instantiate a polkadot protocol handler.
pub fn new() -> Self {
PolkadotProtocol {
peers: HashMap::new(),
consensus_gossip: ConsensusGossip::new(),
collators: HashMap::new(),
collating_for: None,
live_consensus: None,
in_flight: HashMap::new(),
pending: Vec::new(),
next_req_id: 1,
}
}
/// Send a statement to a validator.
fn send_statement(&mut self, ctx: &mut Context<Block>, _val: SessionKey, parent_hash: Hash, statement: SignedStatement) {
// TODO: something more targeted than gossip.
let raw = ::serde_json::to_vec(&Message::Statement(parent_hash, statement))
.expect("message serialization infallible; qed");
self.consensus_gossip.multicast_chain_specific(ctx, raw, parent_hash);
}
/// Fetch block data by candidate receipt.
fn fetch_block_data(&mut self, ctx: &mut Context<Block>, candidate: &CandidateReceipt, relay_parent: Hash) -> oneshot::Receiver<BlockData> {
let (tx, rx) = oneshot::channel();
self.pending.push(BlockDataRequest {
attempted_peers: Default::default(),
consensus_parent: relay_parent,
candidate_hash: candidate.hash(),
block_data_hash: candidate.block_data_hash,
sender: tx,
});
self.dispatch_pending_requests(ctx);
rx
}
/// Note new consensus session.
fn new_consensus(&mut self, ctx: &mut Context<Block>, mut consensus: CurrentConsensus) {
let parent_hash = consensus.parent_hash;
let old_parent = self.live_consensus.as_ref().map(|c| c.parent_hash);
for (id, info) in self.peers.iter_mut().filter(|&(_, ref info)| info.validator) {
send_polkadot_message(
ctx,
*id,
Message::SessionKey(parent_hash, consensus.local_session_key)
);
if let Some(key) = info.session_keys.get(&parent_hash) {
consensus.session_keys.insert(*key, *id);
}
if let Some(ref old_parent) = old_parent {
info.session_keys.remove(old_parent);
}
}
self.live_consensus = Some(consensus);
self.consensus_gossip.collect_garbage(old_parent.as_ref());
}
fn dispatch_pending_requests(&mut self, ctx: &mut Context<Block>) {
let consensus = match self.live_consensus {
Some(ref mut c) => c,
None => {
self.pending.clear();
return;
}
};
let knowledge = consensus.knowledge.lock();
let mut new_pending = Vec::new();
for mut pending in ::std::mem::replace(&mut self.pending, Vec::new()) {
if pending.consensus_parent != consensus.parent_hash { continue }
if let Some(entry) = knowledge.candidates.get(&pending.candidate_hash) {
// answer locally
if let Some(ref data) = entry.block_data {
let _ = pending.sender.send(data.clone());
continue;
}
let next_peer = entry.knows_block_data.iter()
.filter_map(|x| consensus.session_keys.get(x).map(|id| (*x, *id)))
.find(|&(ref key, _)| pending.attempted_peers.insert(*key))
.map(|(_, id)| id);
// dispatch to peer
if let Some(peer_id) = next_peer {
let req_id = self.next_req_id;
self.next_req_id += 1;
send_polkadot_message(
ctx,
peer_id,
Message::RequestBlockData(req_id, pending.candidate_hash)
);
self.in_flight.insert((req_id, peer_id), pending);
continue;
}
}
new_pending.push(pending);
}
self.pending = new_pending;
}
fn on_polkadot_message(&mut self, ctx: &mut Context<Block>, peer_id: PeerId, raw: Vec<u8>, msg: Message) {
match msg {
Message::Statement(parent_hash, _statement) =>
self.consensus_gossip.on_chain_specific(ctx, peer_id, raw, parent_hash),
Message::SessionKey(parent_hash, key) => {
{
let info = match self.peers.get_mut(&peer_id) {
Some(peer) => peer,
None => return,
};
if !info.validator {
ctx.disable_peer(peer_id);
return;
}
match self.live_consensus {
Some(ref mut consensus) if consensus.parent_hash == parent_hash => {
consensus.session_keys.insert(key, peer_id);
}
_ => {}
}
info.session_keys.insert(parent_hash, key);
}
self.dispatch_pending_requests(ctx);
}
Message::RequestBlockData(req_id, hash) => {
let block_data = self.live_consensus.as_ref()
.and_then(|c| c.block_data(&hash));
send_polkadot_message(ctx, peer_id, Message::BlockData(req_id, block_data));
}
Message::BlockData(req_id, data) => self.on_block_data(ctx, peer_id, req_id, data),
}
}
fn on_block_data(&mut self, ctx: &mut Context<Block>, peer_id: PeerId, req_id: RequestId, data: Option<BlockData>) {
match self.in_flight.remove(&(req_id, peer_id)) {
Some(req) => {
if let Some(data) = data {
if data.hash() == req.block_data_hash {
let _ = req.sender.send(data);
return
}
}
self.pending.push(req);
self.dispatch_pending_requests(ctx);
}
None => ctx.disable_peer(peer_id),
}
}
}
impl Specialization<Block> for PolkadotProtocol {
fn status(&self) -> Vec<u8> {
Status { collating_for: self.collating_for.clone() }.encode()
}
fn on_connect(&mut self, ctx: &mut Context<Block>, peer_id: PeerId, status: FullStatus) {
let local_status = match Status::decode(&mut &status.chain_status[..]) {
Some(status) => status,
None => {
ctx.disable_peer(peer_id);
return;
}
};
if let Some(ref para_id) = local_status.collating_for {
self.collators.entry(para_id.clone())
.or_insert_with(Vec::new)
.push(peer_id);
}
let validator = status.roles.iter().any(|r| *r == message::Role::Authority);
self.peers.insert(peer_id, PeerInfo {
status: local_status,
session_keys: Default::default(),
validator,
});
self.consensus_gossip.new_peer(ctx, peer_id, &status.roles);
if let (true, &Some(ref consensus)) = (validator, &self.live_consensus) {
send_polkadot_message(
ctx,
peer_id,
Message::SessionKey(consensus.parent_hash, consensus.local_session_key)
);
}
self.dispatch_pending_requests(ctx);
}
fn on_disconnect(&mut self, ctx: &mut Context<Block>, peer_id: PeerId) {
if let Some(info) = self.peers.remove(&peer_id) {
if let Some(collators) = info.status.collating_for.and_then(|id| self.collators.get_mut(&id)) {
if let Some(pos) = collators.iter().position(|x| x == &peer_id) {
collators.swap_remove(pos);
}
}
if let (true, &mut Some(ref mut consensus)) = (info.validator, &mut self.live_consensus) {
consensus.peer_disconnected(&info);
}
{
let pending = &mut self.pending;
self.in_flight.retain(|&(_, ref peer), val| {
let retain = peer != &peer_id;
if !retain {
let (sender, _) = oneshot::channel();
pending.push(::std::mem::replace(val, BlockDataRequest {
attempted_peers: Default::default(),
consensus_parent: Default::default(),
candidate_hash: Default::default(),
block_data_hash: Default::default(),
sender,
}));
}
retain
});
}
self.consensus_gossip.peer_disconnected(ctx, peer_id);
self.dispatch_pending_requests(ctx);
}
}
fn on_message(&mut self, ctx: &mut Context<Block>, peer_id: PeerId, message: message::Message<Block>) {
match message {
generic_message::Message::BftMessage(msg) => {
// TODO: check signature here? what if relevant block is unknown?
self.consensus_gossip.on_bft_message(ctx, peer_id, msg)
}
generic_message::Message::ChainSpecific(raw) => {
match serde_json::from_slice(&raw) {
Ok(msg) => self.on_polkadot_message(ctx, peer_id, raw, msg),
Err(e) => {
trace!(target: "p_net", "Bad message from {}: {}", peer_id, e);
ctx.disable_peer(peer_id);
}
}
}
_ => {}
}
}
fn on_abort(&mut self) {
self.consensus_gossip.abort();
}
fn maintain_peers(&mut self, ctx: &mut Context<Block>) {
self.consensus_gossip.collect_garbage(None);
self.dispatch_pending_requests(ctx);
}
}
+349
View File
@@ -0,0 +1,349 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! Statement routing and consensus table router implementation.
//!
//! During the consensus process, validators exchange statements on validity and availability
//! of parachain candidates.
//! The `Router` in this file hooks into the underlying network to fulfill
//! the `TableRouter` trait from `polkadot-consensus`, which is expected to call into a shared statement table
//! and dispatch evaluation work as necessary when new statements come in.
use polkadot_api::{PolkadotApi, LocalPolkadotApi};
use polkadot_consensus::{SharedTable, TableRouter, SignedStatement, GenericStatement, StatementProducer};
use polkadot_primitives::{Hash, BlockId, SessionKey};
use polkadot_primitives::parachain::{BlockData, Extrinsic, CandidateReceipt, Id as ParaId};
use futures::prelude::*;
use tokio::runtime::TaskExecutor;
use parking_lot::Mutex;
use std::collections::{HashMap, HashSet};
use std::sync::Arc;
use super::{NetworkService, Knowledge};
/// Table routing implementation.
pub struct Router<P: PolkadotApi> {
table: Arc<SharedTable>,
network: Arc<NetworkService>,
api: Arc<P>,
task_executor: TaskExecutor,
parent_hash: Hash,
knowledge: Arc<Mutex<Knowledge>>,
deferred_statements: Arc<Mutex<DeferredStatements>>,
}
impl<P: PolkadotApi> Router<P> {
pub(crate) fn new(
table: Arc<SharedTable>,
network: Arc<NetworkService>,
api: Arc<P>,
task_executor: TaskExecutor,
parent_hash: Hash,
knowledge: Arc<Mutex<Knowledge>>,
) -> Self {
Router {
table,
network,
api,
task_executor,
parent_hash,
knowledge,
deferred_statements: Arc::new(Mutex::new(DeferredStatements::new())),
}
}
pub(crate) fn session_key(&self) -> SessionKey {
self.table.session_key()
}
}
impl<P: PolkadotApi> Clone for Router<P> {
fn clone(&self) -> Self {
Router {
table: self.table.clone(),
network: self.network.clone(),
api: self.api.clone(),
task_executor: self.task_executor.clone(),
parent_hash: self.parent_hash.clone(),
deferred_statements: self.deferred_statements.clone(),
knowledge: self.knowledge.clone(),
}
}
}
impl<P: LocalPolkadotApi + Send + Sync + 'static> Router<P> {
/// Import a statement whose signature has been checked already.
pub(crate) fn import_statement(&self, statement: SignedStatement) {
// defer any statements for which we haven't imported the candidate yet
let (c_hash, parachain_index) = {
let candidate_data = match statement.statement {
GenericStatement::Candidate(ref c) => Some((c.hash(), c.parachain_index)),
GenericStatement::Valid(ref hash)
| GenericStatement::Invalid(ref hash)
| GenericStatement::Available(ref hash)
=> self.table.with_candidate(hash, |c| c.map(|c| (*hash, c.parachain_index))),
};
match candidate_data {
Some(x) => x,
None => {
self.deferred_statements.lock().push(statement);
return;
}
}
};
// import all statements pending on this candidate
let (mut statements, _traces) = if let GenericStatement::Candidate(_) = statement.statement {
self.deferred_statements.lock().get_deferred(&c_hash)
} else {
(Vec::new(), Vec::new())
};
// prepend the candidate statement.
statements.insert(0, statement);
let producers: Vec<_> = self.table.import_remote_statements(
self,
statements.iter().cloned(),
);
// dispatch future work as necessary.
for (producer, statement) in producers.into_iter().zip(statements) {
let producer = match producer {
Some(p) => p,
None => continue, // statement redundant
};
self.knowledge.lock().note_statement(statement.sender, &statement.statement);
self.dispatch_work(c_hash, producer, parachain_index);
}
}
fn dispatch_work<D, E>(&self, candidate_hash: Hash, producer: StatementProducer<D, E>, parachain: ParaId) where
D: Future<Item=BlockData,Error=()> + Send + 'static,
E: Future<Item=Extrinsic,Error=()> + Send + 'static,
{
let parent_hash = self.parent_hash.clone();
let api = self.api.clone();
let validate = move |collation| -> Option<bool> {
let id = BlockId::hash(parent_hash);
match ::polkadot_consensus::validate_collation(&*api, &id, &collation) {
Ok(()) => Some(true),
Err(e) => {
debug!(target: "p_net", "Encountered bad collation: {}", e);
Some(false)
}
}
};
let table = self.table.clone();
let network = self.network.clone();
let knowledge = self.knowledge.clone();
let work = producer.prime(validate).map(move |produced| {
// store the data before broadcasting statements, so other peers can fetch.
knowledge.lock().note_candidate(candidate_hash, produced.block_data, produced.extrinsic);
// propagate the statements
if let Some(validity) = produced.validity {
let signed = table.sign_and_import(validity.clone());
route_statement(&*network, &*table, parachain, parent_hash, signed);
}
if let Some(availability) = produced.availability {
let signed = table.sign_and_import(availability);
route_statement(&*network, &*table, parachain, parent_hash, signed);
}
});
self.task_executor.spawn(work);
}
}
impl<P: LocalPolkadotApi + Send> TableRouter for Router<P> {
type Error = ();
type FetchCandidate = BlockDataReceiver;
type FetchExtrinsic = Result<Extrinsic, Self::Error>;
fn local_candidate(&self, receipt: CandidateReceipt, block_data: BlockData, extrinsic: Extrinsic) {
// give to network to make available.
let hash = receipt.hash();
let para_id = receipt.parachain_index;
let signed = self.table.sign_and_import(GenericStatement::Candidate(receipt));
self.knowledge.lock().note_candidate(hash, Some(block_data), Some(extrinsic));
route_statement(&*self.network, &*self.table, para_id, self.parent_hash, signed);
}
fn fetch_block_data(&self, candidate: &CandidateReceipt) -> BlockDataReceiver {
let parent_hash = self.parent_hash;
let rx = self.network.with_spec(|spec, ctx| { spec.fetch_block_data(ctx, candidate, parent_hash) });
BlockDataReceiver { inner: rx }
}
fn fetch_extrinsic_data(&self, _candidate: &CandidateReceipt) -> Self::FetchExtrinsic {
Ok(Extrinsic)
}
}
/// Receiver for block data.
pub struct BlockDataReceiver {
inner: Option<::futures::sync::oneshot::Receiver<BlockData>>,
}
impl Future for BlockDataReceiver {
type Item = BlockData;
type Error = ();
fn poll(&mut self) -> Poll<BlockData, ()> {
match self.inner {
Some(ref mut inner) => inner.poll().map_err(|_| ()),
None => return Err(()),
}
}
}
// get statement to relevant validators.
fn route_statement(network: &NetworkService, table: &SharedTable, para_id: ParaId, parent_hash: Hash, statement: SignedStatement) {
let broadcast = |i: &mut Iterator<Item=&SessionKey>| {
let local_key = table.session_key();
network.with_spec(|spec, ctx| {
for val in i.filter(|&x| x != &local_key) {
spec.send_statement(ctx, *val, parent_hash, statement.clone());
}
});
};
let g_info = table
.group_info()
.get(&para_id)
.expect("statements only produced about groups which exist");
match statement.statement {
GenericStatement::Candidate(_) =>
broadcast(&mut g_info.validity_guarantors.iter().chain(g_info.availability_guarantors.iter())),
GenericStatement::Valid(_) | GenericStatement::Invalid(_) =>
broadcast(&mut g_info.validity_guarantors.iter()),
GenericStatement::Available(_) =>
broadcast(&mut g_info.availability_guarantors.iter()),
}
}
// A unique trace for valid statements issued by a validator.
#[derive(Hash, PartialEq, Eq, Clone, Debug)]
enum StatementTrace {
Valid(SessionKey, Hash),
Invalid(SessionKey, Hash),
Available(SessionKey, Hash),
}
// helper for deferring statements whose associated candidate is unknown.
struct DeferredStatements {
deferred: HashMap<Hash, Vec<SignedStatement>>,
known_traces: HashSet<StatementTrace>,
}
impl DeferredStatements {
fn new() -> Self {
DeferredStatements {
deferred: HashMap::new(),
known_traces: HashSet::new(),
}
}
fn push(&mut self, statement: SignedStatement) {
let (hash, trace) = match statement.statement {
GenericStatement::Candidate(_) => return,
GenericStatement::Valid(hash) => (hash, StatementTrace::Valid(statement.sender, hash)),
GenericStatement::Invalid(hash) => (hash, StatementTrace::Invalid(statement.sender, hash)),
GenericStatement::Available(hash) => (hash, StatementTrace::Available(statement.sender, hash)),
};
if self.known_traces.insert(trace) {
self.deferred.entry(hash).or_insert_with(Vec::new).push(statement);
}
}
fn get_deferred(&mut self, hash: &Hash) -> (Vec<SignedStatement>, Vec<StatementTrace>) {
match self.deferred.remove(hash) {
None => (Vec::new(), Vec::new()),
Some(deferred) => {
let mut traces = Vec::new();
for statement in deferred.iter() {
let trace = match statement.statement {
GenericStatement::Candidate(_) => continue,
GenericStatement::Valid(hash) => StatementTrace::Valid(statement.sender, hash),
GenericStatement::Invalid(hash) => StatementTrace::Invalid(statement.sender, hash),
GenericStatement::Available(hash) => StatementTrace::Available(statement.sender, hash),
};
self.known_traces.remove(&trace);
traces.push(trace);
}
(deferred, traces)
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use substrate_primitives::H512;
#[test]
fn deferred_statements_works() {
let mut deferred = DeferredStatements::new();
let hash = [1; 32].into();
let sig = H512([2; 64]).into();
let sender = [255; 32].into();
let statement = SignedStatement {
statement: GenericStatement::Valid(hash),
sender,
signature: sig,
};
// pre-push.
{
let (signed, traces) = deferred.get_deferred(&hash);
assert!(signed.is_empty());
assert!(traces.is_empty());
}
deferred.push(statement.clone());
deferred.push(statement.clone());
// draining: second push should have been ignored.
{
let (signed, traces) = deferred.get_deferred(&hash);
assert_eq!(signed.len(), 1);
assert_eq!(traces.len(), 1);
assert_eq!(signed[0].clone(), statement);
assert_eq!(traces[0].clone(), StatementTrace::Valid(sender, hash));
}
// after draining
{
let (signed, traces) = deferred.get_deferred(&hash);
assert!(signed.is_empty());
assert!(traces.is_empty());
}
}
}
+204
View File
@@ -0,0 +1,204 @@
// Copyright 2018 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
//! Tests for polkadot and consensus network.
use super::{PolkadotProtocol, Status, CurrentConsensus, Knowledge, Message, FullStatus};
use parking_lot::Mutex;
use polkadot_consensus::GenericStatement;
use polkadot_primitives::{Block, Hash, SessionKey};
use polkadot_primitives::parachain::{CandidateReceipt, HeadData, BlockData};
use codec::Slicable;
use substrate_network::{PeerId, PeerInfo, ClientHandle, Context, message::Message as SubstrateMessage, message::Role, specialization::Specialization, generic_message::Message as GenericMessage};
use std::sync::Arc;
use futures::Future;
#[derive(Default)]
struct TestContext {
disabled: Vec<PeerId>,
disconnected: Vec<PeerId>,
messages: Vec<(PeerId, SubstrateMessage<Block>)>,
}
impl Context<Block> for TestContext {
fn client(&self) -> &ClientHandle<Block> {
unimplemented!()
}
fn disable_peer(&mut self, peer: PeerId) {
self.disabled.push(peer);
}
fn disconnect_peer(&mut self, peer: PeerId) {
self.disconnected.push(peer);
}
fn peer_info(&self, _peer: PeerId) -> Option<PeerInfo<Block>> {
unimplemented!()
}
fn send_message(&mut self, peer_id: PeerId, data: SubstrateMessage<Block>) {
self.messages.push((peer_id, data))
}
}
impl TestContext {
fn has_message(&self, to: PeerId, message: Message) -> bool {
use substrate_network::generic_message::Message as GenericMessage;
let encoded = ::serde_json::to_vec(&message).unwrap();
self.messages.iter().any(|&(ref peer, ref msg)| match msg {
GenericMessage::ChainSpecific(ref data) => peer == &to && data == &encoded,
_ => false,
})
}
}
fn make_status(status: &Status, roles: Vec<Role>) -> FullStatus {
FullStatus {
version: 1,
roles,
best_number: 0,
best_hash: Default::default(),
genesis_hash: Default::default(),
chain_status: status.encode(),
}
}
fn make_consensus(parent_hash: Hash, local_key: SessionKey) -> (CurrentConsensus, Arc<Mutex<Knowledge>>) {
let knowledge = Arc::new(Mutex::new(Knowledge::new()));
let c = CurrentConsensus {
knowledge: knowledge.clone(),
parent_hash,
session_keys: Default::default(),
local_session_key: local_key,
};
(c, knowledge)
}
fn on_message(protocol: &mut PolkadotProtocol, ctx: &mut TestContext, from: PeerId, message: Message) {
let encoded = ::serde_json::to_vec(&message).unwrap();
protocol.on_message(ctx, from, GenericMessage::ChainSpecific(encoded));
}
#[test]
fn sends_session_key() {
let mut protocol = PolkadotProtocol::new();
let peer_a = 1;
let peer_b = 2;
let parent_hash = [0; 32].into();
let local_key = [1; 32].into();
let status = Status { collating_for: None };
{
let mut ctx = TestContext::default();
protocol.on_connect(&mut ctx, peer_a, make_status(&status, vec![Role::Authority]));
assert!(ctx.messages.is_empty());
}
{
let mut ctx = TestContext::default();
let (consensus, _knowledge) = make_consensus(parent_hash, local_key);
protocol.new_consensus(&mut ctx, consensus);
assert!(ctx.has_message(peer_a, Message::SessionKey(parent_hash, local_key)));
}
{
let mut ctx = TestContext::default();
protocol.on_connect(&mut ctx, peer_b, make_status(&status, vec![Role::Authority]));
assert!(ctx.has_message(peer_b, Message::SessionKey(parent_hash, local_key)));
}
}
#[test]
fn fetches_from_those_with_knowledge() {
let mut protocol = PolkadotProtocol::new();
let peer_a = 1;
let peer_b = 2;
let parent_hash = [0; 32].into();
let local_key = [1; 32].into();
let block_data = BlockData(vec![1, 2, 3, 4]);
let block_data_hash = block_data.hash();
let candidate_receipt = CandidateReceipt {
parachain_index: 5.into(),
collator: [255; 32].into(),
head_data: HeadData(vec![9, 9, 9]),
balance_uploads: Vec::new(),
egress_queue_roots: Vec::new(),
fees: 1_000_000,
block_data_hash,
};
let candidate_hash = candidate_receipt.hash();
let a_key = [3; 32].into();
let b_key = [4; 32].into();
let status = Status { collating_for: None };
let (consensus, knowledge) = make_consensus(parent_hash, local_key);
protocol.new_consensus(&mut TestContext::default(), consensus);
knowledge.lock().note_statement(a_key, &GenericStatement::Valid(candidate_hash));
let recv = protocol.fetch_block_data(&mut TestContext::default(), &candidate_receipt, parent_hash);
// connect peer A
{
let mut ctx = TestContext::default();
protocol.on_connect(&mut ctx, peer_a, make_status(&status, vec![Role::Authority]));
assert!(ctx.has_message(peer_a, Message::SessionKey(parent_hash, local_key)));
}
// peer A gives session key and gets asked for data.
{
let mut ctx = TestContext::default();
on_message(&mut protocol, &mut ctx, peer_a, Message::SessionKey(parent_hash, a_key));
assert!(ctx.has_message(peer_a, Message::RequestBlockData(1, candidate_hash)));
}
knowledge.lock().note_statement(b_key, &GenericStatement::Valid(candidate_hash));
// peer B connects and sends session key. request already assigned to A
{
let mut ctx = TestContext::default();
protocol.on_connect(&mut ctx, peer_b, make_status(&status, vec![Role::Authority]));
on_message(&mut protocol, &mut ctx, peer_b, Message::SessionKey(parent_hash, b_key));
assert!(!ctx.has_message(peer_b, Message::RequestBlockData(2, candidate_hash)));
}
// peer A disconnects, triggering reassignment
{
let mut ctx = TestContext::default();
protocol.on_disconnect(&mut ctx, peer_a);
assert!(ctx.has_message(peer_b, Message::RequestBlockData(2, candidate_hash)));
}
// peer B comes back with block data.
{
let mut ctx = TestContext::default();
on_message(&mut protocol, &mut ctx, peer_b, Message::BlockData(2, Some(block_data.clone())));
drop(protocol);
assert_eq!(recv.wait().unwrap(), block_data);
}
}
+14 -55
View File
@@ -172,6 +172,8 @@ pub struct CandidateReceipt {
pub egress_queue_roots: Vec<(Id, Hash)>, pub egress_queue_roots: Vec<(Id, Hash)>,
/// Fees paid from the chain to the relay chain validators /// Fees paid from the chain to the relay chain validators
pub fees: u64, pub fees: u64,
/// blake2-256 Hash of block data.
pub block_data_hash: Hash,
} }
impl Slicable for CandidateReceipt { impl Slicable for CandidateReceipt {
@@ -184,6 +186,7 @@ impl Slicable for CandidateReceipt {
self.balance_uploads.using_encoded(|s| v.extend(s)); self.balance_uploads.using_encoded(|s| v.extend(s));
self.egress_queue_roots.using_encoded(|s| v.extend(s)); self.egress_queue_roots.using_encoded(|s| v.extend(s));
self.fees.using_encoded(|s| v.extend(s)); self.fees.using_encoded(|s| v.extend(s));
self.block_data_hash.using_encoded(|s| v.extend(s));
v v
} }
@@ -196,6 +199,7 @@ impl Slicable for CandidateReceipt {
balance_uploads: Slicable::decode(input)?, balance_uploads: Slicable::decode(input)?,
egress_queue_roots: Slicable::decode(input)?, egress_queue_roots: Slicable::decode(input)?,
fees: Slicable::decode(input)?, fees: Slicable::decode(input)?,
block_data_hash: Slicable::decode(input)?,
}) })
} }
} }
@@ -243,6 +247,15 @@ pub struct ConsolidatedIngress(pub Vec<(Id, Vec<Message>)>);
#[cfg_attr(feature = "std", derive(Serialize, Deserialize, Debug))] #[cfg_attr(feature = "std", derive(Serialize, Deserialize, Debug))]
pub struct BlockData(#[cfg_attr(feature = "std", serde(with="bytes"))] pub Vec<u8>); pub struct BlockData(#[cfg_attr(feature = "std", serde(with="bytes"))] pub Vec<u8>);
impl BlockData {
/// Compute hash of block data.
#[cfg(feature = "std")]
pub fn hash(&self) -> Hash {
use runtime_primitives::traits::{BlakeTwo256, Hashing};
BlakeTwo256::hash(&self.0[..])
}
}
/// Parachain header raw bytes wrapper type. /// Parachain header raw bytes wrapper type.
#[derive(PartialEq, Eq)] #[derive(PartialEq, Eq)]
#[cfg_attr(feature = "std", derive(Serialize, Deserialize, Debug))] #[cfg_attr(feature = "std", derive(Serialize, Deserialize, Debug))]
@@ -273,19 +286,9 @@ impl Slicable for Activity {
} }
} }
#[derive(Clone, Copy, PartialEq, Eq)]
#[cfg_attr(feature = "std", derive(Debug))]
#[repr(u8)]
enum StatementKind {
Candidate = 1,
Valid = 2,
Invalid = 3,
Available = 4,
}
/// Statements which can be made about parachain candidates. /// Statements which can be made about parachain candidates.
#[derive(Clone, PartialEq, Eq)] #[derive(Clone, PartialEq, Eq)]
#[cfg_attr(feature = "std", derive(Debug))] #[cfg_attr(feature = "std", derive(Debug, Serialize, Deserialize))]
pub enum Statement { pub enum Statement {
/// Proposal of a parachain candidate. /// Proposal of a parachain candidate.
Candidate(CandidateReceipt), Candidate(CandidateReceipt),
@@ -296,47 +299,3 @@ pub enum Statement {
/// Vote to advance round after inactive primary. /// Vote to advance round after inactive primary.
Available(Hash), Available(Hash),
} }
impl Slicable for Statement {
fn encode(&self) -> Vec<u8> {
let mut v = Vec::new();
match *self {
Statement::Candidate(ref candidate) => {
v.push(StatementKind::Candidate as u8);
candidate.using_encoded(|s| v.extend(s));
}
Statement::Valid(ref hash) => {
v.push(StatementKind::Valid as u8);
hash.using_encoded(|s| v.extend(s));
}
Statement::Invalid(ref hash) => {
v.push(StatementKind::Invalid as u8);
hash.using_encoded(|s| v.extend(s));
}
Statement::Available(ref hash) => {
v.push(StatementKind::Available as u8);
hash.using_encoded(|s| v.extend(s));
}
}
v
}
fn decode<I: Input>(value: &mut I) -> Option<Self> {
match value.read_byte() {
Some(x) if x == StatementKind::Candidate as u8 => {
Slicable::decode(value).map(Statement::Candidate)
}
Some(x) if x == StatementKind::Valid as u8 => {
Slicable::decode(value).map(Statement::Valid)
}
Some(x) if x == StatementKind::Invalid as u8 => {
Slicable::decode(value).map(Statement::Invalid)
}
Some(x) if x == StatementKind::Available as u8 => {
Slicable::decode(value).map(Statement::Available)
}
_ => None,
}
}
}
+7
View File
@@ -218,6 +218,7 @@ impl_outer_dispatch! {
Democracy = 5, Democracy = 5,
Council = 6, Council = 6,
CouncilVoting = 7, CouncilVoting = 7,
Parachains = 8,
} }
} }
@@ -395,4 +396,10 @@ mod tests {
let v = Slicable::encode(&xt); let v = Slicable::encode(&xt);
assert_eq!(Extrinsic::decode(&mut &v[..]).unwrap(), xt); assert_eq!(Extrinsic::decode(&mut &v[..]).unwrap(), xt);
} }
#[test]
fn parachain_calls_are_privcall() {
let _register = PrivCall::Parachains(parachains::PrivCall::register_parachain(0.into(), vec![1, 2, 3], vec![]));
let _deregister = PrivCall::Parachains(parachains::PrivCall::deregister_parachain(0.into()));
}
} }
+23 -14
View File
@@ -16,15 +16,14 @@
//! Main parachains logic. For now this is just the determination of which validators do what. //! Main parachains logic. For now this is just the determination of which validators do what.
use primitives;
use rstd::prelude::*; use rstd::prelude::*;
use codec::{Slicable, Joiner}; use codec::Slicable;
use runtime_primitives::traits::{Executable, RefInto, MaybeEmpty}; use runtime_primitives::traits::{Hashing, BlakeTwo256, Executable, RefInto, MaybeEmpty};
use primitives::parachain::{Id, Chain, DutyRoster, CandidateReceipt}; use primitives::parachain::{Id, Chain, DutyRoster, CandidateReceipt};
use {system, session}; use {system, session};
use substrate_runtime_support::{Hashable, StorageValue, StorageMap}; use substrate_runtime_support::{StorageValue, StorageMap};
use substrate_runtime_support::dispatch::Result; use substrate_runtime_support::dispatch::Result;
#[cfg(any(feature = "std", test))] #[cfg(any(feature = "std", test))]
@@ -33,7 +32,7 @@ use rstd::marker::PhantomData;
#[cfg(any(feature = "std", test))] #[cfg(any(feature = "std", test))]
use {runtime_io, runtime_primitives}; use {runtime_io, runtime_primitives};
pub trait Trait: session::Trait<Hash = primitives::Hash> { pub trait Trait: system::Trait<Hash = ::primitives::Hash> + session::Trait {
/// The position of the set_heads call in the block. /// The position of the set_heads call in the block.
const SET_POSITION: u32; const SET_POSITION: u32;
@@ -43,13 +42,19 @@ pub trait Trait: session::Trait<Hash = primitives::Hash> {
decl_module! { decl_module! {
/// Parachains module. /// Parachains module.
pub struct Module<T: Trait>; pub struct Module<T: Trait>;
/// Call type for parachains. /// Call type for parachains.
#[cfg_attr(feature = "std", derive(Serialize, Deserialize))] #[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
pub enum Call where aux: <T as Trait>::PublicAux { pub enum Call where aux: <T as Trait>::PublicAux {
// provide candidate receipts for parachains, in ascending order by id. // provide candidate receipts for parachains, in ascending order by id.
fn set_heads(aux, heads: Vec<CandidateReceipt>) -> Result = 0; fn set_heads(aux, heads: Vec<CandidateReceipt>) -> Result = 0;
} }
/// Private calls for parachains.
#[cfg_attr(feature = "std", derive(Serialize, Deserialize))]
pub enum PrivCall {
fn register_parachain(id: Id, code: Vec<u8>, initial_head_data: Vec<u8>) -> Result = 0;
fn deregister_parachain(id: Id) -> Result = 1;
}
} }
decl_storage! { decl_storage! {
@@ -83,8 +88,9 @@ impl<T: Trait> Module<T> {
let mut roles_gua = roles_val.clone(); let mut roles_gua = roles_val.clone();
let random_seed = system::Module::<T>::random_seed(); let mut random_seed = system::Module::<T>::random_seed().to_vec();
let mut seed = random_seed.to_vec().and(b"validator_role_pairs").blake2_256(); random_seed.extend(b"validator_role_pairs");
let mut seed = BlakeTwo256::hash(&random_seed);
// shuffle // shuffle
for i in 0..(validator_count - 1) { for i in 0..(validator_count - 1) {
@@ -100,7 +106,7 @@ impl<T: Trait> Module<T> {
if offset == 24 { if offset == 24 {
// into the last 8 bytes - rehash to gather new entropy // into the last 8 bytes - rehash to gather new entropy
seed = seed.blake2_256(); seed = BlakeTwo256::hash(&seed);
} }
// exchange last item with randomly chosen first. // exchange last item with randomly chosen first.
@@ -116,20 +122,22 @@ impl<T: Trait> Module<T> {
/// Register a parachain with given code. /// Register a parachain with given code.
/// Fails if given ID is already used. /// Fails if given ID is already used.
pub fn register_parachain(id: Id, code: Vec<u8>, initial_head_data: Vec<u8>) { pub fn register_parachain(id: Id, code: Vec<u8>, initial_head_data: Vec<u8>) -> Result {
let mut parachains = Self::active_parachains(); let mut parachains = Self::active_parachains();
match parachains.binary_search(&id) { match parachains.binary_search(&id) {
Ok(_) => panic!("Parachain with id {} already exists", id.into_inner()), Ok(_) => fail!("Parachain already exists"),
Err(idx) => parachains.insert(idx, id), Err(idx) => parachains.insert(idx, id),
} }
<Code<T>>::insert(id, code); <Code<T>>::insert(id, code);
<Parachains<T>>::put(parachains); <Parachains<T>>::put(parachains);
<Heads<T>>::insert(id, initial_head_data); <Heads<T>>::insert(id, initial_head_data);
Ok(())
} }
/// Deregister a parachain with given id /// Deregister a parachain with given id
pub fn deregister_parachain(id: Id) { pub fn deregister_parachain(id: Id) -> Result {
let mut parachains = Self::active_parachains(); let mut parachains = Self::active_parachains();
match parachains.binary_search(&id) { match parachains.binary_search(&id) {
Ok(idx) => { parachains.remove(idx); } Ok(idx) => { parachains.remove(idx); }
@@ -139,6 +147,7 @@ impl<T: Trait> Module<T> {
<Code<T>>::remove(id); <Code<T>>::remove(id);
<Heads<T>>::remove(id); <Heads<T>>::remove(id);
<Parachains<T>>::put(parachains); <Parachains<T>>::put(parachains);
Ok(())
} }
fn set_heads(aux: &<T as Trait>::PublicAux, heads: Vec<CandidateReceipt>) -> Result { fn set_heads(aux: &<T as Trait>::PublicAux, heads: Vec<CandidateReceipt>) -> Result {
@@ -317,12 +326,12 @@ mod tests {
assert_eq!(Parachains::parachain_code(&5u32.into()), Some(vec![1,2,3])); assert_eq!(Parachains::parachain_code(&5u32.into()), Some(vec![1,2,3]));
assert_eq!(Parachains::parachain_code(&100u32.into()), Some(vec![4,5,6])); assert_eq!(Parachains::parachain_code(&100u32.into()), Some(vec![4,5,6]));
Parachains::register_parachain(99u32.into(), vec![7,8,9], vec![1, 1, 1]); Parachains::register_parachain(99u32.into(), vec![7,8,9], vec![1, 1, 1]).unwrap();
assert_eq!(Parachains::active_parachains(), vec![5u32.into(), 99u32.into(), 100u32.into()]); assert_eq!(Parachains::active_parachains(), vec![5u32.into(), 99u32.into(), 100u32.into()]);
assert_eq!(Parachains::parachain_code(&99u32.into()), Some(vec![7,8,9])); assert_eq!(Parachains::parachain_code(&99u32.into()), Some(vec![7,8,9]));
Parachains::deregister_parachain(5u32.into()); Parachains::deregister_parachain(5u32.into()).unwrap();
assert_eq!(Parachains::active_parachains(), vec![99u32.into(), 100u32.into()]); assert_eq!(Parachains::active_parachains(), vec![99u32.into(), 100u32.into()]);
assert_eq!(Parachains::parachain_code(&5u32.into()), None); assert_eq!(Parachains::parachain_code(&5u32.into()), None);
+2 -2
View File
@@ -6,13 +6,12 @@ authors = ["Parity Technologies <admin@parity.io>"]
[dependencies] [dependencies]
futures = "0.1.17" futures = "0.1.17"
parking_lot = "0.4" parking_lot = "0.4"
tokio-timer = "0.1.2"
error-chain = "0.12" error-chain = "0.12"
lazy_static = "1.0" lazy_static = "1.0"
log = "0.3" log = "0.3"
slog = "^2" slog = "^2"
clap = "2.27" clap = "2.27"
tokio-core = "0.1.12" tokio = "0.1.7"
exit-future = "0.1" exit-future = "0.1"
serde = "1.0" serde = "1.0"
serde_json = "1.0" serde_json = "1.0"
@@ -25,6 +24,7 @@ polkadot-consensus = { path = "../consensus" }
polkadot-executor = { path = "../executor" } polkadot-executor = { path = "../executor" }
polkadot-api = { path = "../api" } polkadot-api = { path = "../api" }
polkadot-transaction-pool = { path = "../transaction-pool" } polkadot-transaction-pool = { path = "../transaction-pool" }
polkadot-network = { path = "../network" }
substrate-keystore = { path = "../../substrate/keystore" } substrate-keystore = { path = "../../substrate/keystore" }
substrate-runtime-io = { path = "../../substrate/runtime-io" } substrate-runtime-io = { path = "../../substrate/runtime-io" }
substrate-runtime-primitives = { path = "../../substrate/runtime/primitives" } substrate-runtime-primitives = { path = "../../substrate/runtime/primitives" }
+45 -17
View File
@@ -18,20 +18,22 @@
use std::collections::HashMap; use std::collections::HashMap;
use std::sync::Arc; use std::sync::Arc;
use client::{self, Client}; use chain_spec::ChainSpec;
use client_db; use client_db;
use client::{self, Client};
use codec::{self, Slicable}; use codec::{self, Slicable};
use consensus; use consensus;
use error;
use keystore::Store as Keystore; use keystore::Store as Keystore;
use network; use network::{self, OnDemand};
use polkadot_api; use polkadot_api;
use polkadot_executor::Executor as LocalDispatch; use polkadot_executor::Executor as LocalDispatch;
use polkadot_network::NetworkService;
use polkadot_primitives::{Block, BlockId, Hash}; use polkadot_primitives::{Block, BlockId, Hash};
use state_machine; use state_machine;
use substrate_executor::NativeExecutor; use substrate_executor::NativeExecutor;
use transaction_pool::{self, TransactionPool}; use transaction_pool::{self, TransactionPool};
use error; use tokio::runtime::TaskExecutor;
use chain_spec::ChainSpec;
/// Code executor. /// Code executor.
pub type CodeExecutor = NativeExecutor<LocalDispatch>; pub type CodeExecutor = NativeExecutor<LocalDispatch>;
@@ -49,7 +51,7 @@ pub trait Components {
/// Create client. /// Create client.
fn build_client(&self, settings: client_db::DatabaseSettings, executor: CodeExecutor, chain_spec: &ChainSpec) fn build_client(&self, settings: client_db::DatabaseSettings, executor: CodeExecutor, chain_spec: &ChainSpec)
-> Result<(Arc<Client<Self::Backend, Self::Executor, Block>>, Option<Arc<network::OnDemand<Block, network::Service<Block>>>>), error::Error>; -> Result<(Arc<Client<Self::Backend, Self::Executor, Block>>, Option<Arc<OnDemand<Block, NetworkService>>>), error::Error>;
/// Create api. /// Create api.
fn build_api(&self, client: Arc<Client<Self::Backend, Self::Executor, Block>>) -> Arc<Self::Api>; fn build_api(&self, client: Arc<Client<Self::Backend, Self::Executor, Block>>) -> Arc<Self::Api>;
@@ -59,7 +61,14 @@ pub trait Components {
-> Arc<network::TransactionPool<Block>>; -> Arc<network::TransactionPool<Block>>;
/// Create consensus service. /// Create consensus service.
fn build_consensus(&self, client: Arc<Client<Self::Backend, Self::Executor, Block>>, network: Arc<network::Service<Block>>, tx_pool: Arc<TransactionPool<Self::Api>>, keystore: &Keystore) fn build_consensus(
&self,
client: Arc<Client<Self::Backend, Self::Executor, Block>>,
network: Arc<NetworkService>,
tx_pool: Arc<TransactionPool<Self::Api>>,
keystore: &Keystore,
task_executor: TaskExecutor,
)
-> Result<Option<consensus::Service>, error::Error>; -> Result<Option<consensus::Service>, error::Error>;
} }
@@ -75,7 +84,7 @@ impl Components for FullComponents {
type Executor = client::LocalCallExecutor<client_db::Backend<Block>, NativeExecutor<LocalDispatch>>; type Executor = client::LocalCallExecutor<client_db::Backend<Block>, NativeExecutor<LocalDispatch>>;
fn build_client(&self, db_settings: client_db::DatabaseSettings, executor: CodeExecutor, chain_spec: &ChainSpec) fn build_client(&self, db_settings: client_db::DatabaseSettings, executor: CodeExecutor, chain_spec: &ChainSpec)
-> Result<(Arc<client::Client<Self::Backend, Self::Executor, Block>>, Option<Arc<network::OnDemand<Block, network::Service<Block>>>>), error::Error> { -> Result<(Arc<client::Client<Self::Backend, Self::Executor, Block>>, Option<Arc<OnDemand<Block, NetworkService>>>), error::Error> {
Ok((Arc::new(client_db::new_client(db_settings, executor, chain_spec)?), None)) Ok((Arc::new(client_db::new_client(db_settings, executor, chain_spec)?), None))
} }
@@ -92,20 +101,31 @@ impl Components for FullComponents {
}) })
} }
fn build_consensus(&self, client: Arc<client::Client<Self::Backend, Self::Executor, Block>>, network: Arc<network::Service<Block>>, tx_pool: Arc<TransactionPool<Self::Api>>, keystore: &Keystore) fn build_consensus(
-> Result<Option<consensus::Service>, error::Error> { &self,
client: Arc<client::Client<Self::Backend, Self::Executor, Block>>,
network: Arc<NetworkService>,
tx_pool: Arc<TransactionPool<Self::Api>>,
keystore: &Keystore,
task_executor: TaskExecutor,
)
-> Result<Option<consensus::Service>, error::Error>
{
if !self.is_validator { if !self.is_validator {
return Ok(None); return Ok(None);
} }
// Load the first available key // Load the first available key
let key = keystore.load(&keystore.contents()?[0], "")?; let key = keystore.load(&keystore.contents()?[0], "")?;
info!("Using authority key: {}", key.public()); info!("Using authority key {}", key.public());
let consensus_net = ::polkadot_network::consensus::ConsensusNetwork::new(network, client.clone());
Ok(Some(consensus::Service::new( Ok(Some(consensus::Service::new(
client.clone(), client.clone(),
client.clone(), client.clone(),
network.clone(), consensus_net,
tx_pool.clone(), tx_pool.clone(),
task_executor,
::std::time::Duration::from_millis(4000), // TODO: dynamic ::std::time::Duration::from_millis(4000), // TODO: dynamic
key, key,
))) )))
@@ -116,14 +136,14 @@ impl Components for FullComponents {
pub struct LightComponents; pub struct LightComponents;
impl Components for LightComponents { impl Components for LightComponents {
type Backend = client::light::backend::Backend<client_db::light::LightStorage<Block>, network::OnDemand<Block, network::Service<Block>>>; type Backend = client::light::backend::Backend<client_db::light::LightStorage<Block>, network::OnDemand<Block, NetworkService>>;
type Api = polkadot_api::light::RemotePolkadotApiWrapper<Self::Backend, Self::Executor>; type Api = polkadot_api::light::RemotePolkadotApiWrapper<Self::Backend, Self::Executor>;
type Executor = client::light::call_executor::RemoteCallExecutor< type Executor = client::light::call_executor::RemoteCallExecutor<
client::light::blockchain::Blockchain<client_db::light::LightStorage<Block>, network::OnDemand<Block, network::Service<Block>>>, client::light::blockchain::Blockchain<client_db::light::LightStorage<Block>, network::OnDemand<Block, NetworkService>>,
network::OnDemand<Block, network::Service<Block>>>; network::OnDemand<Block, NetworkService>>;
fn build_client(&self, db_settings: client_db::DatabaseSettings, executor: CodeExecutor, spec: &ChainSpec) fn build_client(&self, db_settings: client_db::DatabaseSettings, executor: CodeExecutor, spec: &ChainSpec)
-> Result<(Arc<client::Client<Self::Backend, Self::Executor, Block>>, Option<Arc<network::OnDemand<Block, network::Service<Block>>>>), error::Error> { -> Result<(Arc<client::Client<Self::Backend, Self::Executor, Block>>, Option<Arc<OnDemand<Block, NetworkService>>>), error::Error> {
let db_storage = client_db::light::LightStorage::new(db_settings)?; let db_storage = client_db::light::LightStorage::new(db_settings)?;
let light_blockchain = client::light::new_light_blockchain(db_storage); let light_blockchain = client::light::new_light_blockchain(db_storage);
let fetch_checker = Arc::new(client::light::new_fetch_checker(light_blockchain.clone(), executor)); let fetch_checker = Arc::new(client::light::new_fetch_checker(light_blockchain.clone(), executor));
@@ -146,8 +166,16 @@ impl Components for LightComponents {
}) })
} }
fn build_consensus(&self, _client: Arc<client::Client<Self::Backend, Self::Executor, Block>>, _network: Arc<network::Service<Block>>, _tx_pool: Arc<TransactionPool<Self::Api>>, _keystore: &Keystore) fn build_consensus(
-> Result<Option<consensus::Service>, error::Error> { &self,
_client: Arc<client::Client<Self::Backend, Self::Executor, Block>>,
_network: Arc<NetworkService>,
_tx_pool: Arc<TransactionPool<Self::Api>>,
_keystore: &Keystore,
_task_executor: TaskExecutor,
)
-> Result<Option<consensus::Service>, error::Error>
{
Ok(None) Ok(None)
} }
} }
+52 -65
View File
@@ -21,7 +21,6 @@ extern crate futures;
extern crate ed25519; extern crate ed25519;
extern crate clap; extern crate clap;
extern crate exit_future; extern crate exit_future;
extern crate tokio_timer;
extern crate serde; extern crate serde;
extern crate serde_json; extern crate serde_json;
extern crate polkadot_primitives; extern crate polkadot_primitives;
@@ -30,18 +29,17 @@ extern crate polkadot_executor;
extern crate polkadot_api; extern crate polkadot_api;
extern crate polkadot_consensus as consensus; extern crate polkadot_consensus as consensus;
extern crate polkadot_transaction_pool as transaction_pool; extern crate polkadot_transaction_pool as transaction_pool;
extern crate polkadot_network;
extern crate substrate_keystore as keystore; extern crate substrate_keystore as keystore;
extern crate substrate_runtime_io as runtime_io;
extern crate substrate_primitives as primitives; extern crate substrate_primitives as primitives;
extern crate substrate_runtime_primitives as runtime_primitives; extern crate substrate_runtime_primitives as runtime_primitives;
extern crate substrate_network as network; extern crate substrate_network as network;
extern crate substrate_codec as codec; extern crate substrate_codec as codec;
extern crate substrate_executor; extern crate substrate_executor;
extern crate substrate_state_machine as state_machine; extern crate substrate_state_machine as state_machine;
extern crate tokio_core;
extern crate substrate_client as client; extern crate substrate_client as client;
extern crate substrate_client_db as client_db; extern crate substrate_client_db as client_db;
extern crate tokio;
#[macro_use] #[macro_use]
extern crate substrate_telemetry; extern crate substrate_telemetry;
@@ -62,9 +60,7 @@ mod config;
mod chain_spec; mod chain_spec;
use std::sync::Arc; use std::sync::Arc;
use std::thread;
use futures::prelude::*; use futures::prelude::*;
use tokio_core::reactor::Core;
use transaction_pool::TransactionPool; use transaction_pool::TransactionPool;
use keystore::Store as Keystore; use keystore::Store as Keystore;
use polkadot_api::PolkadotApi; use polkadot_api::PolkadotApi;
@@ -72,6 +68,8 @@ use polkadot_primitives::{Block, BlockId, Hash};
use client::{Client, BlockchainEvents}; use client::{Client, BlockchainEvents};
use network::ManageNetwork; use network::ManageNetwork;
use exit_future::Signal; use exit_future::Signal;
use polkadot_network::{NetworkService, PolkadotProtocol};
use tokio::runtime::TaskExecutor;
pub use self::error::{ErrorKind, Error}; pub use self::error::{ErrorKind, Error};
pub use self::components::{Components, FullComponents, LightComponents}; pub use self::components::{Components, FullComponents, LightComponents};
@@ -80,23 +78,22 @@ pub use chain_spec::ChainSpec;
/// Polkadot service. /// Polkadot service.
pub struct Service<Components: components::Components> { pub struct Service<Components: components::Components> {
thread: Option<thread::JoinHandle<()>>,
client: Arc<Client<Components::Backend, Components::Executor, Block>>, client: Arc<Client<Components::Backend, Components::Executor, Block>>,
network: Arc<network::Service<Block>>, network: Arc<NetworkService>,
transaction_pool: Arc<TransactionPool<Components::Api>>, transaction_pool: Arc<TransactionPool<Components::Api>>,
signal: Option<Signal>, signal: Option<Signal>,
_consensus: Option<consensus::Service>, _consensus: Option<consensus::Service>,
} }
/// Creates light client and register protocol with the network service /// Creates light client and register protocol with the network service
pub fn new_light(config: Configuration) -> Result<Service<components::LightComponents>, error::Error> { pub fn new_light(config: Configuration, executor: TaskExecutor) -> Result<Service<components::LightComponents>, error::Error> {
Service::new(components::LightComponents, config) Service::new(components::LightComponents, config, executor)
} }
/// Creates full client and register protocol with the network service /// Creates full client and register protocol with the network service
pub fn new_full(config: Configuration) -> Result<Service<components::FullComponents>, error::Error> { pub fn new_full(config: Configuration, executor: TaskExecutor) -> Result<Service<components::FullComponents>, error::Error> {
let is_validator = (config.roles & Role::VALIDATOR) == Role::VALIDATOR; let is_validator = (config.roles & Role::AUTHORITY) == Role::AUTHORITY;
Service::new(components::FullComponents { is_validator }, config) Service::new(components::FullComponents { is_validator }, config, executor)
} }
/// Creates bare client without any networking. /// Creates bare client without any networking.
@@ -112,7 +109,7 @@ pub fn new_client(config: Configuration) -> Result<Arc<Client<
pruning: config.pruning, pruning: config.pruning,
}; };
let executor = polkadot_executor::Executor::new(); let executor = polkadot_executor::Executor::new();
let is_validator = (config.roles & Role::VALIDATOR) == Role::VALIDATOR; let is_validator = (config.roles & Role::AUTHORITY) == Role::AUTHORITY;
let components = components::FullComponents { is_validator }; let components = components::FullComponents { is_validator };
let (client, _) = components.build_client(db_settings, executor, &config.chain_spec)?; let (client, _) = components.build_client(db_settings, executor, &config.chain_spec)?;
Ok(client) Ok(client)
@@ -124,9 +121,7 @@ impl<Components> Service<Components>
client::error::Error: From<<<<Components as components::Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>, client::error::Error: From<<<<Components as components::Components>::Backend as client::backend::Backend<Block>>::State as state_machine::Backend>::Error>,
{ {
/// Creates and register protocol with the network service /// Creates and register protocol with the network service
fn new(components: Components, config: Configuration) -> Result<Self, error::Error> { fn new(components: Components, config: Configuration, task_executor: TaskExecutor) -> Result<Self, error::Error> {
use std::sync::Barrier;
let (signal, exit) = ::exit_future::signal(); let (signal, exit) = ::exit_future::signal();
// Create client // Create client
@@ -165,61 +160,55 @@ impl<Components> Service<Components>
chain: client.clone(), chain: client.clone(),
on_demand: on_demand.clone().map(|d| d as Arc<network::OnDemandService<Block>>), on_demand: on_demand.clone().map(|d| d as Arc<network::OnDemandService<Block>>),
transaction_pool: transaction_pool_adapter, transaction_pool: transaction_pool_adapter,
specialization: PolkadotProtocol::new(),
}; };
let network = network::Service::new(network_params)?;
let barrier = ::std::sync::Arc::new(Barrier::new(2)); let network = network::Service::new(network_params, ::polkadot_network::DOT_PROTOCOL_ID)?;
on_demand.map(|on_demand| on_demand.set_service_link(Arc::downgrade(&network))); on_demand.map(|on_demand| on_demand.set_service_link(Arc::downgrade(&network)));
let thread = { network.start_network();
let client = client.clone();
{
// block notifications
let network = network.clone(); let network = network.clone();
let txpool = transaction_pool.clone(); let txpool = transaction_pool.clone();
let thread_barrier = barrier.clone(); let events = client.import_notification_stream()
thread::spawn(move || { .for_each(move |notification| {
network.start_network(); network.on_block_imported(notification.hash, &notification.header);
prune_imported(&*txpool, notification.hash);
Ok(())
})
.select(exit.clone())
.then(|_| Ok(()));
task_executor.spawn(events);
}
thread_barrier.wait(); {
let mut core = Core::new().expect("tokio::Core could not be created"); // transaction notifications
let network = network.clone();
let events = transaction_pool.import_notification_stream()
// TODO [ToDr] Consider throttling?
.for_each(move |_| {
network.trigger_repropagate();
Ok(())
})
.select(exit.clone())
.then(|_| Ok(()));
// block notifications task_executor.spawn(events);
let network1 = network.clone(); }
let txpool1 = txpool.clone();
let events = client.import_notification_stream()
.for_each(move |notification| {
network1.on_block_imported(notification.hash, &notification.header);
prune_imported(&*txpool1, notification.hash);
Ok(())
});
core.handle().spawn(events);
// transaction notifications
let events = txpool.import_notification_stream()
// TODO [ToDr] Consider throttling?
.for_each(move |_| {
network.trigger_repropagate();
Ok(())
});
core.handle().spawn(events);
if let Err(e) = core.run(exit) {
debug!("Polkadot service event loop shutdown with {:?}", e);
}
debug!("Polkadot service shutdown");
})
};
// wait for the network to start up before starting the consensus
// service.
barrier.wait();
// Spin consensus service if configured // Spin consensus service if configured
let consensus_service = components.build_consensus(client.clone(), network.clone(), transaction_pool.clone(), &keystore)?; let consensus_service = components.build_consensus(
client.clone(),
network.clone(),
transaction_pool.clone(),
&keystore,
task_executor,
)?;
Ok(Service { Ok(Service {
thread: Some(thread),
client: client, client: client,
network: network, network: network,
transaction_pool: transaction_pool, transaction_pool: transaction_pool,
@@ -234,7 +223,7 @@ impl<Components> Service<Components>
} }
/// Get shared network instance. /// Get shared network instance.
pub fn network(&self) -> Arc<network::Service<Block>> { pub fn network(&self) -> Arc<NetworkService> {
self.network.clone() self.network.clone()
} }
@@ -260,14 +249,12 @@ pub fn prune_imported<A>(pool: &TransactionPool<A>, hash: Hash)
impl<Components> Drop for Service<Components> where Components: components::Components { impl<Components> Drop for Service<Components> where Components: components::Components {
fn drop(&mut self) { fn drop(&mut self) {
debug!(target: "service", "Polkadot service shutdown");
self.network.stop_network(); self.network.stop_network();
if let Some(signal) = self.signal.take() { if let Some(signal) = self.signal.take() {
signal.fire(); signal.fire();
} }
if let Some(thread) = self.thread.take() {
thread.join().expect("The service thread has panicked");
}
} }
} }
@@ -4,5 +4,8 @@ version = "0.1.0"
authors = ["Parity Technologies <admin@parity.io>"] authors = ["Parity Technologies <admin@parity.io>"]
[dependencies] [dependencies]
substrate-codec = { path = "../../substrate/codec" }
substrate-primitives = { path = "../../substrate/primitives" } substrate-primitives = { path = "../../substrate/primitives" }
polkadot-primitives = { path = "../primitives" } polkadot-primitives = { path = "../primitives" }
serde = "1.0"
serde_derive = "1.0"
+276 -364
View File
@@ -27,26 +27,11 @@
//! propose and attest to validity of candidates, and those who can only attest //! propose and attest to validity of candidates, and those who can only attest
//! to availability. //! to availability.
use std::collections::HashSet;
use std::collections::hash_map::{HashMap, Entry}; use std::collections::hash_map::{HashMap, Entry};
use std::hash::Hash; use std::hash::Hash;
use std::fmt::Debug; use std::fmt::Debug;
/// A batch of statements to send out. use codec::{Slicable, Input};
pub trait StatementBatch<V, T> {
/// Get the target authorities of these statements.
fn targets(&self) -> &[V];
/// If the batch is empty.
fn is_empty(&self) -> bool;
/// Push a statement onto the batch. Returns false when the batch is full.
///
/// This is meant to do work like incrementally serializing the statements
/// into a vector of bytes while making sure the length is below a certain
/// amount.
fn push(&mut self, statement: T) -> bool;
}
/// Context for the statement table. /// Context for the statement table.
pub trait Context { pub trait Context {
@@ -85,7 +70,7 @@ pub trait Context {
} }
/// Statements circulated among peers. /// Statements circulated among peers.
#[derive(PartialEq, Eq, Debug, Clone)] #[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize)]
pub enum Statement<C, D> { pub enum Statement<C, D> {
/// Broadcast by a authority to indicate that this is his candidate for /// Broadcast by a authority to indicate that this is his candidate for
/// inclusion. /// inclusion.
@@ -103,8 +88,61 @@ pub enum Statement<C, D> {
Invalid(D), Invalid(D),
} }
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
enum StatementKind {
Candidate = 1,
Valid = 2,
Invalid = 3,
Available = 4,
}
impl<C: Slicable, D: Slicable> Slicable for Statement<C, D> {
fn encode(&self) -> Vec<u8> {
let mut v = Vec::new();
match *self {
Statement::Candidate(ref candidate) => {
v.push(StatementKind::Candidate as u8);
candidate.using_encoded(|s| v.extend(s));
}
Statement::Valid(ref digest) => {
v.push(StatementKind::Valid as u8);
digest.using_encoded(|s| v.extend(s));
}
Statement::Invalid(ref digest) => {
v.push(StatementKind::Invalid as u8);
digest.using_encoded(|s| v.extend(s));
}
Statement::Available(ref digest) => {
v.push(StatementKind::Available as u8);
digest.using_encoded(|s| v.extend(s));
}
}
v
}
fn decode<I: Input>(value: &mut I) -> Option<Self> {
match value.read_byte() {
Some(x) if x == StatementKind::Candidate as u8 => {
Slicable::decode(value).map(Statement::Candidate)
}
Some(x) if x == StatementKind::Valid as u8 => {
Slicable::decode(value).map(Statement::Valid)
}
Some(x) if x == StatementKind::Invalid as u8 => {
Slicable::decode(value).map(Statement::Invalid)
}
Some(x) if x == StatementKind::Available as u8 => {
Slicable::decode(value).map(Statement::Available)
}
_ => None,
}
}
}
/// A signed statement. /// A signed statement.
#[derive(PartialEq, Eq, Debug, Clone)] #[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize)]
pub struct SignedStatement<C, D, V, S> { pub struct SignedStatement<C, D, V, S> {
/// The statement. /// The statement.
pub statement: Statement<C, D>, pub statement: Statement<C, D>,
@@ -114,26 +152,6 @@ pub struct SignedStatement<C, D, V, S> {
pub sender: V, pub sender: V,
} }
// A unique trace for a class of valid statements issued by a authority.
//
// We keep track of which statements we have received or sent to other authorities
// in order to prevent relaying the same data multiple times.
//
// The signature of the statement is replaced by the authority because the authority
// is unique while signatures are not (at least under common schemes like
// Schnorr or ECDSA).
#[derive(Hash, PartialEq, Eq, Clone)]
enum StatementTrace<V, D> {
/// The candidate proposed by the authority.
Candidate(V),
/// A validity statement from that authority about the given digest.
Valid(V, D),
/// An invalidity statement from that authority about the given digest.
Invalid(V, D),
/// An availability statement from that authority about the given digest.
Available(V, D),
}
/// Misbehavior: voting more than one way on candidate validity. /// Misbehavior: voting more than one way on candidate validity.
/// ///
/// Since there are three possible ways to vote, a double vote is possible in /// Since there are three possible ways to vote, a double vote is possible in
@@ -148,6 +166,19 @@ pub enum ValidityDoubleVote<C, D, S> {
ValidityAndInvalidity(D, S, S), ValidityAndInvalidity(D, S, S),
} }
/// Misbehavior: multiple signatures on same statement.
#[derive(PartialEq, Eq, Debug, Clone)]
pub enum DoubleSign<C, D, S> {
/// On candidate.
Candidate(C, S, S),
/// On validity.
Validity(D, S, S),
/// On invalidity.
Invalidity(D, S, S),
/// On availability.
Availability(D, S, S),
}
/// Misbehavior: declaring multiple candidates. /// Misbehavior: declaring multiple candidates.
#[derive(PartialEq, Eq, Debug, Clone)] #[derive(PartialEq, Eq, Debug, Clone)]
pub struct MultipleCandidates<C, S> { pub struct MultipleCandidates<C, S> {
@@ -172,20 +203,14 @@ pub enum Misbehavior<C, D, V, S> {
ValidityDoubleVote(ValidityDoubleVote<C, D, S>), ValidityDoubleVote(ValidityDoubleVote<C, D, S>),
/// Submitted multiple candidates. /// Submitted multiple candidates.
MultipleCandidates(MultipleCandidates<C, S>), MultipleCandidates(MultipleCandidates<C, S>),
/// Submitted a message withou /// Submitted a message that was unauthorized.
UnauthorizedStatement(UnauthorizedStatement<C, D, V, S>), UnauthorizedStatement(UnauthorizedStatement<C, D, V, S>),
/// Submitted two valid signatures for the same message.
DoubleSign(DoubleSign<C, D, S>),
} }
/// Fancy work-around for a type alias of context-based misbehavior /// Type alias for misbehavior corresponding to context type.
/// without producing compiler warnings. pub type MisbehaviorFor<C> = Misbehavior<<C as Context>::Candidate, <C as Context>::Digest, <C as Context>::AuthorityId, <C as Context>::Signature>;
pub trait ResolveMisbehavior {
/// The misbehavior type.
type Misbehavior;
}
impl<C: Context + ?Sized> ResolveMisbehavior for C {
type Misbehavior = Misbehavior<C::Candidate, C::Digest, C::AuthorityId, C::Signature>;
}
// kinds of votes for validity // kinds of votes for validity
#[derive(Clone, PartialEq, Eq)] #[derive(Clone, PartialEq, Eq)]
@@ -251,22 +276,26 @@ impl<C: Context> CandidateData<C> {
// authority metadata // authority metadata
struct AuthorityData<C: Context> { struct AuthorityData<C: Context> {
proposal: Option<(C::Digest, C::Signature)>, proposal: Option<(C::Digest, C::Signature)>,
known_statements: HashSet<StatementTrace<C::AuthorityId, C::Digest>>,
} }
impl<C: Context> Default for AuthorityData<C> { impl<C: Context> Default for AuthorityData<C> {
fn default() -> Self { fn default() -> Self {
AuthorityData { AuthorityData {
proposal: None, proposal: None,
known_statements: HashSet::default(),
} }
} }
} }
/// Type alias for the result of a statement import.
pub type ImportResult<C> = Result<
Option<Summary<<C as Context>::Digest, <C as Context>::GroupId>>,
MisbehaviorFor<C>
>;
/// Stores votes /// Stores votes
pub struct Table<C: Context> { pub struct Table<C: Context> {
authority_data: HashMap<C::AuthorityId, AuthorityData<C>>, authority_data: HashMap<C::AuthorityId, AuthorityData<C>>,
detected_misbehavior: HashMap<C::AuthorityId, <C as ResolveMisbehavior>::Misbehavior>, detected_misbehavior: HashMap<C::AuthorityId, MisbehaviorFor<C>>,
candidate_votes: HashMap<C::Digest, CandidateData<C>>, candidate_votes: HashMap<C::Digest, CandidateData<C>>,
includable_count: HashMap<C::GroupId, usize>, includable_count: HashMap<C::GroupId, usize>,
} }
@@ -328,26 +357,17 @@ impl<C: Context> Table<C> {
} }
/// Import a signed statement. Signatures should be checked for validity, and the /// Import a signed statement. Signatures should be checked for validity, and the
/// sender should be checked to actually be a authority. /// sender should be checked to actually be an authority.
/// ///
/// This can note the origin of the statement to indicate that he has /// If this returns `None`, the statement was either duplicate or invalid.
/// seen it already.
pub fn import_statement( pub fn import_statement(
&mut self, &mut self,
context: &C, context: &C,
statement: SignedStatement<C::Candidate, C::Digest, C::AuthorityId, C::Signature>, statement: SignedStatement<C::Candidate, C::Digest, C::AuthorityId, C::Signature>,
from: Option<C::AuthorityId>
) -> Option<Summary<C::Digest, C::GroupId>> { ) -> Option<Summary<C::Digest, C::GroupId>> {
let SignedStatement { statement, signature, sender: signer } = statement; let SignedStatement { statement, signature, sender: signer } = statement;
let trace = match statement { let res = match statement {
Statement::Candidate(_) => StatementTrace::Candidate(signer.clone()),
Statement::Valid(ref d) => StatementTrace::Valid(signer.clone(), d.clone()),
Statement::Invalid(ref d) => StatementTrace::Invalid(signer.clone(), d.clone()),
Statement::Available(ref d) => StatementTrace::Available(signer.clone(), d.clone()),
};
let (maybe_misbehavior, maybe_summary) = match statement {
Statement::Candidate(candidate) => self.import_candidate( Statement::Candidate(candidate) => self.import_candidate(
context, context,
signer.clone(), signer.clone(),
@@ -374,19 +394,15 @@ impl<C: Context> Table<C> {
), ),
}; };
if let Some(misbehavior) = maybe_misbehavior { match res {
// all misbehavior in agreement is provable and actively malicious. Ok(maybe_summary) => maybe_summary,
// punishments are not cumulative. Err(misbehavior) => {
self.detected_misbehavior.insert(signer, misbehavior); // all misbehavior in agreement is provable and actively malicious.
} else { // punishments are not cumulative.
if let Some(from) = from { self.detected_misbehavior.insert(signer, misbehavior);
self.note_trace_seen(trace.clone(), from); None
} }
self.note_trace_seen(trace, signer);
} }
maybe_summary
} }
/// Get a candidate by digest. /// Get a candidate by digest.
@@ -396,7 +412,7 @@ impl<C: Context> Table<C> {
/// Access all witnessed misbehavior. /// Access all witnessed misbehavior.
pub fn get_misbehavior(&self) pub fn get_misbehavior(&self)
-> &HashMap<C::AuthorityId, <C as ResolveMisbehavior>::Misbehavior> -> &HashMap<C::AuthorityId, MisbehaviorFor<C>>
{ {
&self.detected_misbehavior &self.detected_misbehavior
} }
@@ -406,155 +422,22 @@ impl<C: Context> Table<C> {
self.includable_count.len() self.includable_count.len()
} }
/// Fill a statement batch and note messages as seen by the targets.
pub fn fill_batch<B>(&mut self, batch: &mut B)
where B: StatementBatch<
C::AuthorityId,
SignedStatement<C::Candidate, C::Digest, C::AuthorityId, C::Signature>,
>
{
// naively iterate all statements so far, taking any that
// at least one of the targets has not seen.
// workaround for the fact that it's inconvenient to borrow multiple
// entries out of a hashmap mutably -- we just move them out and
// replace them when we're done.
struct SwappedTargetData<'a, C: 'a + Context> {
authority_data: &'a mut HashMap<C::AuthorityId, AuthorityData<C>>,
target_data: Vec<(C::AuthorityId, AuthorityData<C>)>,
}
impl<'a, C: 'a + Context> Drop for SwappedTargetData<'a, C> {
fn drop(&mut self) {
for (id, data) in self.target_data.drain(..) {
self.authority_data.insert(id, data);
}
}
}
// pre-fetch authority data for all the targets.
let mut target_data = {
let authority_data = &mut self.authority_data;
let mut target_data = Vec::with_capacity(batch.targets().len());
for target in batch.targets() {
let active_data = match authority_data.get_mut(target) {
None => Default::default(),
Some(x) => ::std::mem::replace(x, Default::default()),
};
target_data.push((target.clone(), active_data));
}
SwappedTargetData {
authority_data,
target_data
}
};
let target_data = &mut target_data.target_data;
macro_rules! attempt_send {
($trace:expr, sender=$sender:expr, sig=$sig:expr, statement=$statement:expr) => {{
let trace = $trace;
let can_send = target_data.iter()
.any(|t| !t.1.known_statements.contains(&trace));
if can_send {
let statement = SignedStatement {
statement: $statement,
signature: $sig,
sender: $sender,
};
if batch.push(statement) {
for target in target_data.iter_mut() {
target.1.known_statements.insert(trace.clone());
}
} else {
return;
}
}
}}
}
// reconstruct statements for anything whose trace passes the filter.
for (digest, candidate) in self.candidate_votes.iter() {
let issuance_iter = candidate.validity_votes.iter()
.filter(|&(_, x)| if let ValidityVote::Issued(_) = *x { true } else { false });
let validity_iter = candidate.validity_votes.iter()
.filter(|&(_, x)| if let ValidityVote::Issued(_) = *x { false } else { true });
// send issuance statements before votes.
for (sender, vote) in issuance_iter.chain(validity_iter) {
match *vote {
ValidityVote::Issued(ref sig) => {
attempt_send!(
StatementTrace::Candidate(sender.clone()),
sender = sender.clone(),
sig = sig.clone(),
statement = Statement::Candidate(candidate.candidate.clone())
)
}
ValidityVote::Valid(ref sig) => {
attempt_send!(
StatementTrace::Valid(sender.clone(), digest.clone()),
sender = sender.clone(),
sig = sig.clone(),
statement = Statement::Valid(digest.clone())
)
}
ValidityVote::Invalid(ref sig) => {
attempt_send!(
StatementTrace::Invalid(sender.clone(), digest.clone()),
sender = sender.clone(),
sig = sig.clone(),
statement = Statement::Invalid(digest.clone())
)
}
}
};
// and lastly send availability.
for (sender, sig) in candidate.availability_votes.iter() {
attempt_send!(
StatementTrace::Available(sender.clone(), digest.clone()),
sender = sender.clone(),
sig = sig.clone(),
statement = Statement::Available(digest.clone())
)
}
}
}
fn note_trace_seen(&mut self, trace: StatementTrace<C::AuthorityId, C::Digest>, known_by: C::AuthorityId) {
self.authority_data.entry(known_by).or_insert_with(|| AuthorityData {
proposal: None,
known_statements: HashSet::default(),
}).known_statements.insert(trace);
}
fn import_candidate( fn import_candidate(
&mut self, &mut self,
context: &C, context: &C,
from: C::AuthorityId, from: C::AuthorityId,
candidate: C::Candidate, candidate: C::Candidate,
signature: C::Signature, signature: C::Signature,
) -> (Option<<C as ResolveMisbehavior>::Misbehavior>, Option<Summary<C::Digest, C::GroupId>>) { ) -> ImportResult<C> {
let group = C::candidate_group(&candidate); let group = C::candidate_group(&candidate);
if !context.is_member_of(&from, &group) { if !context.is_member_of(&from, &group) {
return ( return Err(Misbehavior::UnauthorizedStatement(UnauthorizedStatement {
Some(Misbehavior::UnauthorizedStatement(UnauthorizedStatement { statement: SignedStatement {
statement: SignedStatement { signature,
signature, statement: Statement::Candidate(candidate),
statement: Statement::Candidate(candidate), sender: from,
sender: from, },
}, }));
})),
None,
);
} }
// check that authority hasn't already specified another candidate. // check that authority hasn't already specified another candidate.
@@ -578,13 +461,10 @@ impl<C: Context> Table<C> {
.candidate .candidate
.clone(); .clone();
return ( return Err(Misbehavior::MultipleCandidates(MultipleCandidates {
Some(Misbehavior::MultipleCandidates(MultipleCandidates { first: (old_candidate, old_sig.clone()),
first: (old_candidate, old_sig.clone()), second: (candidate, signature.clone()),
second: (candidate, signature.clone()), }));
})),
None,
);
} }
false false
@@ -596,7 +476,6 @@ impl<C: Context> Table<C> {
Entry::Vacant(vacant) => { Entry::Vacant(vacant) => {
vacant.insert(AuthorityData { vacant.insert(AuthorityData {
proposal: Some((digest.clone(), signature.clone())), proposal: Some((digest.clone(), signature.clone())),
known_statements: HashSet::new(),
}); });
true true
} }
@@ -628,9 +507,9 @@ impl<C: Context> Table<C> {
from: C::AuthorityId, from: C::AuthorityId,
digest: C::Digest, digest: C::Digest,
vote: ValidityVote<C::Signature>, vote: ValidityVote<C::Signature>,
) -> (Option<<C as ResolveMisbehavior>::Misbehavior>, Option<Summary<C::Digest, C::GroupId>>) { ) -> ImportResult<C> {
let votes = match self.candidate_votes.get_mut(&digest) { let votes = match self.candidate_votes.get_mut(&digest) {
None => return (None, None), // TODO: queue up but don't get DoS'ed None => return Ok(None),
Some(votes) => votes, Some(votes) => votes,
}; };
@@ -647,50 +526,56 @@ impl<C: Context> Table<C> {
checking group membership of issuer; qed"), checking group membership of issuer; qed"),
}; };
return ( return Err(Misbehavior::UnauthorizedStatement(UnauthorizedStatement {
Some(Misbehavior::UnauthorizedStatement(UnauthorizedStatement { statement: SignedStatement {
statement: SignedStatement { signature: sig,
signature: sig, sender: from,
sender: from, statement: if valid {
statement: if valid { Statement::Valid(digest)
Statement::Valid(digest) } else {
} else { Statement::Invalid(digest)
Statement::Invalid(digest)
}
} }
})), }
None, }));
);
} }
// check for double votes. // check for double votes.
match votes.validity_votes.entry(from.clone()) { match votes.validity_votes.entry(from.clone()) {
Entry::Occupied(occ) => { Entry::Occupied(occ) => {
if occ.get() != &vote { let make_vdv = |v| Misbehavior::ValidityDoubleVote(v);
let double_vote_proof = match (occ.get().clone(), vote) { let make_ds = |ds| Misbehavior::DoubleSign(ds);
return if occ.get() != &vote {
Err(match (occ.get().clone(), vote) {
// valid vote conflicting with candidate statement
(ValidityVote::Issued(iss), ValidityVote::Valid(good)) | (ValidityVote::Issued(iss), ValidityVote::Valid(good)) |
(ValidityVote::Valid(good), ValidityVote::Issued(iss)) => (ValidityVote::Valid(good), ValidityVote::Issued(iss)) =>
ValidityDoubleVote::IssuedAndValidity((votes.candidate.clone(), iss), (digest, good)), make_vdv(ValidityDoubleVote::IssuedAndValidity((votes.candidate.clone(), iss), (digest, good))),
// invalid vote conflicting with candidate statement
(ValidityVote::Issued(iss), ValidityVote::Invalid(bad)) | (ValidityVote::Issued(iss), ValidityVote::Invalid(bad)) |
(ValidityVote::Invalid(bad), ValidityVote::Issued(iss)) => (ValidityVote::Invalid(bad), ValidityVote::Issued(iss)) =>
ValidityDoubleVote::IssuedAndInvalidity((votes.candidate.clone(), iss), (digest, bad)), make_vdv(ValidityDoubleVote::IssuedAndInvalidity((votes.candidate.clone(), iss), (digest, bad))),
// valid vote conflicting with invalid vote
(ValidityVote::Valid(good), ValidityVote::Invalid(bad)) | (ValidityVote::Valid(good), ValidityVote::Invalid(bad)) |
(ValidityVote::Invalid(bad), ValidityVote::Valid(good)) => (ValidityVote::Invalid(bad), ValidityVote::Valid(good)) =>
ValidityDoubleVote::ValidityAndInvalidity(digest, good, bad), make_vdv(ValidityDoubleVote::ValidityAndInvalidity(digest, good, bad)),
_ => {
// this would occur if two different but valid signatures
// on the same kind of vote occurred.
return (None, None);
}
};
return ( // two signatures on same candidate
Some(Misbehavior::ValidityDoubleVote(double_vote_proof)), (ValidityVote::Issued(a), ValidityVote::Issued(b)) =>
None, make_ds(DoubleSign::Candidate(votes.candidate.clone(), a, b)),
)
// two signatures on same validity vote
(ValidityVote::Valid(a), ValidityVote::Valid(b)) =>
make_ds(DoubleSign::Validity(digest, a, b)),
// two signature on same invalidity vote
(ValidityVote::Invalid(a), ValidityVote::Invalid(b)) =>
make_ds(DoubleSign::Invalidity(digest, a, b)),
})
} else {
Ok(None)
} }
return (None, None);
} }
Entry::Vacant(vacant) => { Entry::Vacant(vacant) => {
if let ValidityVote::Invalid(_) = vote { if let ValidityVote::Invalid(_) = vote {
@@ -704,7 +589,7 @@ impl<C: Context> Table<C> {
let is_includable = votes.can_be_included(v_threshold, a_threshold); let is_includable = votes.can_be_included(v_threshold, a_threshold);
update_includable_count(&mut self.includable_count, &votes.group_id, was_includable, is_includable); update_includable_count(&mut self.includable_count, &votes.group_id, was_includable, is_includable);
(None, Some(votes.summary(digest))) Ok(Some(votes.summary(digest)))
} }
fn availability_vote( fn availability_vote(
@@ -713,9 +598,9 @@ impl<C: Context> Table<C> {
from: C::AuthorityId, from: C::AuthorityId,
digest: C::Digest, digest: C::Digest,
signature: C::Signature, signature: C::Signature,
) -> (Option<<C as ResolveMisbehavior>::Misbehavior>, Option<Summary<C::Digest, C::GroupId>>) { ) -> ImportResult<C> {
let votes = match self.candidate_votes.get_mut(&digest) { let votes = match self.candidate_votes.get_mut(&digest) {
None => return (None, None), // TODO: queue up but don't get DoS'ed None => return Ok(None),
Some(votes) => votes, Some(votes) => votes,
}; };
@@ -724,24 +609,26 @@ impl<C: Context> Table<C> {
// check that this authority actually can vote in this group. // check that this authority actually can vote in this group.
if !context.is_availability_guarantor_of(&from, &votes.group_id) { if !context.is_availability_guarantor_of(&from, &votes.group_id) {
return ( return Err(Misbehavior::UnauthorizedStatement(UnauthorizedStatement {
Some(Misbehavior::UnauthorizedStatement(UnauthorizedStatement { statement: SignedStatement {
statement: SignedStatement { signature: signature,
signature: signature.clone(), statement: Statement::Available(digest),
statement: Statement::Available(digest), sender: from,
sender: from, }
} }));
})),
None
);
} }
votes.availability_votes.insert(from, signature); match votes.availability_votes.entry(from) {
Entry::Occupied(ref occ) if occ.get() != &signature => return Err(
Misbehavior::DoubleSign(DoubleSign::Availability(digest, signature, occ.get().clone()))
),
entry => { let _ = entry.or_insert(signature); },
}
let is_includable = votes.can_be_included(v_threshold, a_threshold); let is_includable = votes.can_be_included(v_threshold, a_threshold);
update_includable_count(&mut self.includable_count, &votes.group_id, was_includable, is_includable); update_includable_count(&mut self.includable_count, &votes.group_id, was_includable, is_includable);
(None, Some(votes.summary(digest))) Ok(Some(votes.summary(digest)))
} }
} }
@@ -765,26 +652,6 @@ mod tests {
use super::*; use super::*;
use std::collections::HashMap; use std::collections::HashMap;
#[derive(Debug, Clone)]
struct VecBatch<V, T> {
pub max_len: usize,
pub targets: Vec<V>,
pub items: Vec<T>,
}
impl<V, T> ::generic::StatementBatch<V, T> for VecBatch<V, T> {
fn targets(&self) -> &[V] { &self.targets }
fn is_empty(&self) -> bool { self.items.is_empty() }
fn push(&mut self, item: T) -> bool {
if self.items.len() == self.max_len {
false
} else {
self.items.push(item);
true
}
}
}
fn create<C: Context>() -> Table<C> { fn create<C: Context>() -> Table<C> {
Table::default() Table::default()
} }
@@ -878,10 +745,10 @@ mod tests {
sender: AuthorityId(1), sender: AuthorityId(1),
}; };
table.import_statement(&context, statement_a, None); table.import_statement(&context, statement_a);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
table.import_statement(&context, statement_b, None); table.import_statement(&context, statement_b);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(1)).unwrap(), table.detected_misbehavior.get(&AuthorityId(1)).unwrap(),
&Misbehavior::MultipleCandidates(MultipleCandidates { &Misbehavior::MultipleCandidates(MultipleCandidates {
@@ -908,7 +775,7 @@ mod tests {
sender: AuthorityId(1), sender: AuthorityId(1),
}; };
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(1)).unwrap(), table.detected_misbehavior.get(&AuthorityId(1)).unwrap(),
@@ -949,8 +816,8 @@ mod tests {
}; };
let candidate_b_digest = Digest(987); let candidate_b_digest = Digest(987);
table.import_statement(&context, candidate_a, None); table.import_statement(&context, candidate_a);
table.import_statement(&context, candidate_b, None); table.import_statement(&context, candidate_b);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
@@ -960,7 +827,7 @@ mod tests {
signature: Signature(1), signature: Signature(1),
sender: AuthorityId(1), sender: AuthorityId(1),
}; };
table.import_statement(&context, bad_availability_vote, None); table.import_statement(&context, bad_availability_vote);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(1)).unwrap(), table.detected_misbehavior.get(&AuthorityId(1)).unwrap(),
@@ -979,7 +846,7 @@ mod tests {
signature: Signature(2), signature: Signature(2),
sender: AuthorityId(2), sender: AuthorityId(2),
}; };
table.import_statement(&context, bad_validity_vote, None); table.import_statement(&context, bad_validity_vote);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(2)).unwrap(), table.detected_misbehavior.get(&AuthorityId(2)).unwrap(),
@@ -1012,7 +879,7 @@ mod tests {
}; };
let candidate_digest = Digest(100); let candidate_digest = Digest(100);
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
let valid_statement = SignedStatement { let valid_statement = SignedStatement {
@@ -1027,10 +894,10 @@ mod tests {
sender: AuthorityId(2), sender: AuthorityId(2),
}; };
table.import_statement(&context, valid_statement, None); table.import_statement(&context, valid_statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
table.import_statement(&context, invalid_statement, None); table.import_statement(&context, invalid_statement);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(2)).unwrap(), table.detected_misbehavior.get(&AuthorityId(2)).unwrap(),
@@ -1042,6 +909,102 @@ mod tests {
); );
} }
#[test]
fn candidate_double_signature_is_misbehavior() {
let context = TestContext {
authorities: {
let mut map = HashMap::new();
map.insert(AuthorityId(1), (GroupId(2), GroupId(455)));
map.insert(AuthorityId(2), (GroupId(2), GroupId(246)));
map
}
};
let mut table = create();
let statement = SignedStatement {
statement: Statement::Candidate(Candidate(2, 100)),
signature: Signature(1),
sender: AuthorityId(1),
};
table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
let invalid_statement = SignedStatement {
statement: Statement::Candidate(Candidate(2, 100)),
signature: Signature(999),
sender: AuthorityId(1),
};
table.import_statement(&context, invalid_statement);
assert!(table.detected_misbehavior.contains_key(&AuthorityId(1)));
}
#[test]
fn validity_invalidity_double_signature_is_misbehavior() {
let context = TestContext {
authorities: {
let mut map = HashMap::new();
map.insert(AuthorityId(1), (GroupId(2), GroupId(455)));
map.insert(AuthorityId(2), (GroupId(2), GroupId(246)));
map.insert(AuthorityId(3), (GroupId(2), GroupId(222)));
map
}
};
let mut table = create();
let statement = SignedStatement {
statement: Statement::Candidate(Candidate(2, 100)),
signature: Signature(1),
sender: AuthorityId(1),
};
table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
// insert two validity votes from authority 2 with different signatures
{
let statement = SignedStatement {
statement: Statement::Valid(Digest(100)),
signature: Signature(2),
sender: AuthorityId(2),
};
table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
let invalid_statement = SignedStatement {
statement: Statement::Valid(Digest(100)),
signature: Signature(222),
sender: AuthorityId(2),
};
table.import_statement(&context, invalid_statement);
assert!(table.detected_misbehavior.contains_key(&AuthorityId(2)));
}
// insert two invalidity votes from authority 2 with different signatures
{
let statement = SignedStatement {
statement: Statement::Invalid(Digest(100)),
signature: Signature(3),
sender: AuthorityId(3),
};
table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(3)));
let invalid_statement = SignedStatement {
statement: Statement::Invalid(Digest(100)),
signature: Signature(333),
sender: AuthorityId(3),
};
table.import_statement(&context, invalid_statement);
assert!(table.detected_misbehavior.contains_key(&AuthorityId(3)));
}
}
#[test] #[test]
fn issue_and_vote_is_misbehavior() { fn issue_and_vote_is_misbehavior() {
let context = TestContext { let context = TestContext {
@@ -1060,7 +1023,7 @@ mod tests {
}; };
let candidate_digest = Digest(100); let candidate_digest = Digest(100);
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
let extra_vote = SignedStatement { let extra_vote = SignedStatement {
@@ -1069,7 +1032,7 @@ mod tests {
sender: AuthorityId(1), sender: AuthorityId(1),
}; };
table.import_statement(&context, extra_vote, None); table.import_statement(&context, extra_vote);
assert_eq!( assert_eq!(
table.detected_misbehavior.get(&AuthorityId(1)).unwrap(), table.detected_misbehavior.get(&AuthorityId(1)).unwrap(),
&Misbehavior::ValidityDoubleVote(ValidityDoubleVote::IssuedAndValidity( &Misbehavior::ValidityDoubleVote(ValidityDoubleVote::IssuedAndValidity(
@@ -1133,7 +1096,7 @@ mod tests {
}; };
let candidate_digest = Digest(100); let candidate_digest = Digest(100);
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
assert!(!table.candidate_includable(&candidate_digest, &context)); assert!(!table.candidate_includable(&candidate_digest, &context));
assert!(table.includable_count.is_empty()); assert!(table.includable_count.is_empty());
@@ -1144,7 +1107,7 @@ mod tests {
sender: AuthorityId(2), sender: AuthorityId(2),
}; };
table.import_statement(&context, vote, None); table.import_statement(&context, vote);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
assert!(!table.candidate_includable(&candidate_digest, &context)); assert!(!table.candidate_includable(&candidate_digest, &context));
assert!(table.includable_count.is_empty()); assert!(table.includable_count.is_empty());
@@ -1156,7 +1119,7 @@ mod tests {
sender: AuthorityId(4), sender: AuthorityId(4),
}; };
table.import_statement(&context, vote, None); table.import_statement(&context, vote);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(4))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(4)));
assert!(table.candidate_includable(&candidate_digest, &context)); assert!(table.candidate_includable(&candidate_digest, &context));
assert!(table.includable_count.get(&GroupId(2)).is_some()); assert!(table.includable_count.get(&GroupId(2)).is_some());
@@ -1168,7 +1131,7 @@ mod tests {
sender: AuthorityId(3), sender: AuthorityId(3),
}; };
table.import_statement(&context, vote, None); table.import_statement(&context, vote);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
assert!(!table.candidate_includable(&candidate_digest, &context)); assert!(!table.candidate_includable(&candidate_digest, &context));
assert!(table.includable_count.is_empty()); assert!(table.includable_count.is_empty());
@@ -1191,7 +1154,7 @@ mod tests {
sender: AuthorityId(1), sender: AuthorityId(1),
}; };
let summary = table.import_statement(&context, statement, None) let summary = table.import_statement(&context, statement)
.expect("candidate import to give summary"); .expect("candidate import to give summary");
assert_eq!(summary.candidate, Digest(100)); assert_eq!(summary.candidate, Digest(100));
@@ -1219,7 +1182,7 @@ mod tests {
}; };
let candidate_digest = Digest(100); let candidate_digest = Digest(100);
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
let vote = SignedStatement { let vote = SignedStatement {
@@ -1228,7 +1191,7 @@ mod tests {
sender: AuthorityId(2), sender: AuthorityId(2),
}; };
let summary = table.import_statement(&context, vote, None) let summary = table.import_statement(&context, vote)
.expect("candidate vote to give summary"); .expect("candidate vote to give summary");
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
@@ -1258,7 +1221,7 @@ mod tests {
}; };
let candidate_digest = Digest(100); let candidate_digest = Digest(100);
table.import_statement(&context, statement, None); table.import_statement(&context, statement);
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(1)));
let vote = SignedStatement { let vote = SignedStatement {
@@ -1267,7 +1230,7 @@ mod tests {
sender: AuthorityId(2), sender: AuthorityId(2),
}; };
let summary = table.import_statement(&context, vote, None) let summary = table.import_statement(&context, vote)
.expect("candidate vote to give summary"); .expect("candidate vote to give summary");
assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2))); assert!(!table.detected_misbehavior.contains_key(&AuthorityId(2)));
@@ -1277,55 +1240,4 @@ mod tests {
assert_eq!(summary.validity_votes, 1); assert_eq!(summary.validity_votes, 1);
assert_eq!(summary.availability_votes, 1); assert_eq!(summary.availability_votes, 1);
} }
#[test]
fn filling_batch_sets_known_flag() {
let context = TestContext {
authorities: {
let mut map = HashMap::new();
for i in 1..10 {
map.insert(AuthorityId(i), (GroupId(2), GroupId(400 + i)));
}
map
}
};
let mut table = create();
let statement = SignedStatement {
statement: Statement::Candidate(Candidate(2, 100)),
signature: Signature(1),
sender: AuthorityId(1),
};
table.import_statement(&context, statement, None);
for i in 2..10 {
let statement = SignedStatement {
statement: Statement::Valid(Digest(100)),
signature: Signature(i),
sender: AuthorityId(i),
};
table.import_statement(&context, statement, None);
}
let mut batch = VecBatch {
max_len: 5,
targets: (1..10).map(AuthorityId).collect(),
items: Vec::new(),
};
// 9 statements in the table, each seen by one.
table.fill_batch(&mut batch);
assert_eq!(batch.items.len(), 5);
// 9 statements in the table, 5 of which seen by all targets.
batch.items.clear();
table.fill_batch(&mut batch);
assert_eq!(batch.items.len(), 4);
batch.items.clear();
table.fill_batch(&mut batch);
assert!(batch.items.is_empty());
}
} }
+5 -24
View File
@@ -14,9 +14,14 @@
//! propose and attest to validity of candidates, and those who can only attest //! propose and attest to validity of candidates, and those who can only attest
//! to availability. //! to availability.
extern crate substrate_codec as codec;
extern crate substrate_primitives; extern crate substrate_primitives;
extern crate polkadot_primitives as primitives; extern crate polkadot_primitives as primitives;
extern crate serde;
#[macro_use]
extern crate serde_derive;
pub mod generic; pub mod generic;
pub use generic::Table; pub use generic::Table;
@@ -82,27 +87,3 @@ impl<C: Context> generic::Context for C {
Context::requisite_votes(self, group) Context::requisite_votes(self, group)
} }
} }
/// A batch of statements to send out.
pub trait StatementBatch {
/// Get the target authorities of these statements.
fn targets(&self) -> &[SessionKey];
/// If the batch is empty.
fn is_empty(&self) -> bool;
/// Push a statement onto the batch. Returns false when the batch is full.
///
/// This is meant to do work like incrementally serializing the statements
/// into a vector of bytes while making sure the length is below a certain
/// amount.
fn push(&mut self, statement: SignedStatement) -> bool;
}
impl<T: StatementBatch> generic::StatementBatch<SessionKey, SignedStatement> for T {
fn targets(&self) -> &[SessionKey] { StatementBatch::targets(self ) }
fn is_empty(&self) -> bool { StatementBatch::is_empty(self) }
fn push(&mut self, statement: SignedStatement) -> bool {
StatementBatch::push(self, statement)
}
}
+1 -2
View File
@@ -10,7 +10,7 @@ substrate-primitives = { path = "../primitives" }
substrate-runtime-support = { path = "../runtime-support" } substrate-runtime-support = { path = "../runtime-support" }
substrate-runtime-primitives = { path = "../runtime/primitives" } substrate-runtime-primitives = { path = "../runtime/primitives" }
ed25519 = { path = "../ed25519" } ed25519 = { path = "../ed25519" }
tokio-timer = "0.1.2" tokio = "0.1.7"
parking_lot = "0.4" parking_lot = "0.4"
error-chain = "0.12" error-chain = "0.12"
log = "0.3" log = "0.3"
@@ -18,4 +18,3 @@ log = "0.3"
[dev-dependencies] [dev-dependencies]
substrate-keyring = { path = "../keyring" } substrate-keyring = { path = "../keyring" }
substrate-executor = { path = "../executor" } substrate-executor = { path = "../executor" }
tokio-core = "0.1.12"
+3 -3
View File
@@ -31,9 +31,9 @@ error_chain! {
} }
/// Unable to schedule wakeup. /// Unable to schedule wakeup.
FaultyTimer { FaultyTimer(e: ::tokio::timer::Error) {
description("Faulty timer: unable to schedule wakeup"), description("Timer error"),
display("Faulty timer: unable to schedule wakeup"), display("Timer error: {}", e),
} }
/// Unable to propose a block. /// Unable to propose a block.
+1 -11
View File
@@ -812,17 +812,7 @@ impl<C: Context, I, O> Agreement<C, I, O> {
/// `max_faulty` is the maximum number of faulty nodes. Should be less than /// `max_faulty` is the maximum number of faulty nodes. Should be less than
/// 1/3 of `nodes`, otherwise agreement may never be reached. /// 1/3 of `nodes`, otherwise agreement may never be reached.
/// ///
/// The input stream should never logically conclude. The logic here assumes /// The input and output streams should follow the constraints documented in the crate root.
/// that messages flushed to the output stream will eventually reach other nodes.
///
/// Note that it is possible to witness agreement being reached without ever
/// seeing the candidate. Any candidates seen will be checked for validity.
///
/// Although technically the agreement will always complete (given the eventual
/// delivery of messages), in practice it is possible for this future to
/// conclude without having witnessed the conclusion.
/// In general, this future should be pre-empted by the import of a justification
/// set for this block height.
pub fn agree<C: Context, I, O>(context: C, nodes: usize, max_faulty: usize, input: I, output: O) pub fn agree<C: Context, I, O>(context: C, nodes: usize, max_faulty: usize, input: I, output: O)
-> Agreement<C, I, O> -> Agreement<C, I, O>
where where
+251 -286
View File
@@ -21,13 +21,14 @@ use super::*;
use std::collections::BTreeSet; use std::collections::BTreeSet;
use std::sync::{Arc, Mutex}; use std::sync::{Arc, Mutex};
use std::sync::atomic::{AtomicUsize, Ordering}; use std::sync::atomic::{AtomicUsize, Ordering};
use std::time::Duration; use std::time::{Instant, Duration};
use futures::prelude::*; use futures::sync::mpsc;
use futures::sync::{oneshot, mpsc}; use futures::future::{self, FutureResult};
use futures::future::FutureResult;
use tokio_timer::{self, Timer}; use tokio::timer::Delay;
use tokio::runtime;
use tokio::prelude::*;
const ROUND_DURATION: Duration = Duration::from_millis(50); const ROUND_DURATION: Duration = Duration::from_millis(50);
@@ -60,8 +61,8 @@ impl<T: Clone + Send + 'static> Network<T> {
(network, inputs, outputs) (network, inputs, outputs)
} }
fn route_on_thread(self) { fn route_in_background(self) {
::std::thread::spawn(move || { let _ = self.wait(); }); ::tokio::executor::spawn(self);
} }
} }
@@ -94,7 +95,7 @@ impl<T: Clone> Future for Network<T> {
#[derive(Debug, PartialEq, Eq, Clone, Hash)] #[derive(Debug, PartialEq, Eq, Clone, Hash)]
struct Candidate(usize); struct Candidate(usize);
#[derive(Debug, PartialEq, Eq, Clone, Hash)] #[derive(Debug, PartialEq, Eq, Clone, Copy, Hash)]
struct Digest(usize); struct Digest(usize);
#[derive(Debug, PartialEq, Eq, Clone, Hash)] #[derive(Debug, PartialEq, Eq, Clone, Hash)]
@@ -117,7 +118,6 @@ struct TestContext {
proposal: Mutex<usize>, proposal: Mutex<usize>,
node_count: usize, node_count: usize,
current_round: Arc<AtomicUsize>, current_round: Arc<AtomicUsize>,
timer: Timer,
evaluated: Mutex<BTreeSet<usize>>, evaluated: Mutex<BTreeSet<usize>>,
} }
@@ -194,7 +194,7 @@ impl Context for TestContext {
} }
let current_round = self.current_round.clone(); let current_round = self.current_round.clone();
let timeout = self.timer.sleep(round_duration) let timeout = Delay::new(Instant::now() + round_duration)
.map(move |_| { .map(move |_| {
current_round.compare_and_swap(round, round + 1, Ordering::SeqCst); current_round.compare_and_swap(round, round + 1, Ordering::SeqCst);
}) })
@@ -205,278 +205,37 @@ impl Context for TestContext {
} }
} }
fn timeout_in(t: Duration) -> oneshot::Receiver<()> { fn test_harness<F, X, T, U>(f: F) -> Result<T, U> where
let (tx, rx) = oneshot::channel(); F: FnOnce() -> X,
::std::thread::spawn(move || { X: IntoFuture<Item=T,Error=U>,
::std::thread::sleep(t); {
let _ = tx.send(()); let mut runtime = runtime::current_thread::Runtime::new().unwrap();
}); runtime.block_on(future::lazy(f))
rx
} }
#[test] #[test]
fn consensus_completes_with_minimum_good() { fn consensus_completes_with_minimum_good() {
let node_count = 10; let results = test_harness(|| {
let max_faulty = 3; let node_count = 10;
let max_faulty = 3;
let timer = tokio_timer::wheel().tick_duration(ROUND_DURATION).build(); let (network, net_send, net_recv) = Network::new(node_count);
network.route_in_background();
let (network, net_send, net_recv) = Network::new(node_count); let nodes = net_send
network.route_on_thread(); .into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
timer: timer.clone(),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
.collect::<Vec<_>>();
let timeout = timeout_in(Duration::from_millis(500)).map_err(|_| Error);
let results = ::futures::future::join_all(nodes)
.map(Some)
.select(timeout.map(|_| None))
.wait()
.map(|(i, _)| i)
.map_err(|(e, _)| e)
.expect("to complete")
.expect("to not time out");
for result in &results {
assert_eq!(&result.justification.digest, &results[0].justification.digest);
}
}
#[test]
fn consensus_completes_with_minimum_good_all_initial_proposals_bad() {
let node_count = 10;
let max_faulty = 3;
let timer = tokio_timer::wheel().tick_duration(ROUND_DURATION).build();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_on_thread();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(|(i, (tx, rx))| {
// the first 5 proposals are going to be bad.
let proposal = if i < 5 {
i * 3 // proposals considered bad in the tests if they are % 3
} else {
(i * 3) + 1
};
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(proposal),
current_round: Arc::new(AtomicUsize::new(0)),
timer: timer.clone(),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
.collect::<Vec<_>>();
let timeout = timeout_in(Duration::from_millis(500)).map_err(|_| Error);
let results = ::futures::future::join_all(nodes)
.map(Some)
.select(timeout.map(|_| None))
.wait()
.map(|(i, _)| i)
.map_err(|(e, _)| e)
.expect("to complete")
.expect("to not time out");
for result in &results {
assert_eq!(&result.justification.digest, &results[0].justification.digest);
}
}
#[test]
fn consensus_does_not_complete_without_enough_nodes() {
let node_count = 10;
let max_faulty = 3;
let timer = tokio_timer::wheel().tick_duration(ROUND_DURATION).build();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_on_thread();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty - 1)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
timer: timer.clone(),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
.collect::<Vec<_>>();
let timeout = timeout_in(Duration::from_millis(500)).map_err(|_| Error);
let result = ::futures::future::join_all(nodes)
.map(Some)
.select(timeout.map(|_| None))
.wait()
.map(|(i, _)| i)
.map_err(|(e, _)| e)
.expect("to complete");
assert!(result.is_none(), "not enough online nodes");
}
#[test]
fn threshold_plus_one_locked_on_proposal_only_one_with_candidate() {
let node_count = 10;
let max_faulty = 3;
let locked_proposal = Candidate(999_999_999);
let locked_digest = Digest(999_999_999);
let locked_round = 1;
let justification = UncheckedJustification {
round_number: locked_round,
digest: locked_digest.clone(),
signatures: (0..7)
.map(|i| Signature(Message::Vote(Vote::Prepare(locked_round, locked_digest.clone())), AuthorityId(i)))
.collect()
}.check(7, |_, _, s| Some(s.1.clone())).unwrap();
let timer = tokio_timer::wheel().tick_duration(ROUND_DURATION).build();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_on_thread();
let nodes = net_send
.into_iter()
.zip(net_recv)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(locked_round + 1)),
timer: timer.clone(),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
let mut agreement = agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
);
agreement.strategy.advance_to_round(
&agreement.context,
locked_round + 1
);
if i <= max_faulty {
agreement.strategy.locked = Some(Locked {
justification: justification.clone(),
})
}
if i == max_faulty {
agreement.strategy.notable_candidates.insert(
locked_digest.clone(),
locked_proposal.clone(),
);
}
agreement
})
.collect::<Vec<_>>();
let timeout = timeout_in(Duration::from_millis(1000)).map_err(|_| Error);
let results = ::futures::future::join_all(nodes)
.map(Some)
.select(timeout.map(|_| None))
.wait()
.map(|(i, _)| i)
.map_err(|(e, _)| e)
.expect("to complete")
.expect("to not time out");
for result in &results {
assert_eq!(&result.justification.digest, &locked_digest);
}
}
#[test]
fn consensus_completes_even_when_nodes_start_with_a_delay() {
let node_count = 10;
let max_faulty = 3;
let base_sleep = Duration::from_millis(75);
let timer = tokio_timer::wheel().tick_duration(ROUND_DURATION).build();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_on_thread();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
timer: timer.clone(),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
let sleep_duration = base_sleep * i as u32;
timer.sleep(sleep_duration).map_err(|_| Error).and_then(move |_| {
agree( agree(
ctx, ctx,
node_count, node_count,
@@ -485,18 +244,224 @@ fn consensus_completes_even_when_nodes_start_with_a_delay() {
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))), tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
) )
}) })
}) .collect::<Vec<_>>();
.collect::<Vec<_>>();
let timeout = timeout_in(Duration::from_millis(750)).map_err(|_| Error); ::futures::future::join_all(nodes)
let results = ::futures::future::join_all(nodes) .deadline(Instant::now() + Duration::from_millis(500))
.map(Some) }).unwrap();
.select(timeout.map(|_| None))
.wait() for result in &results {
.map(|(i, _)| i) assert_eq!(&result.justification.digest, &results[0].justification.digest);
.map_err(|(e, _)| e) }
.expect("to complete") }
.expect("to not time out");
#[test]
fn consensus_completes_with_minimum_good_all_initial_proposals_bad() {
let results = test_harness(|| {
let node_count = 10;
let max_faulty = 3;
let (network, net_send, net_recv) = Network::new(node_count);
network.route_in_background();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(|(i, (tx, rx))| {
// the first 5 proposals are going to be bad.
let proposal = if i < 5 {
i * 3 // proposals considered bad in the tests if they are % 3
} else {
(i * 3) + 1
};
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(proposal),
current_round: Arc::new(AtomicUsize::new(0)),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
.collect::<Vec<_>>();
::futures::future::join_all(nodes)
.deadline(Instant::now() + Duration::from_millis(500))
}).unwrap();
for result in &results {
assert_eq!(&result.justification.digest, &results[0].justification.digest);
}
}
#[test]
fn consensus_does_not_complete_without_enough_nodes() {
let result = test_harness(|| {
let node_count = 10;
let max_faulty = 3;
let (network, net_send, net_recv) = Network::new(node_count);
network.route_in_background();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty - 1)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
.collect::<Vec<_>>();
::futures::future::join_all(nodes)
.deadline(Instant::now() + Duration::from_millis(500))
});
match result {
Ok(_) => panic!("completed wrongly"),
Err(ref e) if e.is_inner() => panic!("failed for wrong reason"),
Err(_) => {},
}
}
#[test]
fn threshold_plus_one_locked_on_proposal_only_one_with_candidate() {
let locked_digest = Digest(999_999_999);
let results = test_harness(move || {
let node_count = 10;
let max_faulty = 3;
let locked_proposal = Candidate(999_999_999);
let locked_round = 1;
let justification = UncheckedJustification {
round_number: locked_round,
digest: locked_digest.clone(),
signatures: (0..7)
.map(|i| Signature(Message::Vote(Vote::Prepare(locked_round, locked_digest.clone())), AuthorityId(i)))
.collect()
}.check(7, |_, _, s| Some(s.1.clone())).unwrap();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_in_background();
let nodes = net_send
.into_iter()
.zip(net_recv)
.enumerate()
.map(|(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(locked_round + 1)),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
let mut agreement = agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
);
agreement.strategy.advance_to_round(
&agreement.context,
locked_round + 1
);
if i <= max_faulty {
agreement.strategy.locked = Some(Locked {
justification: justification.clone(),
})
}
if i == max_faulty {
agreement.strategy.notable_candidates.insert(
locked_digest.clone(),
locked_proposal.clone(),
);
}
agreement
})
.collect::<Vec<_>>();
::futures::future::join_all(nodes)
.deadline(Instant::now() + Duration::from_millis(1000))
}).unwrap();
for result in &results {
assert_eq!(&result.justification.digest, &locked_digest);
}
}
#[test]
fn consensus_completes_even_when_nodes_start_with_a_delay() {
let results = test_harness(|| {
let node_count = 10;
let max_faulty = 3;
let base_sleep = Duration::from_millis(75);
let now = Instant::now();
let (network, net_send, net_recv) = Network::new(node_count);
network.route_in_background();
let nodes = net_send
.into_iter()
.zip(net_recv)
.take(node_count - max_faulty)
.enumerate()
.map(move |(i, (tx, rx))| {
let ctx = TestContext {
local_id: AuthorityId(i),
proposal: Mutex::new(i),
current_round: Arc::new(AtomicUsize::new(0)),
evaluated: Mutex::new(BTreeSet::new()),
node_count,
};
let sleep_duration = base_sleep * i as u32;
Delay::new(now + sleep_duration).map_err(|_| Error).and_then(move |_| {
agree(
ctx,
node_count,
max_faulty,
rx.map_err(|_| Error),
tx.sink_map_err(|_| Error).with(move |t| Ok((i, t))),
)
})
})
.collect::<Vec<_>>();
::futures::future::join_all(nodes)
.deadline(now + Duration::from_millis(750))
}).unwrap();
for result in &results { for result in &results {
assert_eq!(&result.justification.digest, &results[0].justification.digest); assert_eq!(&result.justification.digest, &results[0].justification.digest);
+64 -40
View File
@@ -15,6 +15,20 @@
// along with Substrate. If not, see <http://www.gnu.org/licenses/>. // along with Substrate. If not, see <http://www.gnu.org/licenses/>.
//! BFT Agreement based on a rotating proposer in different rounds. //! BFT Agreement based on a rotating proposer in different rounds.
//!
//! Where this crate refers to input stream, should never logically conclude.
//! The logic in this crate assumes that messages flushed to the output stream
//! will eventually reach other nodes and that our own messages are not included
//! in the input stream.
//!
//! Note that it is possible to witness agreement being reached without ever
//! seeing the candidate. Any candidates seen will be checked for validity.
//!
//! Although technically the agreement will always complete (given the eventual
//! delivery of messages), in practice it is possible for this future to
//! conclude without having witnessed the conclusion.
//! In general, this future should be pre-empted by the import of a justification
//! set for this block height.
pub mod error; pub mod error;
pub mod generic; pub mod generic;
@@ -24,7 +38,7 @@ extern crate substrate_primitives as primitives;
extern crate substrate_runtime_support as runtime_support; extern crate substrate_runtime_support as runtime_support;
extern crate substrate_runtime_primitives as runtime_primitives; extern crate substrate_runtime_primitives as runtime_primitives;
extern crate ed25519; extern crate ed25519;
extern crate tokio_timer; extern crate tokio;
extern crate parking_lot; extern crate parking_lot;
#[macro_use] #[macro_use]
@@ -49,7 +63,7 @@ use primitives::AuthorityId;
use futures::{task, Async, Stream, Sink, Future, IntoFuture}; use futures::{task, Async, Stream, Sink, Future, IntoFuture};
use futures::sync::oneshot; use futures::sync::oneshot;
use tokio_timer::Timer; use tokio::timer::Delay;
use parking_lot::Mutex; use parking_lot::Mutex;
pub use generic::InputStreamConcluded; pub use generic::InputStreamConcluded;
@@ -108,16 +122,22 @@ pub type Communication<B> = generic::Communication<B, <B as Block>::Hash, Author
/// Misbehavior observed from BFT participants. /// Misbehavior observed from BFT participants.
pub type Misbehavior<H> = generic::Misbehavior<H, LocalizedSignature>; pub type Misbehavior<H> = generic::Misbehavior<H, LocalizedSignature>;
/// Proposer factory. Can be used to create a proposer instance. /// Environment producer for a BFT instance. Creates proposer instance and communication streams.
pub trait ProposerFactory<B: Block> { pub trait Environment<B: Block> {
/// The proposer type this creates. /// The proposer type this creates.
type Proposer: Proposer<B>; type Proposer: Proposer<B>;
/// The input stream type.
type Input: Stream<Item=Communication<B>, Error=<Self::Proposer as Proposer<B>>::Error>;
/// The output stream type.
type Output: Sink<SinkItem=Communication<B>, SinkError=<Self::Proposer as Proposer<B>>::Error>;
/// Error which can occur upon creation. /// Error which can occur upon creation.
type Error: From<Error>; type Error: From<Error>;
/// Initialize the proposal logic on top of a specific header. /// Initialize the proposal logic on top of a specific header.
/// Produces the proposer and message streams for this instance of BFT agreement.
// TODO: provide state context explicitly? // TODO: provide state context explicitly?
fn init(&self, parent_header: &B::Header, authorities: &[AuthorityId], sign_with: Arc<ed25519::Pair>) -> Result<Self::Proposer, Self::Error>; fn init(&self, parent_header: &B::Header, authorities: &[AuthorityId], sign_with: Arc<ed25519::Pair>)
-> Result<(Self::Proposer, Self::Input, Self::Output), Self::Error>;
} }
/// Logic for a proposer. /// Logic for a proposer.
@@ -163,7 +183,6 @@ struct BftInstance<B: Block, P> {
key: Arc<ed25519::Pair>, key: Arc<ed25519::Pair>,
authorities: Vec<AuthorityId>, authorities: Vec<AuthorityId>,
parent_hash: B::Hash, parent_hash: B::Hash,
timer: Timer,
round_timeout_multiplier: u64, round_timeout_multiplier: u64,
proposer: P, proposer: P,
} }
@@ -178,7 +197,7 @@ impl<B: Block, P: Proposer<B>> generic::Context for BftInstance<B, P>
type Digest = B::Hash; type Digest = B::Hash;
type Signature = LocalizedSignature; type Signature = LocalizedSignature;
type Candidate = B; type Candidate = B;
type RoundTimeout = Box<Future<Item=(),Error=Self::Error> + Send>; type RoundTimeout = Box<Future<Item=(),Error=Self::Error>>;
type CreateProposal = <P::Create as IntoFuture>::Future; type CreateProposal = <P::Create as IntoFuture>::Future;
type EvaluateProposal = <P::Evaluate as IntoFuture>::Future; type EvaluateProposal = <P::Evaluate as IntoFuture>::Future;
@@ -207,16 +226,18 @@ impl<B: Block, P: Proposer<B>> generic::Context for BftInstance<B, P>
} }
fn begin_round_timeout(&self, round: usize) -> Self::RoundTimeout { fn begin_round_timeout(&self, round: usize) -> Self::RoundTimeout {
use std::time::Duration; use std::time::{Instant, Duration};
let round = ::std::cmp::min(63, round) as u32; let round = ::std::cmp::min(63, round) as u32;
let timeout = 1u64.checked_shl(round) let timeout = 1u64.checked_shl(round)
.unwrap_or_else(u64::max_value) .unwrap_or_else(u64::max_value)
.saturating_mul(self.round_timeout_multiplier); .saturating_mul(self.round_timeout_multiplier);
Box::new(self.timer.sleep(Duration::from_secs(timeout)) let fut = Delay::new(Instant::now() + Duration::from_secs(timeout))
.map_err(|_| Error::from(ErrorKind::FaultyTimer)) .map_err(|e| Error::from(ErrorKind::FaultyTimer(e)))
.map_err(Into::into)) .map_err(Into::into);
Box::new(fut)
} }
} }
@@ -258,10 +279,8 @@ impl<B, P, I, InStream, OutSink> Future for BftFuture<B, P, I, InStream, OutSink
return Ok(Async::Ready(())) return Ok(Async::Ready(()))
} }
// TODO: handle this error, at least by logging. // TODO: handle and log this error in a way which isn't noisy on exit.
let committed = try_ready!(self.inner.poll().map_err(|e| { let committed = try_ready!(self.inner.poll().map_err(|_| ()));
warn!(target: "bft", "Error in BFT agreement: {}", e);
}));
// If we didn't see the proposal (very unlikely), // If we didn't see the proposal (very unlikely),
// we will get the block from the network later. // we will get the block from the network later.
@@ -312,10 +331,11 @@ impl Drop for AgreementHandle {
/// The BftService kicks off the agreement process on top of any blocks it /// The BftService kicks off the agreement process on top of any blocks it
/// is notified of. /// is notified of.
///
/// This assumes that it is being run in the context of a tokio runtime.
pub struct BftService<B: Block, P, I> { pub struct BftService<B: Block, P, I> {
client: Arc<I>, client: Arc<I>,
live_agreement: Mutex<Option<(B::Hash, AgreementHandle)>>, live_agreement: Mutex<Option<(B::Hash, AgreementHandle)>>,
timer: Timer,
round_timeout_multiplier: u64, round_timeout_multiplier: u64,
key: Arc<ed25519::Pair>, // TODO: key changing over time. key: Arc<ed25519::Pair>, // TODO: key changing over time.
factory: P, factory: P,
@@ -324,8 +344,7 @@ pub struct BftService<B: Block, P, I> {
impl<B, P, I> BftService<B, P, I> impl<B, P, I> BftService<B, P, I>
where where
B: Block + Clone + Eq, B: Block + Clone + Eq,
B::Hash: ::std::hash::Hash, P: Environment<B>,
P: ProposerFactory<B>,
<P::Proposer as Proposer<B>>::Error: ::std::fmt::Display, <P::Proposer as Proposer<B>>::Error: ::std::fmt::Display,
I: BlockImport<B> + Authorities<B>, I: BlockImport<B> + Authorities<B>,
{ {
@@ -335,7 +354,6 @@ impl<B, P, I> BftService<B, P, I>
BftService { BftService {
client: client, client: client,
live_agreement: Mutex::new(None), live_agreement: Mutex::new(None),
timer: Timer::default(),
round_timeout_multiplier: 4, round_timeout_multiplier: 4,
key: key, // TODO: key changing over time. key: key, // TODO: key changing over time.
factory: factory, factory: factory,
@@ -353,10 +371,16 @@ impl<B, P, I> BftService<B, P, I>
/// If the local signing key is an authority, this will begin the consensus process to build a /// If the local signing key is an authority, this will begin the consensus process to build a
/// block on top of it. If the executor fails to run the future, an error will be returned. /// block on top of it. If the executor fails to run the future, an error will be returned.
/// Returns `None` if the agreement on the block with given parent is already in progress. /// Returns `None` if the agreement on the block with given parent is already in progress.
pub fn build_upon<InStream, OutSink>(&self, header: &B::Header, input: InStream, output: OutSink) pub fn build_upon(&self, header: &B::Header)
-> Result<Option<BftFuture<B, <P as ProposerFactory<B>>::Proposer, I, InStream, OutSink>>, P::Error> where -> Result<Option<
InStream: Stream<Item=Communication<B>, Error=<<P as ProposerFactory<B>>::Proposer as Proposer<B>>::Error>, BftFuture<
OutSink: Sink<SinkItem=Communication<B>, SinkError=<<P as ProposerFactory<B>>::Proposer as Proposer<B>>::Error>, B,
<P as Environment<B>>::Proposer,
I,
<P as Environment<B>>::Input,
<P as Environment<B>>::Output,
>>, P::Error>
where
{ {
let hash = header.hash(); let hash = header.hash();
if self.live_agreement.lock().as_ref().map_or(false, |&(ref h, _)| h == &hash) { if self.live_agreement.lock().as_ref().map_or(false, |&(ref h, _)| h == &hash) {
@@ -377,13 +401,12 @@ impl<B, P, I> BftService<B, P, I>
Err(From::from(ErrorKind::InvalidAuthority(local_id)))?; Err(From::from(ErrorKind::InvalidAuthority(local_id)))?;
} }
let proposer = self.factory.init(header, &authorities, self.key.clone())?; let (proposer, input, output) = self.factory.init(header, &authorities, self.key.clone())?;
let bft_instance = BftInstance { let bft_instance = BftInstance {
proposer, proposer,
parent_hash: hash.clone(), parent_hash: hash.clone(),
round_timeout_multiplier: self.round_timeout_multiplier, round_timeout_multiplier: self.round_timeout_multiplier,
timer: self.timer.clone(),
key: self.key.clone(), key: self.key.clone(),
authorities: authorities, authorities: authorities,
}; };
@@ -592,13 +615,11 @@ mod tests {
use std::collections::HashSet; use std::collections::HashSet;
use runtime_primitives::testing::{Block as GenericTestBlock, Header as TestHeader}; use runtime_primitives::testing::{Block as GenericTestBlock, Header as TestHeader};
use primitives::H256; use primitives::H256;
use self::tokio_core::reactor::{Core};
use self::keyring::Keyring; use self::keyring::Keyring;
use futures::stream; use futures::stream;
use futures::future::Executor; use tokio::executor::current_thread;
extern crate substrate_keyring as keyring; extern crate substrate_keyring as keyring;
extern crate tokio_core;
type TestBlock = GenericTestBlock<()>; type TestBlock = GenericTestBlock<()>;
@@ -638,12 +659,16 @@ mod tests {
struct DummyFactory; struct DummyFactory;
struct DummyProposer(u64); struct DummyProposer(u64);
impl ProposerFactory<TestBlock> for DummyFactory { impl Environment<TestBlock> for DummyFactory {
type Proposer = DummyProposer; type Proposer = DummyProposer;
type Input = stream::Empty<Communication<TestBlock>, Error>;
type Output = Output<Error>;
type Error = Error; type Error = Error;
fn init(&self, parent_header: &TestHeader, _authorities: &[AuthorityId], _sign_with: Arc<ed25519::Pair>) -> Result<DummyProposer, Error> { fn init(&self, parent_header: &TestHeader, _authorities: &[AuthorityId], _sign_with: Arc<ed25519::Pair>)
Ok(DummyProposer(parent_header.number + 1)) -> Result<(DummyProposer, Self::Input, Self::Output), Error>
{
Ok((DummyProposer(parent_header.number + 1), stream::empty(), Output(::std::marker::PhantomData)))
} }
} }
@@ -677,7 +702,6 @@ mod tests {
BftService { BftService {
client: Arc::new(client), client: Arc::new(client),
live_agreement: Mutex::new(None), live_agreement: Mutex::new(None),
timer: Timer::default(),
round_timeout_multiplier: 4, round_timeout_multiplier: 4,
key: Arc::new(Keyring::One.into()), key: Arc::new(Keyring::One.into()),
factory: DummyFactory factory: DummyFactory
@@ -713,8 +737,6 @@ mod tests {
imported_heights: Mutex::new(HashSet::new()), imported_heights: Mutex::new(HashSet::new()),
}; };
let mut core = Core::new().unwrap();
let service = make_service(client); let service = make_service(client);
let first = from_block_number(2); let first = from_block_number(2);
@@ -724,19 +746,21 @@ mod tests {
second.parent_hash = first_hash; second.parent_hash = first_hash;
let second_hash = second.hash(); let second_hash = second.hash();
let bft = service.build_upon(&first, stream::empty(), Output(Default::default())).unwrap(); let bft = service.build_upon(&first).unwrap();
assert!(service.live_agreement.lock().as_ref().unwrap().0 == first_hash); assert!(service.live_agreement.lock().as_ref().unwrap().0 == first_hash);
let mut core = current_thread::CurrentThread::new();
// turn the core so the future gets polled and sends its task to the // turn the core so the future gets polled and sends its task to the
// service. otherwise it deadlocks. // service. otherwise it deadlocks.
core.handle().execute(bft.unwrap()).unwrap(); core.spawn(bft.unwrap());
core.turn(Some(::std::time::Duration::from_millis(100))); core.run_timeout(::std::time::Duration::from_millis(100)).unwrap();
let bft = service.build_upon(&second, stream::empty(), Output(Default::default())).unwrap(); let bft = service.build_upon(&second).unwrap();
assert!(service.live_agreement.lock().as_ref().unwrap().0 != first_hash); assert!(service.live_agreement.lock().as_ref().unwrap().0 != first_hash);
assert!(service.live_agreement.lock().as_ref().unwrap().0 == second_hash); assert!(service.live_agreement.lock().as_ref().unwrap().0 == second_hash);
core.handle().execute(bft.unwrap()).unwrap(); core.spawn(bft.unwrap());
core.turn(Some(::std::time::Duration::from_millis(100))); core.run_timeout(::std::time::Duration::from_millis(100)).unwrap();
} }
#[test] #[test]
+14 -13
View File
@@ -1,28 +1,29 @@
// Copyright 2017 Parity Technologies (UK) Ltd. // Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot. // This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify // Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by // it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or // the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version. // (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful, // Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of // but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details. // GNU General Public License for more details.
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>. // along with Substrate. If not, see <http://www.gnu.org/licenses/>.
//! Blockchain access trait //! Blockchain access trait
use client::{self, Client as PolkadotClient, ImportResult, ClientInfo, BlockStatus, BlockOrigin, CallExecutor}; use client::{self, Client as SubstrateClient, ImportResult, ClientInfo, BlockStatus, BlockOrigin, CallExecutor};
use client::error::Error; use client::error::Error;
use state_machine; use state_machine;
use runtime_primitives::traits::{Block as BlockT, Header as HeaderT}; use runtime_primitives::traits::{Block as BlockT, Header as HeaderT};
use runtime_primitives::generic::BlockId; use runtime_primitives::generic::BlockId;
use runtime_primitives::bft::Justification; use runtime_primitives::bft::Justification;
/// Local client abstraction for the network.
pub trait Client<Block: BlockT>: Send + Sync { pub trait Client<Block: BlockT>: Send + Sync {
/// Import a new block. Parent is supposed to be existing in the blockchain. /// Import a new block. Parent is supposed to be existing in the blockchain.
fn import(&self, is_best: bool, header: Block::Header, justification: Justification<Block::Hash>, body: Option<Vec<Block::Extrinsic>>) -> Result<ImportResult, Error>; fn import(&self, is_best: bool, header: Block::Header, justification: Justification<Block::Hash>, body: Option<Vec<Block::Extrinsic>>) -> Result<ImportResult, Error>;
@@ -49,7 +50,7 @@ pub trait Client<Block: BlockT>: Send + Sync {
fn execution_proof(&self, block: &Block::Hash, method: &str, data: &[u8]) -> Result<(Vec<u8>, Vec<Vec<u8>>), Error>; fn execution_proof(&self, block: &Block::Hash, method: &str, data: &[u8]) -> Result<(Vec<u8>, Vec<Vec<u8>>), Error>;
} }
impl<B, E, Block> Client<Block> for PolkadotClient<B, E, Block> where impl<B, E, Block> Client<Block> for SubstrateClient<B, E, Block> where
B: client::backend::Backend<Block> + Send + Sync + 'static, B: client::backend::Backend<Block> + Send + Sync + 'static,
E: CallExecutor<Block> + Send + Sync + 'static, E: CallExecutor<Block> + Send + Sync + 'static,
Block: BlockT, Block: BlockT,
@@ -59,34 +60,34 @@ impl<B, E, Block> Client<Block> for PolkadotClient<B, E, Block> where
// TODO: defer justification check. // TODO: defer justification check.
let justified_header = self.check_justification(header, justification.into())?; let justified_header = self.check_justification(header, justification.into())?;
let origin = if is_best { BlockOrigin::NetworkBroadcast } else { BlockOrigin::NetworkInitialSync }; let origin = if is_best { BlockOrigin::NetworkBroadcast } else { BlockOrigin::NetworkInitialSync };
(self as &PolkadotClient<B, E, Block>).import_block(origin, justified_header, body) (self as &SubstrateClient<B, E, Block>).import_block(origin, justified_header, body)
} }
fn info(&self) -> Result<ClientInfo<Block>, Error> { fn info(&self) -> Result<ClientInfo<Block>, Error> {
(self as &PolkadotClient<B, E, Block>).info() (self as &SubstrateClient<B, E, Block>).info()
} }
fn block_status(&self, id: &BlockId<Block>) -> Result<BlockStatus, Error> { fn block_status(&self, id: &BlockId<Block>) -> Result<BlockStatus, Error> {
(self as &PolkadotClient<B, E, Block>).block_status(id) (self as &SubstrateClient<B, E, Block>).block_status(id)
} }
fn block_hash(&self, block_number: <Block::Header as HeaderT>::Number) -> Result<Option<Block::Hash>, Error> { fn block_hash(&self, block_number: <Block::Header as HeaderT>::Number) -> Result<Option<Block::Hash>, Error> {
(self as &PolkadotClient<B, E, Block>).block_hash(block_number) (self as &SubstrateClient<B, E, Block>).block_hash(block_number)
} }
fn header(&self, id: &BlockId<Block>) -> Result<Option<Block::Header>, Error> { fn header(&self, id: &BlockId<Block>) -> Result<Option<Block::Header>, Error> {
(self as &PolkadotClient<B, E, Block>).header(id) (self as &SubstrateClient<B, E, Block>).header(id)
} }
fn body(&self, id: &BlockId<Block>) -> Result<Option<Vec<Block::Extrinsic>>, Error> { fn body(&self, id: &BlockId<Block>) -> Result<Option<Vec<Block::Extrinsic>>, Error> {
(self as &PolkadotClient<B, E, Block>).body(id) (self as &SubstrateClient<B, E, Block>).body(id)
} }
fn justification(&self, id: &BlockId<Block>) -> Result<Option<Justification<Block::Hash>>, Error> { fn justification(&self, id: &BlockId<Block>) -> Result<Option<Justification<Block::Hash>>, Error> {
(self as &PolkadotClient<B, E, Block>).justification(id) (self as &SubstrateClient<B, E, Block>).justification(id)
} }
fn execution_proof(&self, block: &Block::Hash, method: &str, data: &[u8]) -> Result<(Vec<u8>, Vec<Vec<u8>>), Error> { fn execution_proof(&self, block: &Block::Hash, method: &str, data: &[u8]) -> Result<(Vec<u8>, Vec<Vec<u8>>), Error> {
(self as &PolkadotClient<B, E, Block>).execution_proof(&BlockId::Hash(block.clone()), method, data) (self as &SubstrateClient<B, E, Block>).execution_proof(&BlockId::Hash(block.clone()), method, data)
} }
} }
@@ -1,263 +0,0 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.?
//! Consensus related bits of the network service.
use std::collections::{HashMap, HashSet};
use futures::sync::mpsc;
use std::time::{Instant, Duration};
use io::SyncIo;
use protocol::Protocol;
use network::PeerId;
use runtime_primitives::traits::{Block as BlockT, Header as HeaderT};
use runtime_primitives::generic::BlockId;
use message::{self, generic::Message as GenericMessage};
// TODO: Add additional spam/DoS attack protection.
const MESSAGE_LIFETIME: Duration = Duration::from_secs(600);
struct PeerConsensus<H> {
known_messages: HashSet<H>,
}
/// Consensus network protocol handler. Manages statements and candidate requests.
pub struct Consensus<B: BlockT> {
peers: HashMap<PeerId, PeerConsensus<B::Hash>>,
bft_message_sink: Option<(mpsc::UnboundedSender<message::LocalizedBftMessage<B>>, B::Hash)>,
messages: Vec<(B::Hash, Instant, message::Message<B>)>,
message_hashes: HashSet<B::Hash>,
}
impl<B: BlockT> Consensus<B> where B::Header: HeaderT<Number=u64> {
/// Create a new instance.
pub fn new() -> Self {
Consensus {
peers: HashMap::new(),
bft_message_sink: None,
messages: Default::default(),
message_hashes: Default::default(),
}
}
/// Closes all notification streams.
pub fn restart(&mut self) {
self.bft_message_sink = None;
}
/// Handle new connected peer.
pub fn new_peer(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, roles: &[message::Role]) {
if roles.iter().any(|r| *r == message::Role::Validator) {
trace!(target:"sync", "Registering validator {}", peer_id);
// Send out all known messages.
// TODO: limit by size
let mut known_messages = HashSet::new();
for &(ref hash, _, ref message) in self.messages.iter() {
known_messages.insert(hash.clone());
protocol.send_message(io, peer_id, message.clone());
}
self.peers.insert(peer_id, PeerConsensus {
known_messages,
});
}
}
fn propagate(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, message: message::Message<B>, hash: B::Hash) {
for (id, ref mut peer) in self.peers.iter_mut() {
if peer.known_messages.insert(hash.clone()) {
protocol.send_message(io, *id, message.clone());
}
}
}
fn register_message(&mut self, hash: B::Hash, message: message::Message<B>) {
if self.message_hashes.insert(hash) {
self.messages.push((hash, Instant::now(), message));
}
}
pub fn on_bft_message(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, message: message::LocalizedBftMessage<B>, hash: B::Hash) {
if self.message_hashes.contains(&hash) {
trace!(target:"sync", "Ignored already known BFT message from {}", peer_id);
return;
}
match (protocol.chain().info(), protocol.chain().header(&BlockId::Hash(message.parent_hash))) {
(_, Err(e)) | (Err(e), _) => {
debug!(target:"sync", "Error reading blockchain: {:?}", e);
return;
},
(Ok(info), Ok(Some(header))) => {
if header.number() < &info.chain.best_number {
trace!(target:"sync", "Ignored ancient BFT message from {}, hash={}", peer_id, message.parent_hash);
return;
}
},
(Ok(_), Ok(None)) => {},
}
if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
peer.known_messages.insert(hash);
// TODO: validate signature?
if let Some((sink, parent_hash)) = self.bft_message_sink.take() {
if message.parent_hash == parent_hash {
if let Err(e) = sink.unbounded_send(message.clone()) {
trace!(target:"sync", "Error broadcasting BFT message notification: {:?}", e);
} else {
self.bft_message_sink = Some((sink, parent_hash));
}
}
}
} else {
trace!(target:"sync", "Ignored BFT statement from unregistered peer {}", peer_id);
return;
}
let message = GenericMessage::BftMessage(message);
self.register_message(hash.clone(), message.clone());
// Propagate to other peers.
self.propagate(io, protocol, message, hash);
}
pub fn bft_messages(&mut self, parent_hash: B::Hash) -> mpsc::UnboundedReceiver<message::LocalizedBftMessage<B>> {
let (sink, stream) = mpsc::unbounded();
for &(_, _, ref message) in self.messages.iter() {
let bft_message = match *message {
GenericMessage::BftMessage(ref msg) => msg,
_ => continue,
};
if bft_message.parent_hash == parent_hash {
sink.unbounded_send(bft_message.clone()).expect("receiving end known to be open; qed");
}
}
self.bft_message_sink = Some((sink, parent_hash));
stream
}
pub fn send_bft_message(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, message: message::LocalizedBftMessage<B>) {
// Broadcast message to all validators.
trace!(target:"sync", "Broadcasting BFT message {:?}", message);
let message = GenericMessage::BftMessage(message);
let hash = Protocol::hash_message(&message);
self.register_message(hash.clone(), message.clone());
self.propagate(io, protocol, message, hash);
}
pub fn peer_disconnected(&mut self, _io: &mut SyncIo, _protocol: &Protocol<B>, peer_id: PeerId) {
self.peers.remove(&peer_id);
}
pub fn collect_garbage(&mut self, best_header: Option<&B::Header>) {
let hashes = &mut self.message_hashes;
let before = self.messages.len();
let now = Instant::now();
self.messages.retain(|&(ref hash, timestamp, ref message)| {
if timestamp >= now - MESSAGE_LIFETIME &&
best_header.map_or(true, |header|
match *message {
GenericMessage::BftMessage(ref msg) => &msg.parent_hash != header.parent_hash(),
_ => true,
})
{
true
} else {
hashes.remove(hash);
false
}
});
if self.messages.len() != before {
trace!(target:"sync", "Cleaned up {} stale messages", before - self.messages.len());
}
for (_, ref mut peer) in self.peers.iter_mut() {
peer.known_messages.retain(|h| hashes.contains(h));
}
}
}
#[cfg(test)]
mod tests {
use runtime_primitives::bft::Justification;
use runtime_primitives::testing::{H256, Header, Block as RawBlock};
use std::time::Instant;
use message::{self, generic::Message as GenericMessage};
use super::{Consensus, MESSAGE_LIFETIME};
type Block = RawBlock<u64>;
#[test]
fn collects_garbage() {
let prev_hash = H256::random();
let best_hash = H256::random();
let mut consensus = Consensus::<Block>::new();
let now = Instant::now();
let m1_hash = H256::random();
let m2_hash = H256::random();
let m1 = GenericMessage::BftMessage(message::LocalizedBftMessage {
parent_hash: prev_hash,
message: message::generic::BftMessage::Auxiliary(Justification {
round_number: 0,
hash: Default::default(),
signatures: Default::default(),
}),
});
let m2 = GenericMessage::BftMessage(message::LocalizedBftMessage {
parent_hash: best_hash,
message: message::generic::BftMessage::Auxiliary(Justification {
round_number: 0,
hash: Default::default(),
signatures: Default::default(),
}),
});
consensus.messages.push((m1_hash, now, m1));
consensus.messages.push((m2_hash, now, m2.clone()));
consensus.message_hashes.insert(m1_hash);
consensus.message_hashes.insert(m2_hash);
// nothing to collect
consensus.collect_garbage(None);
assert_eq!(consensus.messages.len(), 2);
assert_eq!(consensus.message_hashes.len(), 2);
// random header, nothing should be cleared
let mut header = Header {
parent_hash: H256::default(),
number: 0,
state_root: H256::default(),
extrinsics_root: H256::default(),
digest: Default::default(),
};
consensus.collect_garbage(Some(&header));
assert_eq!(consensus.messages.len(), 2);
assert_eq!(consensus.message_hashes.len(), 2);
// header that matches one of the messages
header.parent_hash = prev_hash;
consensus.collect_garbage(Some(&header));
assert_eq!(consensus.messages.len(), 1);
assert_eq!(consensus.message_hashes.len(), 1);
assert!(consensus.message_hashes.contains(&m2_hash));
// make timestamp expired
consensus.messages.clear();
consensus.messages.push((m2_hash, now - MESSAGE_LIFETIME, m2));
consensus.collect_garbage(None);
assert!(consensus.messages.is_empty());
assert!(consensus.message_hashes.is_empty());
}
}
@@ -0,0 +1,377 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.?
//! Utility for gossip of network messages between authorities.
//! Handles chain-specific and standard BFT messages.
use std::collections::{HashMap, HashSet};
use futures::sync::mpsc;
use std::time::{Instant, Duration};
use network::PeerId;
use runtime_primitives::traits::{Block as BlockT, Header as HeaderT};
use runtime_primitives::generic::BlockId;
use message::{self, generic::Message as GenericMessage};
use protocol::Context;
// TODO: Add additional spam/DoS attack protection.
const MESSAGE_LIFETIME: Duration = Duration::from_secs(600);
struct PeerConsensus<H> {
known_messages: HashSet<H>,
}
/// Consensus messages.
#[derive(Debug, Clone, PartialEq)]
pub enum ConsensusMessage<B: BlockT> {
/// A message concerning BFT agreement
Bft(message::LocalizedBftMessage<B>),
/// A message concerning some chain-specific aspect of consensus
ChainSpecific(Vec<u8>, B::Hash),
}
struct MessageEntry<B: BlockT> {
hash: B::Hash,
message: ConsensusMessage<B>,
instant: Instant,
}
/// Consensus network protocol handler. Manages statements and candidate requests.
pub struct ConsensusGossip<B: BlockT> {
peers: HashMap<PeerId, PeerConsensus<B::Hash>>,
message_sink: Option<(mpsc::UnboundedSender<ConsensusMessage<B>>, B::Hash)>,
messages: Vec<MessageEntry<B>>,
message_hashes: HashSet<B::Hash>,
}
impl<B: BlockT> ConsensusGossip<B> where B::Header: HeaderT<Number=u64> {
/// Create a new instance.
pub fn new() -> Self {
ConsensusGossip {
peers: HashMap::new(),
message_sink: None,
messages: Default::default(),
message_hashes: Default::default(),
}
}
/// Closes all notification streams.
pub fn abort(&mut self) {
self.message_sink = None;
}
/// Handle new connected peer.
pub fn new_peer(&mut self, protocol: &mut Context<B>, peer_id: PeerId, roles: &[message::Role]) {
if roles.iter().any(|r| *r == message::Role::Authority) {
trace!(target:"gossip", "Registering authority {}", peer_id);
// Send out all known messages.
// TODO: limit by size
let mut known_messages = HashSet::new();
for entry in self.messages.iter() {
known_messages.insert(entry.hash);
let message = match entry.message {
ConsensusMessage::Bft(ref bft) => GenericMessage::BftMessage(bft.clone()),
ConsensusMessage::ChainSpecific(ref msg, _) => GenericMessage::ChainSpecific(msg.clone()),
};
protocol.send_message(peer_id, message);
}
self.peers.insert(peer_id, PeerConsensus {
known_messages,
});
}
}
fn propagate(&mut self, protocol: &mut Context<B>, message: message::Message<B>, hash: B::Hash) {
for (id, ref mut peer) in self.peers.iter_mut() {
if peer.known_messages.insert(hash.clone()) {
protocol.send_message(*id, message.clone());
}
}
}
fn register_message(&mut self, hash: B::Hash, message: ConsensusMessage<B>) {
if self.message_hashes.insert(hash) {
self.messages.push(MessageEntry {
hash,
instant: Instant::now(),
message,
});
}
}
/// Handles incoming BFT message, passing to stream and repropagating.
pub fn on_bft_message(&mut self, protocol: &mut Context<B>, peer_id: PeerId, message: message::LocalizedBftMessage<B>) {
if let Some((hash, message)) = self.handle_incoming(protocol, peer_id, ConsensusMessage::Bft(message)) {
// propagate to other peers.
self.multicast(protocol, message, Some(hash));
}
}
/// Handles incoming chain-specific message and repropagates
pub fn on_chain_specific(&mut self, protocol: &mut Context<B>, peer_id: PeerId, message: Vec<u8>, parent_hash: B::Hash) {
if let Some((hash, message)) = self.handle_incoming(protocol, peer_id, ConsensusMessage::ChainSpecific(message, parent_hash)) {
// propagate to other peers.
self.multicast(protocol, message, Some(hash));
}
}
/// Get a stream of messages relevant to consensus on top of a given parent hash.
pub fn messages_for(&mut self, parent_hash: B::Hash) -> mpsc::UnboundedReceiver<ConsensusMessage<B>> {
let (sink, stream) = mpsc::unbounded();
for entry in self.messages.iter() {
let message_matches = match entry.message {
ConsensusMessage::Bft(ref msg) => msg.parent_hash == parent_hash,
ConsensusMessage::ChainSpecific(_, ref h) => h == &parent_hash,
};
if message_matches {
sink.unbounded_send(entry.message.clone()).expect("receiving end known to be open; qed");
}
}
self.message_sink = Some((sink, parent_hash));
stream
}
/// Multicast a chain-specific message to other authorities.
pub fn multicast_chain_specific(&mut self, protocol: &mut Context<B>, message: Vec<u8>, parent_hash: B::Hash) {
trace!(target:"gossip", "sending chain-specific message");
self.multicast(protocol, ConsensusMessage::ChainSpecific(message, parent_hash), None);
}
/// Multicast a BFT message to other authorities
pub fn multicast_bft_message(&mut self, protocol: &mut Context<B>, message: message::LocalizedBftMessage<B>) {
// Broadcast message to all authorities.
trace!(target:"gossip", "Broadcasting BFT message {:?}", message);
self.multicast(protocol, ConsensusMessage::Bft(message), None);
}
/// Call when a peer has been disconnected to stop tracking gossip status.
pub fn peer_disconnected(&mut self, _protocol: &mut Context<B>, peer_id: PeerId) {
self.peers.remove(&peer_id);
}
/// Prune old or no longer relevant consensus messages.
/// Supply an optional block hash where consensus is known to have concluded.
pub fn collect_garbage(&mut self, best_hash: Option<&B::Hash>) {
let hashes = &mut self.message_hashes;
let before = self.messages.len();
let now = Instant::now();
self.messages.retain(|entry| {
if entry.instant + MESSAGE_LIFETIME >= now &&
best_hash.map_or(true, |parent_hash|
match entry.message {
ConsensusMessage::Bft(ref msg) => &msg.parent_hash != parent_hash,
ConsensusMessage::ChainSpecific(_, ref h) => h != parent_hash,
})
{
true
} else {
hashes.remove(&entry.hash);
false
}
});
if self.messages.len() != before {
trace!(target:"gossip", "Cleaned up {} stale messages", before - self.messages.len());
}
for (_, ref mut peer) in self.peers.iter_mut() {
peer.known_messages.retain(|h| hashes.contains(h));
}
}
fn handle_incoming(&mut self, protocol: &mut Context<B>, peer_id: PeerId, message: ConsensusMessage<B>) -> Option<(B::Hash, ConsensusMessage<B>)> {
let (hash, parent, message) = match message {
ConsensusMessage::Bft(msg) => {
let parent = msg.parent_hash;
let generic = GenericMessage::BftMessage(msg);
(
::protocol::hash_message(&generic),
parent,
match generic {
GenericMessage::BftMessage(msg) => ConsensusMessage::Bft(msg),
_ => panic!("`generic` is known to be the `BftMessage` variant; qed"),
}
)
}
ConsensusMessage::ChainSpecific(msg, parent) => {
let generic = GenericMessage::ChainSpecific(msg);
(
::protocol::hash_message::<B>(&generic),
parent,
match generic {
GenericMessage::ChainSpecific(msg) => ConsensusMessage::ChainSpecific(msg, parent),
_ => panic!("`generic` is known to be the `ChainSpecific` variant; qed"),
}
)
}
};
if self.message_hashes.contains(&hash) {
trace!(target:"gossip", "Ignored already known message from {}", peer_id);
return None;
}
match (protocol.client().info(), protocol.client().header(&BlockId::Hash(parent))) {
(_, Err(e)) | (Err(e), _) => {
debug!(target:"gossip", "Error reading blockchain: {:?}", e);
return None;
},
(Ok(info), Ok(Some(header))) => {
if header.number() < &info.chain.best_number {
trace!(target:"gossip", "Ignored ancient message from {}, hash={}", peer_id, parent);
return None;
}
},
(Ok(_), Ok(None)) => {},
}
if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
peer.known_messages.insert(hash);
if let Some((sink, parent_hash)) = self.message_sink.take() {
if parent == parent_hash {
if let Err(e) = sink.unbounded_send(message.clone()) {
trace!(target:"gossip", "Error broadcasting message notification: {:?}", e);
}
}
self.message_sink = Some((sink, parent_hash));
}
} else {
trace!(target:"gossip", "Ignored statement from unregistered peer {}", peer_id);
return None;
}
Some((hash, message))
}
fn multicast(&mut self, protocol: &mut Context<B>, message: ConsensusMessage<B>, hash: Option<B::Hash>) {
let generic = match message {
ConsensusMessage::Bft(ref message) => GenericMessage::BftMessage(message.clone()),
ConsensusMessage::ChainSpecific(ref message, _) => GenericMessage::ChainSpecific(message.clone()),
};
let hash = hash.unwrap_or_else(|| ::protocol::hash_message(&generic));
self.register_message(hash, message);
self.propagate(protocol, generic, hash);
}
}
#[cfg(test)]
mod tests {
use runtime_primitives::bft::Justification;
use runtime_primitives::testing::{H256, Header, Block as RawBlock};
use std::time::Instant;
use message::{self, generic};
use super::*;
type Block = RawBlock<u64>;
#[test]
fn collects_garbage() {
let prev_hash = H256::random();
let best_hash = H256::random();
let mut consensus = ConsensusGossip::<Block>::new();
let now = Instant::now();
let m1_hash = H256::random();
let m2_hash = H256::random();
let m1 = ConsensusMessage::Bft(message::LocalizedBftMessage {
parent_hash: prev_hash,
message: message::generic::BftMessage::Auxiliary(Justification {
round_number: 0,
hash: Default::default(),
signatures: Default::default(),
}),
});
let m2 = ConsensusMessage::ChainSpecific(vec![1, 2, 3], best_hash);
macro_rules! push_msg {
($hash:expr, $now: expr, $m:expr) => {
consensus.messages.push(MessageEntry {
hash: $hash,
instant: $now,
message: $m,
})
}
}
push_msg!(m1_hash, now, m1);
push_msg!(m2_hash, now, m2.clone());
consensus.message_hashes.insert(m1_hash);
consensus.message_hashes.insert(m2_hash);
// nothing to collect
consensus.collect_garbage(None);
assert_eq!(consensus.messages.len(), 2);
assert_eq!(consensus.message_hashes.len(), 2);
// random header, nothing should be cleared
let mut header = Header {
parent_hash: H256::default(),
number: 0,
state_root: H256::default(),
extrinsics_root: H256::default(),
digest: Default::default(),
};
consensus.collect_garbage(Some(&H256::default()));
assert_eq!(consensus.messages.len(), 2);
assert_eq!(consensus.message_hashes.len(), 2);
// header that matches one of the messages
header.parent_hash = prev_hash;
consensus.collect_garbage(Some(&prev_hash));
assert_eq!(consensus.messages.len(), 1);
assert_eq!(consensus.message_hashes.len(), 1);
assert!(consensus.message_hashes.contains(&m2_hash));
// make timestamp expired
consensus.messages.clear();
push_msg!(m2_hash, now - MESSAGE_LIFETIME, m2);
consensus.collect_garbage(None);
assert!(consensus.messages.is_empty());
assert!(consensus.message_hashes.is_empty());
}
#[test]
fn message_stream_include_those_sent_before_asking_for_stream() {
use futures::Stream;
let mut consensus = ConsensusGossip::new();
let bft_message = generic::BftMessage::Consensus(generic::SignedConsensusMessage::Vote(generic::SignedConsensusVote {
vote: generic::ConsensusVote::AdvanceRound(0),
sender: [0; 32].into(),
signature: Default::default(),
}));
let parent_hash = [1; 32].into();
let localized = ::message::LocalizedBftMessage::<Block> {
message: bft_message,
parent_hash: parent_hash,
};
let message = generic::Message::BftMessage(localized.clone());
let message_hash = ::protocol::hash_message::<Block>(&message);
let message = ConsensusMessage::Bft(localized);
consensus.register_message(message_hash, message.clone());
let stream = consensus.messages_for(parent_hash);
assert_eq!(stream.wait().next(), Some(Ok(message)));
}
}
+9 -7
View File
@@ -16,8 +16,8 @@
#![warn(missing_docs)] #![warn(missing_docs)]
//! Implements polkadot protocol version as specified here: //! Substrate-specific P2P networking: synchronizing blocks, propagating BFT messages.
//! https://github.com/paritytech/polkadot/wiki/Network-protocol //! Allows attachment of an optional subprotocol for chain-specific requests.
extern crate ethcore_network_devp2p as network_devp2p; extern crate ethcore_network_devp2p as network_devp2p;
extern crate ethcore_network as network; extern crate ethcore_network as network;
@@ -50,22 +50,24 @@ mod service;
mod sync; mod sync;
mod protocol; mod protocol;
mod io; mod io;
mod message;
mod config; mod config;
mod chain; mod chain;
mod blocks; mod blocks;
mod consensus;
mod on_demand; mod on_demand;
pub mod consensus_gossip;
pub mod error; pub mod error;
pub mod message;
pub mod specialization;
#[cfg(test)] mod test; #[cfg(test)] mod test;
pub use chain::Client as ClientHandle;
pub use service::{Service, FetchFuture, ConsensusService, BftMessageStream, pub use service::{Service, FetchFuture, ConsensusService, BftMessageStream,
TransactionPool, Params, ManageNetwork, SyncProvider}; TransactionPool, Params, ManageNetwork, SyncProvider};
pub use protocol::{ProtocolStatus}; pub use protocol::{ProtocolStatus, PeerInfo, Context};
pub use sync::{Status as SyncStatus, SyncState}; pub use sync::{Status as SyncStatus, SyncState};
pub use network::{NonReservedPeerMode, NetworkConfiguration, ConnectionFilter, ConnectionDirection}; pub use network::{NonReservedPeerMode, NetworkConfiguration, PeerId, ProtocolId, ConnectionFilter, ConnectionDirection};
pub use message::{generic as generic_message, BftMessage, LocalizedBftMessage, ConsensusVote, SignedConsensusVote, SignedConsensusMessage, SignedConsensusProposal}; pub use message::{generic as generic_message, RequestId, BftMessage, LocalizedBftMessage, ConsensusVote, SignedConsensusVote, SignedConsensusMessage, SignedConsensusProposal, Status as StatusMessage};
pub use error::Error; pub use error::Error;
pub use config::{Role, ProtocolConfig}; pub use config::{Role, ProtocolConfig};
pub use on_demand::{OnDemand, OnDemandService, RemoteCallResponse}; pub use on_demand::{OnDemand, OnDemandService, RemoteCallResponse};
+16 -23
View File
@@ -1,18 +1,18 @@
// Copyright 2017 Parity Technologies (UK) Ltd. // Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot. // This file is part of Substrate.
// Polkadot is free software: you can redistribute it and/or modify // Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by // it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or // the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version. // (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful, // Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of // but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details. // GNU General Public License for more details.
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.? // along with Substrate. If not, see <http://www.gnu.org/licenses/>.
//! Network packet message types. These get serialized and put into the lower level protocol payload. //! Network packet message types. These get serialized and put into the lower level protocol payload.
@@ -21,6 +21,7 @@ use service::Role as RoleFlags;
pub use self::generic::{BlockAnnounce, RemoteCallRequest, ConsensusVote, SignedConsensusVote, FromBlock, Body}; pub use self::generic::{BlockAnnounce, RemoteCallRequest, ConsensusVote, SignedConsensusVote, FromBlock, Body};
/// A unique ID of a request.
pub type RequestId = u64; pub type RequestId = u64;
/// Type alias for using the message type using block type parameters. /// Type alias for using the message type using block type parameters.
@@ -88,14 +89,12 @@ pub type Transactions<E> = Vec<E>;
/// Configured node role. /// Configured node role.
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)] #[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
pub enum Role { pub enum Role {
/// Full relay chain client with no additional responsibilities. /// Full node with no additional responsibilities.
Full, Full,
/// Relay chain light client. /// Light client.
Light, Light,
/// Parachain validator. /// Parachain validator.
Validator, Authority,
/// Parachain collator.
Collator,
} }
impl Role { impl Role {
@@ -106,8 +105,7 @@ impl Role {
match *r { match *r {
Role::Full => flags = flags | RoleFlags::FULL, Role::Full => flags = flags | RoleFlags::FULL,
Role::Light => flags = flags | RoleFlags::LIGHT, Role::Light => flags = flags | RoleFlags::LIGHT,
Role::Validator => flags = flags | RoleFlags::VALIDATOR, Role::Authority => flags = flags | RoleFlags::AUTHORITY,
Role::Collator => flags = flags | RoleFlags::COLLATOR,
} }
} }
flags flags
@@ -123,11 +121,8 @@ impl From<RoleFlags> for Vec<Role> where {
if !(flags & RoleFlags::LIGHT).is_empty() { if !(flags & RoleFlags::LIGHT).is_empty() {
roles.push(Role::Light); roles.push(Role::Light);
} }
if !(flags & RoleFlags::VALIDATOR).is_empty() { if !(flags & RoleFlags::AUTHORITY).is_empty() {
roles.push(Role::Validator); roles.push(Role::Authority);
}
if !(flags & RoleFlags::COLLATOR).is_empty() {
roles.push(Role::Collator);
} }
roles roles
} }
@@ -157,8 +152,8 @@ pub enum Direction {
Descending, Descending,
} }
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
/// Remote call response. /// Remote call response.
#[derive(Debug, PartialEq, Eq, Clone, Serialize, Deserialize)]
pub struct RemoteCallResponse { pub struct RemoteCallResponse {
/// Id of a request this response was made for. /// Id of a request this response was made for.
pub id: RequestId, pub id: RequestId,
@@ -358,6 +353,8 @@ pub mod generic {
RemoteCallRequest(RemoteCallRequest<Hash>), RemoteCallRequest(RemoteCallRequest<Hash>),
/// Remote method call response. /// Remote method call response.
RemoteCallResponse(RemoteCallResponse), RemoteCallResponse(RemoteCallResponse),
/// Chain-specific message
ChainSpecific(Vec<u8>),
} }
/// Status sent on connection. /// Status sent on connection.
@@ -373,12 +370,8 @@ pub mod generic {
pub best_hash: Hash, pub best_hash: Hash,
/// Genesis block hash. /// Genesis block hash.
pub genesis_hash: Hash, pub genesis_hash: Hash,
/// Signatue of `best_hash` made with validator address. Required for the validator role. /// Chain-specific status.
pub validator_signature: Option<ed25519::Signature>, pub chain_status: Vec<u8>,
/// Validator address. Required for the validator role.
pub validator_id: Option<AuthorityId>,
/// Parachain id. Required for the collator role.
pub parachain_id: Option<u64>,
} }
/// Request block data from a peer. /// Request block data from a peer.
+5 -10
View File
@@ -169,7 +169,7 @@ impl<B, E> OnDemandService<B> for OnDemand<B, E> where
B::Header: HeaderT<Number=u64>, B::Header: HeaderT<Number=u64>,
{ {
fn on_connect(&self, peer: PeerId, role: service::Role) { fn on_connect(&self, peer: PeerId, role: service::Role) {
if !role.intersects(service::Role::FULL | service::Role::COLLATOR | service::Role::VALIDATOR) { // TODO: correct? if !role.intersects(service::Role::FULL | service::Role::AUTHORITY) { // TODO: correct?
return; return;
} }
@@ -296,9 +296,7 @@ impl<B, E> OnDemandCore<B, E> where
request.timestamp = Instant::now(); request.timestamp = Instant::now();
trace!(target: "sync", "Dispatching remote request {} to peer {}", request.id, peer); trace!(target: "sync", "Dispatching remote request {} to peer {}", request.id, peer);
service.execute_in_context(|ctx, protocol| { service.execute_in_context(|ctx| ctx.send_message(peer, request.message()));
protocol.send_message(ctx, peer, request.message())
});
self.active_peers.insert(peer, request); self.active_peers.insert(peer, request);
} }
} }
@@ -326,10 +324,8 @@ mod tests {
use parking_lot::RwLock; use parking_lot::RwLock;
use client; use client;
use client::light::fetcher::{Fetcher, FetchChecker, RemoteCallRequest}; use client::light::fetcher::{Fetcher, FetchChecker, RemoteCallRequest};
use io::NetSyncIo;
use message; use message;
use network::PeerId; use network::PeerId;
use protocol::Protocol;
use service::{Role, ExecuteInContext}; use service::{Role, ExecuteInContext};
use test::TestIo; use test::TestIo;
use super::{REQUEST_TIMEOUT, OnDemand, OnDemandService}; use super::{REQUEST_TIMEOUT, OnDemand, OnDemandService};
@@ -339,7 +335,7 @@ mod tests {
struct DummyFetchChecker { ok: bool } struct DummyFetchChecker { ok: bool }
impl ExecuteInContext<Block> for DummyExecutor { impl ExecuteInContext<Block> for DummyExecutor {
fn execute_in_context<F: Fn(&mut NetSyncIo, &Protocol<Block>)>(&self, _closure: F) {} fn execute_in_context<F: Fn(&mut ::protocol::Context<Block>)>(&self, _closure: F) {}
} }
impl FetchChecker<Block> for DummyFetchChecker { impl FetchChecker<Block> for DummyFetchChecker {
@@ -378,9 +374,8 @@ mod tests {
let (_, on_demand) = dummy(true); let (_, on_demand) = dummy(true);
on_demand.on_connect(0, Role::LIGHT); on_demand.on_connect(0, Role::LIGHT);
on_demand.on_connect(1, Role::FULL); on_demand.on_connect(1, Role::FULL);
on_demand.on_connect(2, Role::COLLATOR); on_demand.on_connect(2, Role::AUTHORITY);
on_demand.on_connect(3, Role::VALIDATOR); assert_eq!(vec![1, 2], on_demand.core.lock().idle_peers.iter().cloned().collect::<Vec<_>>());
assert_eq!(vec![1, 2, 3], on_demand.core.lock().idle_peers.iter().cloned().collect::<Vec<_>>());
} }
#[test] #[test]
+200 -109
View File
@@ -18,7 +18,7 @@ use std::collections::{HashMap, HashSet};
use std::{mem, cmp}; use std::{mem, cmp};
use std::sync::Arc; use std::sync::Arc;
use std::time; use std::time;
use parking_lot::{RwLock, Mutex}; use parking_lot::RwLock;
use serde_json; use serde_json;
use runtime_primitives::traits::{Block as BlockT, Header as HeaderT, Hashing, HashingFor}; use runtime_primitives::traits::{Block as BlockT, Header as HeaderT, Hashing, HashingFor};
use runtime_primitives::generic::BlockId; use runtime_primitives::generic::BlockId;
@@ -26,9 +26,9 @@ use network::PeerId;
use message::{self, Message}; use message::{self, Message};
use message::generic::Message as GenericMessage; use message::generic::Message as GenericMessage;
use specialization::Specialization;
use sync::{ChainSync, Status as SyncStatus, SyncState}; use sync::{ChainSync, Status as SyncStatus, SyncState};
use consensus::Consensus; use service::{Role, TransactionPool};
use service::{Role, TransactionPool, BftMessageStream};
use config::ProtocolConfig; use config::ProtocolConfig;
use chain::Client; use chain::Client;
use on_demand::OnDemandService; use on_demand::OnDemandService;
@@ -36,26 +36,28 @@ use io::SyncIo;
use error; use error;
const REQUEST_TIMEOUT_SEC: u64 = 40; const REQUEST_TIMEOUT_SEC: u64 = 40;
const PROTOCOL_VERSION: u32 = 0;
/// Current protocol version.
pub (crate) const CURRENT_VERSION: u32 = 1;
/// Current packet count.
pub (crate) const CURRENT_PACKET_COUNT: u8 = 1;
// Maximum allowed entries in `BlockResponse` // Maximum allowed entries in `BlockResponse`
const MAX_BLOCK_DATA_RESPONSE: u32 = 128; const MAX_BLOCK_DATA_RESPONSE: u32 = 128;
// Lock must always be taken in order declared here. // Lock must always be taken in order declared here.
pub struct Protocol<B: BlockT> { pub struct Protocol<B: BlockT, S: Specialization<B>> {
config: ProtocolConfig, config: ProtocolConfig,
chain: Arc<Client<B>>,
on_demand: Option<Arc<OnDemandService<B>>>, on_demand: Option<Arc<OnDemandService<B>>>,
genesis_hash: B::Hash, genesis_hash: B::Hash,
sync: RwLock<ChainSync<B>>, sync: RwLock<ChainSync<B>>,
consensus: Mutex<Consensus<B>>, specialization: RwLock<S>,
// All connected peers context_data: ContextData<B>,
peers: RwLock<HashMap<PeerId, Peer<B>>>,
// Connected peers pending Status message. // Connected peers pending Status message.
handshaking_peers: RwLock<HashMap<PeerId, time::Instant>>, handshaking_peers: RwLock<HashMap<PeerId, time::Instant>>,
transaction_pool: Arc<TransactionPool<B>>, transaction_pool: Arc<TransactionPool<B>>,
} }
/// Syncing status and statistics /// Syncing status and statistics
#[derive(Clone)] #[derive(Clone)]
pub struct ProtocolStatus<B: BlockT> { pub struct ProtocolStatus<B: BlockT> {
@@ -82,13 +84,14 @@ struct Peer<B: BlockT> {
/// Request timestamp /// Request timestamp
request_timestamp: Option<time::Instant>, request_timestamp: Option<time::Instant>,
/// Holds a set of transactions known to this peer. /// Holds a set of transactions known to this peer.
known_transactions: HashSet<B::Hash>, known_extrinsics: HashSet<B::Hash>,
/// Holds a set of blocks known to this peer. /// Holds a set of blocks known to this peer.
known_blocks: HashSet<B::Hash>, known_blocks: HashSet<B::Hash>,
/// Request counter, /// Request counter,
next_request_id: message::RequestId, next_request_id: message::RequestId,
} }
/// Info about a peer's known state.
#[derive(Debug)] #[derive(Debug)]
pub struct PeerInfo<B: BlockT> { pub struct PeerInfo<B: BlockT> {
/// Roles /// Roles
@@ -101,36 +104,128 @@ pub struct PeerInfo<B: BlockT> {
pub best_number: <B::Header as HeaderT>::Number, pub best_number: <B::Header as HeaderT>::Number,
} }
impl<B: BlockT> Protocol<B> where /// Context for a network-specific handler.
B::Header: HeaderT<Number=u64> pub trait Context<B: BlockT> {
{ /// Get a reference to the client.
fn client(&self) -> &::chain::Client<B>;
/// Disable a peer
fn disable_peer(&mut self, peer_id: PeerId);
/// Disconnect peer
fn disconnect_peer(&mut self, peer_id: PeerId);
/// Get peer info.
fn peer_info(&self, peer: PeerId) -> Option<PeerInfo<B>>;
/// Send a message to a peer.
fn send_message(&mut self, peer_id: PeerId, data: ::message::Message<B>);
}
/// Protocol context.
pub(crate) struct ProtocolContext<'a, B: 'a + BlockT> {
io: &'a mut SyncIo,
context_data: &'a ContextData<B>,
}
impl<'a, B: BlockT + 'a> ProtocolContext<'a, B> {
pub(crate) fn new(context_data: &'a ContextData<B>, io: &'a mut SyncIo) -> Self {
ProtocolContext {
io,
context_data,
}
}
/// Send a message to a peer.
pub fn send_message(&mut self, peer_id: PeerId, message: Message<B>) {
send_message(&self.context_data.peers, self.io, peer_id, message)
}
pub fn disable_peer(&mut self, peer_id: PeerId) {
self.io.disable_peer(peer_id);
}
pub fn disconnect_peer(&mut self, peer_id: PeerId) {
self.io.disconnect_peer(peer_id)
}
/// Get peer info.
pub fn peer_info(&self, peer: PeerId) -> Option<PeerInfo<B>> {
self.context_data.peers.read().get(&peer).map(|p| {
PeerInfo {
roles: p.roles,
protocol_version: p.protocol_version,
best_hash: p.best_hash,
best_number: p.best_number,
}
})
}
}
impl<'a, B: BlockT + 'a> Context<B> for ProtocolContext<'a, B> {
fn send_message(&mut self, peer_id: PeerId, message: Message<B>) {
ProtocolContext::send_message(self, peer_id, message);
}
fn disable_peer(&mut self, peer_id: PeerId) {
ProtocolContext::disable_peer(self, peer_id);
}
fn disconnect_peer(&mut self, peer_id: PeerId) {
ProtocolContext::disconnect_peer(self, peer_id);
}
fn peer_info(&self, peer_id: PeerId) -> Option<PeerInfo<B>> {
ProtocolContext::peer_info(self, peer_id)
}
fn client(&self) -> &Client<B> {
&*self.context_data.chain
}
}
/// Data necessary to create a context.
pub(crate) struct ContextData<B: BlockT> {
// All connected peers
peers: RwLock<HashMap<PeerId, Peer<B>>>,
chain: Arc<Client<B>>,
}
impl<B: BlockT, S: Specialization<B>> Protocol<B, S> where B::Header: HeaderT<Number=u64> {
/// Create a new instance. /// Create a new instance.
pub fn new( pub fn new(
config: ProtocolConfig, config: ProtocolConfig,
chain: Arc<Client<B>>, chain: Arc<Client<B>>,
on_demand: Option<Arc<OnDemandService<B>>>, on_demand: Option<Arc<OnDemandService<B>>>,
transaction_pool: Arc<TransactionPool<B>> transaction_pool: Arc<TransactionPool<B>>,
specialization: S,
) -> error::Result<Self> { ) -> error::Result<Self> {
let info = chain.info()?; let info = chain.info()?;
let sync = ChainSync::new(config.roles, &info); let sync = ChainSync::new(config.roles, &info);
let protocol = Protocol { let protocol = Protocol {
config: config, config: config,
chain: chain, context_data: ContextData {
on_demand: on_demand, peers: RwLock::new(HashMap::new()),
chain,
},
on_demand,
genesis_hash: info.chain.genesis_hash, genesis_hash: info.chain.genesis_hash,
sync: RwLock::new(sync), sync: RwLock::new(sync),
consensus: Mutex::new(Consensus::new()), specialization: RwLock::new(specialization),
peers: RwLock::new(HashMap::new()),
handshaking_peers: RwLock::new(HashMap::new()), handshaking_peers: RwLock::new(HashMap::new()),
transaction_pool: transaction_pool, transaction_pool: transaction_pool,
}; };
Ok(protocol) Ok(protocol)
} }
pub(crate) fn context_data(&self) -> &ContextData<B> {
&self.context_data
}
/// Returns protocol status /// Returns protocol status
pub fn status(&self) -> ProtocolStatus<B> { pub fn status(&self) -> ProtocolStatus<B> {
let sync = self.sync.read(); let sync = self.sync.read();
let peers = self.peers.read(); let peers = self.context_data.peers.read();
ProtocolStatus { ProtocolStatus {
sync: sync.status(), sync: sync.status(),
num_peers: peers.values().count(), num_peers: peers.values().count(),
@@ -154,7 +249,7 @@ impl<B: BlockT> Protocol<B> where
GenericMessage::BlockRequest(r) => self.on_block_request(io, peer_id, r), GenericMessage::BlockRequest(r) => self.on_block_request(io, peer_id, r),
GenericMessage::BlockResponse(r) => { GenericMessage::BlockResponse(r) => {
let request = { let request = {
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
if let Some(ref mut peer) = peers.get_mut(&peer_id) { if let Some(ref mut peer) = peers.get_mut(&peer_id) {
peer.request_timestamp = None; peer.request_timestamp = None;
match mem::replace(&mut peer.block_request, None) { match mem::replace(&mut peer.block_request, None) {
@@ -177,39 +272,16 @@ impl<B: BlockT> Protocol<B> where
} }
self.on_block_response(io, peer_id, request, r); self.on_block_response(io, peer_id, request, r);
}, },
GenericMessage::BlockAnnounce(announce) => { GenericMessage::BlockAnnounce(announce) => self.on_block_announce(io, peer_id, announce),
self.on_block_announce(io, peer_id, announce); GenericMessage::Transactions(m) => self.on_extrinsics(io, peer_id, m),
},
GenericMessage::BftMessage(m) => self.on_bft_message(io, peer_id, m, HashingFor::<B>::hash(data)),
GenericMessage::Transactions(m) => self.on_transactions(io, peer_id, m),
GenericMessage::RemoteCallRequest(request) => self.on_remote_call_request(io, peer_id, request), GenericMessage::RemoteCallRequest(request) => self.on_remote_call_request(io, peer_id, request),
GenericMessage::RemoteCallResponse(response) => self.on_remote_call_response(io, peer_id, response), GenericMessage::RemoteCallResponse(response) => self.on_remote_call_response(io, peer_id, response),
other => self.specialization.write().on_message(&mut ProtocolContext::new(&self.context_data, io), peer_id, other),
} }
} }
pub fn send_message(&self, io: &mut SyncIo, peer_id: PeerId, mut message: Message<B>) { pub fn send_message(&self, io: &mut SyncIo, peer_id: PeerId, message: Message<B>) {
match &mut message { send_message::<B>(&self.context_data.peers, io, peer_id, message)
&mut GenericMessage::BlockRequest(ref mut r) => {
let mut peers = self.peers.write();
if let Some(ref mut peer) = peers.get_mut(&peer_id) {
r.id = peer.next_request_id;
peer.next_request_id = peer.next_request_id + 1;
peer.block_request = Some(r.clone());
peer.request_timestamp = Some(time::Instant::now());
}
},
_ => (),
}
let data = serde_json::to_vec(&message).expect("Serializer is infallible; qed");
if let Err(e) = io.send(peer_id, data) {
debug!(target:"sync", "Error sending message: {:?}", e);
io.disconnect_peer(peer_id);
}
}
pub fn hash_message(message: &Message<B>) -> B::Hash {
let data = serde_json::to_vec(&message).expect("Serializer is infallible; qed");
HashingFor::<B>::hash(&data)
} }
/// Called when a new peer is connected /// Called when a new peer is connected
@@ -222,15 +294,21 @@ impl<B: BlockT> Protocol<B> where
/// Called by peer when it is disconnecting /// Called by peer when it is disconnecting
pub fn on_peer_disconnected(&self, io: &mut SyncIo, peer: PeerId) { pub fn on_peer_disconnected(&self, io: &mut SyncIo, peer: PeerId) {
trace!(target: "sync", "Disconnecting {}: {}", peer, io.peer_info(peer)); trace!(target: "sync", "Disconnecting {}: {}", peer, io.peer_info(peer));
// lock all the the peer lists so that add/remove peer events are in order
let mut sync = self.sync.write();
let mut spec = self.specialization.write();
let removed = { let removed = {
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
let mut handshaking_peers = self.handshaking_peers.write(); let mut handshaking_peers = self.handshaking_peers.write();
handshaking_peers.remove(&peer); handshaking_peers.remove(&peer);
peers.remove(&peer).is_some() peers.remove(&peer).is_some()
}; };
if removed { if removed {
self.consensus.lock().peer_disconnected(io, self, peer); let mut context = ProtocolContext::new(&self.context_data, io);
self.sync.write().peer_disconnected(io, self, peer); sync.peer_disconnected(&mut context, peer);
spec.on_disconnect(&mut context, peer);
self.on_demand.as_ref().map(|s| s.on_disconnect(peer)); self.on_demand.as_ref().map(|s| s.on_disconnect(peer));
} }
} }
@@ -254,17 +332,17 @@ impl<B: BlockT> Protocol<B> where
message::BlockAttribute::Justification => get_justification = true, message::BlockAttribute::Justification => get_justification = true,
} }
} }
while let Some(header) = self.chain.header(&id).unwrap_or(None) { while let Some(header) = self.context_data.chain.header(&id).unwrap_or(None) {
if blocks.len() >= max{ if blocks.len() >= max{
break; break;
} }
let number = header.number().clone(); let number = header.number().clone();
let hash = header.hash(); let hash = header.hash();
let justification = if get_justification { self.chain.justification(&BlockId::Hash(hash)).unwrap_or(None) } else { None }; let justification = if get_justification { self.context_data.chain.justification(&BlockId::Hash(hash)).unwrap_or(None) } else { None };
let block_data = message::generic::BlockData { let block_data = message::generic::BlockData {
hash: hash, hash: hash,
header: if get_header { Some(header) } else { None }, header: if get_header { Some(header) } else { None },
body: (if get_body { self.chain.body(&BlockId::Hash(hash)).unwrap_or(None) } else { None }).map(|body| message::Body::Extrinsics(body)), body: (if get_body { self.context_data.chain.body(&BlockId::Hash(hash)).unwrap_or(None) } else { None }).map(|body| message::Body::Extrinsics(body)),
receipt: None, receipt: None,
message_queue: None, message_queue: None,
justification: justification.map(|j| message::generic::BlockJustification::V2(j)), justification: justification.map(|j| message::generic::BlockJustification::V2(j)),
@@ -291,36 +369,20 @@ impl<B: BlockT> Protocol<B> where
fn on_block_response(&self, io: &mut SyncIo, peer: PeerId, request: message::BlockRequest<B>, response: message::BlockResponse<B>) { fn on_block_response(&self, io: &mut SyncIo, peer: PeerId, request: message::BlockRequest<B>, response: message::BlockResponse<B>) {
// TODO: validate response // TODO: validate response
trace!(target: "sync", "BlockResponse {} from {} with {} blocks", response.id, peer, response.blocks.len()); trace!(target: "sync", "BlockResponse {} from {} with {} blocks", response.id, peer, response.blocks.len());
self.sync.write().on_block_data(io, self, peer, request, response); self.sync.write().on_block_data(&mut ProtocolContext::new(&self.context_data, io), peer, request, response);
}
fn on_bft_message(&self, io: &mut SyncIo, peer: PeerId, message: message::LocalizedBftMessage<B>, hash: B::Hash) {
trace!(target: "sync", "BFT message from {}: {:?}", peer, message);
self.consensus.lock().on_bft_message(io, self, peer, message, hash);
}
/// See `ConsensusService` trait.
pub fn send_bft_message(&self, io: &mut SyncIo, message: message::LocalizedBftMessage<B>) {
self.consensus.lock().send_bft_message(io, self, message)
}
/// See `ConsensusService` trait.
pub fn bft_messages(&self, parent_hash: B::Hash) -> BftMessageStream<B> {
self.consensus.lock().bft_messages(parent_hash)
} }
/// Perform time based maintenance. /// Perform time based maintenance.
pub fn tick(&self, io: &mut SyncIo) { pub fn tick(&self, io: &mut SyncIo) {
self.maintain_peers(io); self.maintain_peers(io);
self.on_demand.as_ref().map(|s| s.maintain_peers(io)); self.on_demand.as_ref().map(|s| s.maintain_peers(io));
self.consensus.lock().collect_garbage(None);
} }
fn maintain_peers(&self, io: &mut SyncIo) { fn maintain_peers(&self, io: &mut SyncIo) {
let tick = time::Instant::now(); let tick = time::Instant::now();
let mut aborting = Vec::new(); let mut aborting = Vec::new();
{ {
let peers = self.peers.read(); let peers = self.context_data.peers.read();
let handshaking_peers = self.handshaking_peers.read(); let handshaking_peers = self.handshaking_peers.read();
for (peer_id, timestamp) in peers.iter() for (peer_id, timestamp) in peers.iter()
.filter_map(|(id, peer)| peer.request_timestamp.as_ref().map(|r| (id, r))) .filter_map(|(id, peer)| peer.request_timestamp.as_ref().map(|r| (id, r)))
@@ -332,13 +394,15 @@ impl<B: BlockT> Protocol<B> where
} }
} }
} }
self.specialization.write().maintain_peers(&mut ProtocolContext::new(&self.context_data, io));
for p in aborting { for p in aborting {
self.on_peer_disconnected(io, p); self.on_peer_disconnected(io, p);
} }
} }
pub fn peer_info(&self, peer: PeerId) -> Option<PeerInfo<B>> { pub fn peer_info(&self, peer: PeerId) -> Option<PeerInfo<B>> {
self.peers.read().get(&peer).map(|p| { self.context_data.peers.read().get(&peer).map(|p| {
PeerInfo { PeerInfo {
roles: p.roles, roles: p.roles,
protocol_version: p.protocol_version, protocol_version: p.protocol_version,
@@ -357,7 +421,7 @@ impl<B: BlockT> Protocol<B> where
} }
{ {
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
let mut handshaking_peers = self.handshaking_peers.write(); let mut handshaking_peers = self.handshaking_peers.write();
if peers.contains_key(&peer_id) { if peers.contains_key(&peer_id) {
debug!(target: "sync", "Unexpected status packet from {}:{}", peer_id, io.peer_info(peer_id)); debug!(target: "sync", "Unexpected status packet from {}:{}", peer_id, io.peer_info(peer_id));
@@ -368,7 +432,7 @@ impl<B: BlockT> Protocol<B> where
trace!(target: "sync", "Peer {} genesis hash mismatch (ours: {}, theirs: {})", peer_id, self.genesis_hash, status.genesis_hash); trace!(target: "sync", "Peer {} genesis hash mismatch (ours: {}, theirs: {})", peer_id, self.genesis_hash, status.genesis_hash);
return; return;
} }
if status.version != PROTOCOL_VERSION { if status.version != CURRENT_VERSION {
io.disable_peer(peer_id); io.disable_peer(peer_id);
trace!(target: "sync", "Peer {} unsupported eth protocol ({})", peer_id, status.version); trace!(target: "sync", "Peer {} unsupported eth protocol ({})", peer_id, status.version);
return; return;
@@ -381,7 +445,7 @@ impl<B: BlockT> Protocol<B> where
best_number: status.best_number, best_number: status.best_number,
block_request: None, block_request: None,
request_timestamp: None, request_timestamp: None,
known_transactions: HashSet::new(), known_extrinsics: HashSet::new(),
known_blocks: HashSet::new(), known_blocks: HashSet::new(),
next_request_id: 0, next_request_id: 0,
}; };
@@ -390,47 +454,48 @@ impl<B: BlockT> Protocol<B> where
debug!(target: "sync", "Connected {} {}", peer_id, io.peer_info(peer_id)); debug!(target: "sync", "Connected {} {}", peer_id, io.peer_info(peer_id));
} }
self.sync.write().new_peer(io, self, peer_id); let mut context = ProtocolContext::new(&self.context_data, io);
self.consensus.lock().new_peer(io, self, peer_id, &status.roles); self.sync.write().new_peer(&mut context, peer_id);
self.specialization.write().on_connect(&mut context, peer_id, status.clone());
self.on_demand.as_ref().map(|s| s.on_connect(peer_id, message::Role::as_flags(&status.roles))); self.on_demand.as_ref().map(|s| s.on_connect(peer_id, message::Role::as_flags(&status.roles)));
} }
/// Called when peer sends us new transactions /// Called when peer sends us new extrinsics
fn on_transactions(&self, _io: &mut SyncIo, peer_id: PeerId, transactions: message::Transactions<B::Extrinsic>) { fn on_extrinsics(&self, _io: &mut SyncIo, peer_id: PeerId, extrinsics: message::Transactions<B::Extrinsic>) {
// Accept transactions only when fully synced // Accept extrinsics only when fully synced
if self.sync.read().status().state != SyncState::Idle { if self.sync.read().status().state != SyncState::Idle {
trace!(target: "sync", "{} Ignoring transactions while syncing", peer_id); trace!(target: "sync", "{} Ignoring extrinsics while syncing", peer_id);
return; return;
} }
trace!(target: "sync", "Received {} transactions from {}", transactions.len(), peer_id); trace!(target: "sync", "Received {} extrinsics from {}", extrinsics.len(), peer_id);
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
if let Some(ref mut peer) = peers.get_mut(&peer_id) { if let Some(ref mut peer) = peers.get_mut(&peer_id) {
for t in transactions { for t in extrinsics {
if let Some(hash) = self.transaction_pool.import(&t) { if let Some(hash) = self.transaction_pool.import(&t) {
peer.known_transactions.insert(hash); peer.known_extrinsics.insert(hash);
} }
} }
} }
} }
/// Called when we propagate ready transactions to peers. /// Called when we propagate ready extrinsics to peers.
pub fn propagate_transactions(&self, io: &mut SyncIo) { pub fn propagate_extrinsics(&self, io: &mut SyncIo) {
debug!(target: "sync", "Propagating transactions"); debug!(target: "sync", "Propagating extrinsics");
// Accept transactions only when fully synced // Accept transactions only when fully synced
if self.sync.read().status().state != SyncState::Idle { if self.sync.read().status().state != SyncState::Idle {
return; return;
} }
let transactions = self.transaction_pool.transactions(); let extrinsics = self.transaction_pool.transactions();
let mut propagated_to = HashMap::new(); let mut propagated_to = HashMap::new();
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
for (peer_id, ref mut peer) in peers.iter_mut() { for (peer_id, ref mut peer) in peers.iter_mut() {
let (hashes, to_send): (Vec<_>, Vec<_>) = transactions let (hashes, to_send): (Vec<_>, Vec<_>) = extrinsics
.iter() .iter()
.cloned() .cloned()
.filter(|&(hash, _)| peer.known_transactions.insert(hash)) .filter(|&(hash, _)| peer.known_extrinsics.insert(hash))
.unzip(); .unzip();
if !to_send.is_empty() { if !to_send.is_empty() {
@@ -453,16 +518,14 @@ impl<B: BlockT> Protocol<B> where
/// Send Status message /// Send Status message
fn send_status(&self, io: &mut SyncIo, peer_id: PeerId) { fn send_status(&self, io: &mut SyncIo, peer_id: PeerId) {
if let Ok(info) = self.chain.info() { if let Ok(info) = self.context_data.chain.info() {
let status = message::generic::Status { let status = message::generic::Status {
version: PROTOCOL_VERSION, version: CURRENT_VERSION,
genesis_hash: info.chain.genesis_hash, genesis_hash: info.chain.genesis_hash,
roles: self.config.roles.into(), roles: self.config.roles.into(),
best_number: info.chain.best_number, best_number: info.chain.best_number,
best_hash: info.chain.best_hash, best_hash: info.chain.best_hash,
validator_signature: None, chain_status: self.specialization.read().status(),
validator_id: None,
parachain_id: None,
}; };
self.send_message(io, peer_id, GenericMessage::Status(status)) self.send_message(io, peer_id, GenericMessage::Status(status))
} }
@@ -470,24 +533,25 @@ impl<B: BlockT> Protocol<B> where
pub fn abort(&self) { pub fn abort(&self) {
let mut sync = self.sync.write(); let mut sync = self.sync.write();
let mut peers = self.peers.write(); let mut spec = self.specialization.write();
let mut peers = self.context_data.peers.write();
let mut handshaking_peers = self.handshaking_peers.write(); let mut handshaking_peers = self.handshaking_peers.write();
sync.clear(); sync.clear();
spec.on_abort();
peers.clear(); peers.clear();
handshaking_peers.clear(); handshaking_peers.clear();
self.consensus.lock().restart();
} }
pub fn on_block_announce(&self, io: &mut SyncIo, peer_id: PeerId, announce: message::BlockAnnounce<B::Header>) { pub fn on_block_announce(&self, io: &mut SyncIo, peer_id: PeerId, announce: message::BlockAnnounce<B::Header>) {
let header = announce.header; let header = announce.header;
let hash = header.hash(); let hash = header.hash();
{ {
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
if let Some(ref mut peer) = peers.get_mut(&peer_id) { if let Some(ref mut peer) = peers.get_mut(&peer_id) {
peer.known_blocks.insert(hash.clone()); peer.known_blocks.insert(hash.clone());
} }
} }
self.sync.write().on_block_announce(io, self, peer_id, hash, &header); self.sync.write().on_block_announce(&mut ProtocolContext::new(&self.context_data, io), peer_id, hash, &header);
} }
pub fn on_block_imported(&self, io: &mut SyncIo, hash: B::Hash, header: &B::Header) { pub fn on_block_imported(&self, io: &mut SyncIo, hash: B::Hash, header: &B::Header) {
@@ -499,7 +563,7 @@ impl<B: BlockT> Protocol<B> where
} }
// send out block announcements // send out block announcements
let mut peers = self.peers.write(); let mut peers = self.context_data.peers.write();
for (peer_id, ref mut peer) in peers.iter_mut() { for (peer_id, ref mut peer) in peers.iter_mut() {
if peer.known_blocks.insert(hash.clone()) { if peer.known_blocks.insert(hash.clone()) {
@@ -509,13 +573,11 @@ impl<B: BlockT> Protocol<B> where
})); }));
} }
} }
self.consensus.lock().collect_garbage(Some(&header));
} }
fn on_remote_call_request(&self, io: &mut SyncIo, peer_id: PeerId, request: message::RemoteCallRequest<B::Hash>) { fn on_remote_call_request(&self, io: &mut SyncIo, peer_id: PeerId, request: message::RemoteCallRequest<B::Hash>) {
trace!(target: "sync", "Remote call request {} from {} ({} at {})", request.id, peer_id, request.method, request.block); trace!(target: "sync", "Remote call request {} from {} ({} at {})", request.id, peer_id, request.method, request.block);
let proof = match self.chain.execution_proof(&request.block, &request.method, &request.data) { let proof = match self.context_data.chain.execution_proof(&request.block, &request.method, &request.data) {
Ok((_, proof)) => proof, Ok((_, proof)) => proof,
Err(error) => { Err(error) => {
trace!(target: "sync", "Remote call request {} from {} ({} at {}) failed with: {}", trace!(target: "sync", "Remote call request {} from {} ({} at {}) failed with: {}",
@@ -534,7 +596,36 @@ impl<B: BlockT> Protocol<B> where
self.on_demand.as_ref().map(|s| s.on_remote_call_response(io, peer_id, response)); self.on_demand.as_ref().map(|s| s.on_remote_call_response(io, peer_id, response));
} }
pub fn chain(&self) -> &Client<B> { /// Execute a closure with access to a network context and specialization.
&*self.chain pub fn with_spec<F, U>(&self, io: &mut SyncIo, f: F) -> U
where F: FnOnce(&mut S, &mut Context<B>) -> U
{
f(&mut* self.specialization.write(), &mut ProtocolContext::new(&self.context_data, io))
} }
} }
fn send_message<B: BlockT>(peers: &RwLock<HashMap<PeerId, Peer<B>>>, io: &mut SyncIo, peer_id: PeerId, mut message: Message<B>) {
match &mut message {
&mut GenericMessage::BlockRequest(ref mut r) => {
let mut peers = peers.write();
if let Some(ref mut peer) = peers.get_mut(&peer_id) {
r.id = peer.next_request_id;
peer.next_request_id = peer.next_request_id + 1;
peer.block_request = Some(r.clone());
peer.request_timestamp = Some(time::Instant::now());
}
},
_ => (),
}
let data = serde_json::to_vec(&message).expect("Serializer is infallible; qed");
if let Err(e) = io.send(peer_id, data) {
debug!(target:"sync", "Error sending message: {:?}", e);
io.disconnect_peer(peer_id);
}
}
/// Hash a message.
pub(crate) fn hash_message<B: BlockT>(message: &Message<B>) -> B::Hash {
let data = serde_json::to_vec(&message).expect("Serializer is infallible; qed");
HashingFor::<B>::hash(&data)
}
+55 -54
View File
@@ -1,18 +1,18 @@
// Copyright 2017 Parity Technologies (UK) Ltd. // Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot. // This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify // Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by // it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or // the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version. // (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful, // Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of // but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details. // GNU General Public License for more details.
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.? // along with Substrate. If not, see <http://www.gnu.org/licenses/>.
use std::collections::HashMap; use std::collections::HashMap;
use std::sync::Arc; use std::sync::Arc;
@@ -24,19 +24,15 @@ NetworkConfiguration , NonReservedPeerMode, ErrorKind};
use network_devp2p::{NetworkService}; use network_devp2p::{NetworkService};
use core_io::{TimerToken}; use core_io::{TimerToken};
use io::NetSyncIo; use io::NetSyncIo;
use protocol::{Protocol, ProtocolStatus, PeerInfo as ProtocolPeerInfo}; use protocol::{Protocol, ProtocolContext, Context, ProtocolStatus, PeerInfo as ProtocolPeerInfo};
use config::{ProtocolConfig}; use config::{ProtocolConfig};
use error::Error; use error::Error;
use chain::Client; use chain::Client;
use message::LocalizedBftMessage; use message::LocalizedBftMessage;
use specialization::Specialization;
use on_demand::OnDemandService; use on_demand::OnDemandService;
use runtime_primitives::traits::{Block as BlockT, Header as HeaderT}; use runtime_primitives::traits::{Block as BlockT, Header as HeaderT};
/// Polkadot devp2p protocol id
pub const DOT_PROTOCOL_ID: ProtocolId = *b"dot";
const V0_PACKET_COUNT: u8 = 1;
/// Type that represents fetch completion future. /// Type that represents fetch completion future.
pub type FetchFuture = oneshot::Receiver<Vec<u8>>; pub type FetchFuture = oneshot::Receiver<Vec<u8>>;
/// Type that represents bft messages stream. /// Type that represents bft messages stream.
@@ -53,14 +49,12 @@ bitflags! {
pub struct Role: u32 { pub struct Role: u32 {
/// No network. /// No network.
const NONE = 0b00000000; const NONE = 0b00000000;
/// Full node, doe not participate in consensus. /// Full node, does not participate in consensus.
const FULL = 0b00000001; const FULL = 0b00000001;
/// Light client node. /// Light client node.
const LIGHT = 0b00000010; const LIGHT = 0b00000010;
/// Act as a validator. /// Act as an authority
const VALIDATOR = 0b00000100; const AUTHORITY = 0b00000100;
/// Act as a collator.
const COLLATOR = 0b00001000;
} }
} }
@@ -99,12 +93,12 @@ pub trait ConsensusService<B: BlockT>: Send + Sync {
/// Service able to execute closure in the network context. /// Service able to execute closure in the network context.
pub trait ExecuteInContext<B: BlockT>: Send + Sync { pub trait ExecuteInContext<B: BlockT>: Send + Sync {
/// Execute closure in network context. /// Execute closure in network context.
fn execute_in_context<F: Fn(&mut NetSyncIo, &Protocol<B>)>(&self, closure: F); fn execute_in_context<F: Fn(&mut Context<B>)>(&self, closure: F);
} }
/// devp2p Protocol handler /// devp2p Protocol handler
struct ProtocolHandler<B: BlockT> { struct ProtocolHandler<B: BlockT, S: Specialization<B>> {
protocol: Protocol<B>, protocol: Protocol<B, S>,
} }
/// Peer connection information /// Peer connection information
@@ -125,7 +119,7 @@ pub struct PeerInfo<B: BlockT> {
} }
/// Service initialization parameters. /// Service initialization parameters.
pub struct Params<B: BlockT> { pub struct Params<B: BlockT, S> {
/// Configuration. /// Configuration.
pub config: ProtocolConfig, pub config: ProtocolConfig,
/// Network layer configuration. /// Network layer configuration.
@@ -136,24 +130,35 @@ pub struct Params<B: BlockT> {
pub on_demand: Option<Arc<OnDemandService<B>>>, pub on_demand: Option<Arc<OnDemandService<B>>>,
/// Transaction pool. /// Transaction pool.
pub transaction_pool: Arc<TransactionPool<B>>, pub transaction_pool: Arc<TransactionPool<B>>,
/// Protocol specialization.
pub specialization: S,
} }
/// Polkadot network service. Handles network IO and manages connectivity. /// Polkadot network service. Handles network IO and manages connectivity.
pub struct Service<B: BlockT + 'static> where B::Header: HeaderT<Number=u64> { pub struct Service<B: BlockT + 'static, S: Specialization<B>> where B::Header: HeaderT<Number=u64> {
/// Network service /// Network service
network: NetworkService, network: NetworkService,
/// Devp2p protocol handler /// Devp2p protocol handler
handler: Arc<ProtocolHandler<B>>, handler: Arc<ProtocolHandler<B, S>>,
/// Devp2p protocol ID.
protocol_id: ProtocolId,
} }
impl<B: BlockT + 'static> Service<B> where B::Header: HeaderT<Number=u64> { impl<B: BlockT + 'static, S: Specialization<B>> Service<B, S> where B::Header: HeaderT<Number=u64> {
/// Creates and register protocol with the network service /// Creates and register protocol with the network service
pub fn new(params: Params<B>) -> Result<Arc<Service<B>>, Error> { pub fn new(params: Params<B, S>, protocol_id: ProtocolId) -> Result<Arc<Service<B, S>>, Error> {
let service = NetworkService::new(params.network_config.clone(), None)?; let service = NetworkService::new(params.network_config.clone(), None)?;
let sync = Arc::new(Service { let sync = Arc::new(Service {
network: service, network: service,
protocol_id,
handler: Arc::new(ProtocolHandler { handler: Arc::new(ProtocolHandler {
protocol: Protocol::new(params.config, params.chain, params.on_demand, params.transaction_pool)?, protocol: Protocol::new(
params.config,
params.chain.clone(),
params.on_demand,
params.transaction_pool,
params.specialization
)?,
}), }),
}); });
@@ -162,18 +167,31 @@ impl<B: BlockT + 'static> Service<B> where B::Header: HeaderT<Number=u64> {
/// Called when a new block is imported by the client. /// Called when a new block is imported by the client.
pub fn on_block_imported(&self, hash: B::Hash, header: &B::Header) { pub fn on_block_imported(&self, hash: B::Hash, header: &B::Header) {
self.network.with_context(DOT_PROTOCOL_ID, |context| { self.network.with_context(self.protocol_id, |context| {
self.handler.protocol.on_block_imported(&mut NetSyncIo::new(context), hash, header) self.handler.protocol.on_block_imported(&mut NetSyncIo::new(context), hash, header)
}); });
} }
/// Called when new transactons are imported by the client. /// Called when new transactons are imported by the client.
pub fn trigger_repropagate(&self) { pub fn trigger_repropagate(&self) {
self.network.with_context(DOT_PROTOCOL_ID, |context| { self.network.with_context(self.protocol_id, |context| {
self.handler.protocol.propagate_transactions(&mut NetSyncIo::new(context)); self.handler.protocol.propagate_extrinsics(&mut NetSyncIo::new(context));
}); });
} }
/// Execute a closure with the chain-specific network specialization.
/// If the network is unavailable, this will return `None`.
pub fn with_spec<F, U>(&self, f: F) -> Option<U>
where F: FnOnce(&mut S, &mut Context<B>) -> U
{
let mut res = None;
self.network.with_context(self.protocol_id, |context| {
res = Some(self.handler.protocol.with_spec(&mut NetSyncIo::new(context), f))
});
res
}
fn start(&self) { fn start(&self) {
match self.network.start().map_err(|e| e.0.into()) { match self.network.start().map_err(|e| e.0.into()) {
Err(ErrorKind::Io(ref e)) if e.kind() == io::ErrorKind::AddrInUse => Err(ErrorKind::Io(ref e)) if e.kind() == io::ErrorKind::AddrInUse =>
@@ -181,7 +199,7 @@ impl<B: BlockT + 'static> Service<B> where B::Header: HeaderT<Number=u64> {
Err(err) => warn!("Error starting network: {}", err), Err(err) => warn!("Error starting network: {}", err),
_ => {}, _ => {},
}; };
self.network.register_protocol(self.handler.clone(), DOT_PROTOCOL_ID, &[(0, V0_PACKET_COUNT)]) self.network.register_protocol(self.handler.clone(), self.protocol_id, &[(::protocol::CURRENT_VERSION as u8, ::protocol::CURRENT_PACKET_COUNT)])
.unwrap_or_else(|e| warn!("Error registering polkadot protocol: {:?}", e)); .unwrap_or_else(|e| warn!("Error registering polkadot protocol: {:?}", e));
} }
@@ -191,21 +209,21 @@ impl<B: BlockT + 'static> Service<B> where B::Header: HeaderT<Number=u64> {
} }
} }
impl<B: BlockT + 'static> Drop for Service<B> where B::Header: HeaderT<Number=u64> { impl<B: BlockT + 'static, S: Specialization<B>> Drop for Service<B, S> where B::Header: HeaderT<Number=u64> {
fn drop(&mut self) { fn drop(&mut self) {
self.stop(); self.stop();
} }
} }
impl<B: BlockT + 'static> ExecuteInContext<B> for Service<B> where B::Header: HeaderT<Number=u64> { impl<B: BlockT + 'static, S: Specialization<B>> ExecuteInContext<B> for Service<B, S> where B::Header: HeaderT<Number=u64> {
fn execute_in_context<F: Fn(&mut NetSyncIo, &Protocol<B>)>(&self, closure: F) { fn execute_in_context<F: Fn(&mut ::protocol::Context<B>)>(&self, closure: F) {
self.network.with_context(DOT_PROTOCOL_ID, |context| { self.network.with_context(self.protocol_id, |context| {
closure(&mut NetSyncIo::new(context), &self.handler.protocol) closure(&mut ProtocolContext::new(self.handler.protocol.context_data(), &mut NetSyncIo::new(context)))
}); });
} }
} }
impl<B: BlockT + 'static> SyncProvider<B> for Service<B> where B::Header: HeaderT<Number=u64> { impl<B: BlockT + 'static, S: Specialization<B>> SyncProvider<B> for Service<B, S> where B::Header: HeaderT<Number=u64> {
/// Get sync status /// Get sync status
fn status(&self) -> ProtocolStatus<B> { fn status(&self) -> ProtocolStatus<B> {
self.handler.protocol.status() self.handler.protocol.status()
@@ -213,7 +231,7 @@ impl<B: BlockT + 'static> SyncProvider<B> for Service<B> where B::Header: Header
/// Get sync peers /// Get sync peers
fn peers(&self) -> Vec<PeerInfo<B>> { fn peers(&self) -> Vec<PeerInfo<B>> {
self.network.with_context_eval(DOT_PROTOCOL_ID, |ctx| { self.network.with_context_eval(self.protocol_id, |ctx| {
let peer_ids = self.network.connected_peers(); let peer_ids = self.network.connected_peers();
peer_ids.into_iter().filter_map(|peer_id| { peer_ids.into_iter().filter_map(|peer_id| {
@@ -239,24 +257,7 @@ impl<B: BlockT + 'static> SyncProvider<B> for Service<B> where B::Header: Header
} }
} }
/// ConsensusService impl<B: BlockT + 'static, S: Specialization<B>> NetworkProtocolHandler for ProtocolHandler<B, S> where B::Header: HeaderT<Number=u64> {
impl<B: BlockT + 'static> ConsensusService<B> for Service<B> where B::Header: HeaderT<Number=u64> {
fn connect_to_authorities(&self, _addresses: &[String]) {
//TODO: implement me
}
fn bft_messages(&self, parent_hash: B::Hash) -> BftMessageStream<B> {
self.handler.protocol.bft_messages(parent_hash)
}
fn send_bft_message(&self, message: LocalizedBftMessage<B>) {
self.network.with_context(DOT_PROTOCOL_ID, |context| {
self.handler.protocol.send_bft_message(&mut NetSyncIo::new(context), message);
});
}
}
impl<B: BlockT + 'static> NetworkProtocolHandler for ProtocolHandler<B> where B::Header: HeaderT<Number=u64> {
fn initialize(&self, io: &NetworkContext) { fn initialize(&self, io: &NetworkContext) {
io.register_timer(TICK_TOKEN, TICK_TIMEOUT) io.register_timer(TICK_TOKEN, TICK_TIMEOUT)
.expect("Error registering sync timer"); .expect("Error registering sync timer");
@@ -280,7 +281,7 @@ impl<B: BlockT + 'static> NetworkProtocolHandler for ProtocolHandler<B> where B:
fn timeout(&self, io: &NetworkContext, timer: TimerToken) { fn timeout(&self, io: &NetworkContext, timer: TimerToken) {
match timer { match timer {
TICK_TOKEN => self.protocol.tick(&mut NetSyncIo::new(io)), TICK_TOKEN => self.protocol.tick(&mut NetSyncIo::new(io)),
PROPAGATE_TOKEN => self.protocol.propagate_transactions(&mut NetSyncIo::new(io)), PROPAGATE_TOKEN => self.protocol.propagate_extrinsics(&mut NetSyncIo::new(io)),
_ => {} _ => {}
} }
} }
@@ -303,7 +304,7 @@ pub trait ManageNetwork: Send + Sync {
} }
impl<B: BlockT + 'static> ManageNetwork for Service<B> where B::Header: HeaderT<Number=u64> { impl<B: BlockT + 'static, S: Specialization<B>> ManageNetwork for Service<B, S> where B::Header: HeaderT<Number=u64> {
fn accept_unreserved_peers(&self) { fn accept_unreserved_peers(&self) {
self.network.set_non_reserved_mode(NonReservedPeerMode::Accept); self.network.set_non_reserved_mode(NonReservedPeerMode::Accept);
} }
@@ -0,0 +1,45 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Substrate.
// Substrate is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Substrate is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Substrate. If not, see <http://www.gnu.org/licenses/>.
//! Specializations of the substrate network protocol to allow more complex forms of communication.
use ::PeerId;
use runtime_primitives::traits::Block as BlockT;
use protocol::Context;
/// A specialization of the substrate network protocol. Handles events and sends messages.
pub trait Specialization<B: BlockT>: Send + Sync + 'static {
/// Get the current specialization-status.
fn status(&self) -> Vec<u8>;
/// Called on start-up.
fn on_start(&mut self) { }
/// Called when a peer successfully handshakes.
fn on_connect(&mut self, ctx: &mut Context<B>, peer_id: PeerId, status: ::message::Status<B>);
/// Called when a peer is disconnected. If the peer ID is unknown, it should be ignored.
fn on_disconnect(&mut self, ctx: &mut Context<B>, peer_id: PeerId);
/// Called when a network-specific message arrives.
fn on_message(&mut self, ctx: &mut Context<B>, peer_id: PeerId, message: ::message::Message<B>);
/// Called on abort.
fn on_abort(&mut self) { }
/// Called periodically to maintain peers and handle timeouts.
fn maintain_peers(&mut self, _ctx: &mut Context<B>) { }
}
+47 -48
View File
@@ -15,8 +15,7 @@
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.? // along with Polkadot. If not, see <http://www.gnu.org/licenses/>.?
use std::collections::HashMap; use std::collections::HashMap;
use io::SyncIo; use protocol::Context;
use protocol::Protocol;
use network::PeerId; use network::PeerId;
use client::{ImportResult, BlockStatus, ClientInfo}; use client::{ImportResult, BlockStatus, ClientInfo};
use blocks::{self, BlockCollection}; use blocks::{self, BlockCollection};
@@ -76,12 +75,12 @@ impl<B: BlockT> ChainSync<B> where
B::Header: HeaderT<Number=u64>, B::Header: HeaderT<Number=u64>,
{ {
/// Create a new instance. /// Create a new instance.
pub fn new(role: Role, info: &ClientInfo<B>) -> Self { pub(crate) fn new(role: Role, info: &ClientInfo<B>) -> Self {
let mut required_block_attributes = vec![ let mut required_block_attributes = vec![
message::BlockAttribute::Header, message::BlockAttribute::Header,
message::BlockAttribute::Justification message::BlockAttribute::Justification
]; ];
if role.intersects(Role::FULL | Role::VALIDATOR | Role::COLLATOR) { if role.intersects(Role::FULL) {
required_block_attributes.push(message::BlockAttribute::Body); required_block_attributes.push(message::BlockAttribute::Body);
} }
@@ -100,7 +99,7 @@ impl<B: BlockT> ChainSync<B> where
} }
/// Returns sync status /// Returns sync status
pub fn status(&self) -> Status<B> { pub(crate) fn status(&self) -> Status<B> {
let best_seen = self.best_seen_block(); let best_seen = self.best_seen_block();
let state = match &best_seen { let state = match &best_seen {
&Some(n) if n > self.best_queued_number && n - self.best_queued_number > 5 => SyncState::Downloading, &Some(n) if n > self.best_queued_number && n - self.best_queued_number > 5 => SyncState::Downloading,
@@ -113,20 +112,20 @@ impl<B: BlockT> ChainSync<B> where
} }
/// Handle new connected peer. /// Handle new connected peer.
pub fn new_peer(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId) { pub(crate) fn new_peer(&mut self, protocol: &mut Context<B>, peer_id: PeerId) {
if let Some(info) = protocol.peer_info(peer_id) { if let Some(info) = protocol.peer_info(peer_id) {
match (protocol.chain().block_status(&BlockId::Hash(info.best_hash)), info.best_number) { match (protocol.client().block_status(&BlockId::Hash(info.best_hash)), info.best_number) {
(Err(e), _) => { (Err(e), _) => {
debug!(target:"sync", "Error reading blockchain: {:?}", e); debug!(target:"sync", "Error reading blockchain: {:?}", e);
io.disconnect_peer(peer_id); protocol.disconnect_peer(peer_id);
}, },
(Ok(BlockStatus::KnownBad), _) => { (Ok(BlockStatus::KnownBad), _) => {
debug!(target:"sync", "New peer with known bad best block {} ({}).", info.best_hash, info.best_number); debug!(target:"sync", "New peer with known bad best block {} ({}).", info.best_hash, info.best_number);
io.disable_peer(peer_id); protocol.disable_peer(peer_id);
}, },
(Ok(BlockStatus::Unknown), 0) => { (Ok(BlockStatus::Unknown), 0) => {
debug!(target:"sync", "New peer with unknown genesis hash {} ({}).", info.best_hash, info.best_number); debug!(target:"sync", "New peer with unknown genesis hash {} ({}).", info.best_hash, info.best_number);
io.disable_peer(peer_id); protocol.disable_peer(peer_id);
}, },
(Ok(BlockStatus::Unknown), _) => { (Ok(BlockStatus::Unknown), _) => {
let our_best = self.best_queued_number; let our_best = self.best_queued_number;
@@ -139,7 +138,7 @@ impl<B: BlockT> ChainSync<B> where
best_number: info.best_number, best_number: info.best_number,
state: PeerSyncState::AncestorSearch(our_best), state: PeerSyncState::AncestorSearch(our_best),
}); });
Self::request_ancestry(io, protocol, peer_id, our_best) Self::request_ancestry(protocol, peer_id, our_best)
} else { } else {
// We are at genesis, just start downloading // We are at genesis, just start downloading
debug!(target:"sync", "New peer with best hash {} ({}).", info.best_hash, info.best_number); debug!(target:"sync", "New peer with best hash {} ({}).", info.best_hash, info.best_number);
@@ -150,7 +149,7 @@ impl<B: BlockT> ChainSync<B> where
best_number: info.best_number, best_number: info.best_number,
state: PeerSyncState::Available, state: PeerSyncState::Available,
}); });
self.download_new(io, protocol, peer_id) self.download_new(protocol, peer_id)
} }
}, },
(Ok(BlockStatus::Queued), _) | (Ok(BlockStatus::InChain), _) => { (Ok(BlockStatus::Queued), _) | (Ok(BlockStatus::InChain), _) => {
@@ -167,7 +166,7 @@ impl<B: BlockT> ChainSync<B> where
} }
} }
pub fn on_block_data(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, _request: message::BlockRequest<B>, response: message::BlockResponse<B>) { pub(crate) fn on_block_data(&mut self, protocol: &mut Context<B>, peer_id: PeerId, _request: message::BlockRequest<B>, response: message::BlockResponse<B>) {
let count = response.blocks.len(); let count = response.blocks.len();
let mut imported: usize = 0; let mut imported: usize = 0;
let new_blocks = if let Some(ref mut peer) = self.peers.get_mut(&peer_id) { let new_blocks = if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
@@ -190,7 +189,7 @@ impl<B: BlockT> ChainSync<B> where
match response.blocks.get(0) { match response.blocks.get(0) {
Some(ref block) => { Some(ref block) => {
trace!(target: "sync", "Got ancestry block #{} ({}) from peer {}", n, block.hash, peer_id); trace!(target: "sync", "Got ancestry block #{} ({}) from peer {}", n, block.hash, peer_id);
match protocol.chain().block_hash(n) { match protocol.client().block_hash(n) {
Ok(Some(block_hash)) if block_hash == block.hash => { Ok(Some(block_hash)) if block_hash == block.hash => {
if peer.common_number < n { if peer.common_number < n {
peer.common_hash = block.hash; peer.common_hash = block.hash;
@@ -204,24 +203,24 @@ impl<B: BlockT> ChainSync<B> where
trace!(target:"sync", "Ancestry block mismatch for peer {}: theirs: {} ({}), ours: {:?}", peer_id, block.hash, n, our_best); trace!(target:"sync", "Ancestry block mismatch for peer {}: theirs: {} ({}), ours: {:?}", peer_id, block.hash, n, our_best);
let n = n - 1; let n = n - 1;
peer.state = PeerSyncState::AncestorSearch(n); peer.state = PeerSyncState::AncestorSearch(n);
Self::request_ancestry(io, protocol, peer_id, n); Self::request_ancestry(protocol, peer_id, n);
return; return;
}, },
Ok(_) => { // genesis mismatch Ok(_) => { // genesis mismatch
trace!(target:"sync", "Ancestry search: genesis mismatch for peer {}", peer_id); trace!(target:"sync", "Ancestry search: genesis mismatch for peer {}", peer_id);
io.disable_peer(peer_id); protocol.disable_peer(peer_id);
return; return;
}, },
Err(e) => { Err(e) => {
debug!(target:"sync", "Error reading blockchain: {:?}", e); debug!(target:"sync", "Error reading blockchain: {:?}", e);
io.disconnect_peer(peer_id); protocol.disconnect_peer(peer_id);
return; return;
} }
} }
}, },
None => { None => {
trace!(target:"sync", "Invalid response when searching for ancestor from {}", peer_id); trace!(target:"sync", "Invalid response when searching for ancestor from {}", peer_id);
io.disconnect_peer(peer_id); protocol.disconnect_peer(peer_id);
return; return;
} }
} }
@@ -245,17 +244,17 @@ impl<B: BlockT> ChainSync<B> where
let is_best = best_seen.as_ref().map_or(false, |n| number >= *n); let is_best = best_seen.as_ref().map_or(false, |n| number >= *n);
// check whether the block is known before importing. // check whether the block is known before importing.
match protocol.chain().block_status(&BlockId::Hash(hash)) { match protocol.client().block_status(&BlockId::Hash(hash)) {
Ok(BlockStatus::InChain) => continue, Ok(BlockStatus::InChain) => continue,
Ok(_) => {}, Ok(_) => {},
Err(e) => { Err(e) => {
debug!(target: "sync", "Error importing block {}: {:?}: {:?}", number, hash, e); debug!(target: "sync", "Error importing block {}: {:?}: {:?}", number, hash, e);
self.restart(io, protocol); self.restart(protocol);
return; return;
} }
} }
let result = protocol.chain().import( let result = protocol.client().import(
is_best, is_best,
header, header,
justification.to_justification(), justification.to_justification(),
@@ -277,42 +276,42 @@ impl<B: BlockT> ChainSync<B> where
}, },
Ok(ImportResult::UnknownParent) => { Ok(ImportResult::UnknownParent) => {
debug!(target: "sync", "Block with unknown parent {}: {:?}, parent: {:?}", number, hash, parent); debug!(target: "sync", "Block with unknown parent {}: {:?}, parent: {:?}", number, hash, parent);
self.restart(io, protocol); self.restart(protocol);
return; return;
}, },
Ok(ImportResult::KnownBad) => { Ok(ImportResult::KnownBad) => {
debug!(target: "sync", "Bad block {}: {:?}", number, hash); debug!(target: "sync", "Bad block {}: {:?}", number, hash);
io.disable_peer(origin); //TODO: use persistent ID protocol.disable_peer(origin); //TODO: use persistent ID
self.restart(io, protocol); self.restart(protocol);
return; return;
} }
Err(e) => { Err(e) => {
debug!(target: "sync", "Error importing block {}: {:?}: {:?}", number, hash, e); debug!(target: "sync", "Error importing block {}: {:?}: {:?}", number, hash, e);
self.restart(io, protocol); self.restart(protocol);
return; return;
} }
} }
}, },
(None, _) => { (None, _) => {
debug!(target: "sync", "Header {} was not provided by {} ", block.hash, origin); debug!(target: "sync", "Header {} was not provided by {} ", block.hash, origin);
io.disable_peer(origin); //TODO: use persistent ID protocol.disable_peer(origin); //TODO: use persistent ID
return; return;
}, },
(_, None) => { (_, None) => {
debug!(target: "sync", "Justification set for block {} was not provided by {} ", block.hash, origin); debug!(target: "sync", "Justification set for block {} was not provided by {} ", block.hash, origin);
io.disable_peer(origin); //TODO: use persistent ID protocol.disable_peer(origin); //TODO: use persistent ID
return; return;
} }
} }
} }
trace!(target: "sync", "Imported {} of {}", imported, count); trace!(target: "sync", "Imported {} of {}", imported, count);
self.maintain_sync(io, protocol); self.maintain_sync(protocol);
} }
fn maintain_sync(&mut self, io: &mut SyncIo, protocol: &Protocol<B>) { fn maintain_sync(&mut self, protocol: &mut Context<B>) {
let peers: Vec<PeerId> = self.peers.keys().map(|p| *p).collect(); let peers: Vec<PeerId> = self.peers.keys().map(|p| *p).collect();
for peer in peers { for peer in peers {
self.download_new(io, protocol, peer); self.download_new(protocol, peer);
} }
} }
@@ -331,12 +330,12 @@ impl<B: BlockT> ChainSync<B> where
} }
} }
pub fn update_chain_info(&mut self, best_header: &B::Header) { pub(crate) fn update_chain_info(&mut self, best_header: &B::Header) {
let hash = best_header.hash(); let hash = best_header.hash();
self.block_imported(&hash, best_header.number().clone()) self.block_imported(&hash, best_header.number().clone())
} }
pub fn on_block_announce(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, hash: B::Hash, header: &B::Header) { pub(crate) fn on_block_announce(&mut self, protocol: &mut Context<B>, peer_id: PeerId, hash: B::Hash, header: &B::Header) {
let number = *header.number(); let number = *header.number();
if let Some(ref mut peer) = self.peers.get_mut(&peer_id) { if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
if number > peer.best_number { if number > peer.best_number {
@@ -357,35 +356,35 @@ impl<B: BlockT> ChainSync<B> where
trace!(target: "sync", "Ignoring unknown stale block announce from {}: {} {:?}", peer_id, hash, header); trace!(target: "sync", "Ignoring unknown stale block announce from {}: {} {:?}", peer_id, hash, header);
} else { } else {
trace!(target: "sync", "Downloading new stale block announced from {}: {} {:?}", peer_id, hash, header); trace!(target: "sync", "Downloading new stale block announced from {}: {} {:?}", peer_id, hash, header);
self.download_stale(io, protocol, peer_id, &hash); self.download_stale(protocol, peer_id, &hash);
} }
} else { } else {
trace!(target: "sync", "Downloading new block announced from {}: {} {:?}", peer_id, hash, header); trace!(target: "sync", "Downloading new block announced from {}: {} {:?}", peer_id, hash, header);
self.download_new(io, protocol, peer_id); self.download_new(protocol, peer_id);
} }
} else { } else {
trace!(target: "sync", "Known block announce from {}: {}", peer_id, hash); trace!(target: "sync", "Known block announce from {}: {}", peer_id, hash);
} }
} }
fn is_known_or_already_downloading(&self, protocol: &Protocol<B>, hash: &B::Hash) -> bool { fn is_known_or_already_downloading(&self, protocol: &mut Context<B>, hash: &B::Hash) -> bool {
self.peers.iter().any(|(_, p)| p.state == PeerSyncState::DownloadingStale(*hash)) self.peers.iter().any(|(_, p)| p.state == PeerSyncState::DownloadingStale(*hash))
|| protocol.chain().block_status(&BlockId::Hash(*hash)).ok().map_or(false, |s| s != BlockStatus::Unknown) || protocol.client().block_status(&BlockId::Hash(*hash)).ok().map_or(false, |s| s != BlockStatus::Unknown)
} }
pub fn peer_disconnected(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId) { pub(crate) fn peer_disconnected(&mut self, protocol: &mut Context<B>, peer_id: PeerId) {
self.blocks.clear_peer_download(peer_id); self.blocks.clear_peer_download(peer_id);
self.peers.remove(&peer_id); self.peers.remove(&peer_id);
self.maintain_sync(io, protocol); self.maintain_sync(protocol);
} }
pub fn restart(&mut self, io: &mut SyncIo, protocol: &Protocol<B>) { pub(crate) fn restart(&mut self, protocol: &mut Context<B>) {
self.blocks.clear(); self.blocks.clear();
let ids: Vec<PeerId> = self.peers.keys().map(|p| *p).collect(); let ids: Vec<PeerId> = self.peers.keys().map(|p| *p).collect();
for id in ids { for id in ids {
self.new_peer(io, protocol, id); self.new_peer(protocol, id);
} }
match protocol.chain().info() { match protocol.client().info() {
Ok(info) => { Ok(info) => {
self.best_queued_hash = info.best_queued_hash.unwrap_or(info.chain.best_hash); self.best_queued_hash = info.best_queued_hash.unwrap_or(info.chain.best_hash);
self.best_queued_number = info.best_queued_number.unwrap_or(info.chain.best_number); self.best_queued_number = info.best_queued_number.unwrap_or(info.chain.best_number);
@@ -398,13 +397,13 @@ impl<B: BlockT> ChainSync<B> where
} }
} }
pub fn clear(&mut self) { pub(crate) fn clear(&mut self) {
self.blocks.clear(); self.blocks.clear();
self.peers.clear(); self.peers.clear();
} }
// Download old block. // Download old block.
fn download_stale(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, hash: &B::Hash) { fn download_stale(&mut self, protocol: &mut Context<B>, peer_id: PeerId, hash: &B::Hash) {
if let Some(ref mut peer) = self.peers.get_mut(&peer_id) { if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
match peer.state { match peer.state {
PeerSyncState::Available => { PeerSyncState::Available => {
@@ -417,7 +416,7 @@ impl<B: BlockT> ChainSync<B> where
max: Some(1), max: Some(1),
}; };
peer.state = PeerSyncState::DownloadingStale(*hash); peer.state = PeerSyncState::DownloadingStale(*hash);
protocol.send_message(io, peer_id, GenericMessage::BlockRequest(request)); protocol.send_message(peer_id, GenericMessage::BlockRequest(request));
}, },
_ => (), _ => (),
} }
@@ -425,7 +424,7 @@ impl<B: BlockT> ChainSync<B> where
} }
// Issue a request for a peer to download new blocks, if any are available // Issue a request for a peer to download new blocks, if any are available
fn download_new(&mut self, io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId) { fn download_new(&mut self, protocol: &mut Context<B>, peer_id: PeerId) {
if let Some(ref mut peer) = self.peers.get_mut(&peer_id) { if let Some(ref mut peer) = self.peers.get_mut(&peer_id) {
trace!(target: "sync", "Considering new block download from {}, common block is {}, best is {:?}", peer_id, peer.common_number, peer.best_number); trace!(target: "sync", "Considering new block download from {}, common block is {}, best is {:?}", peer_id, peer.common_number, peer.best_number);
match peer.state { match peer.state {
@@ -441,7 +440,7 @@ impl<B: BlockT> ChainSync<B> where
max: Some((range.end - range.start) as u32), max: Some((range.end - range.start) as u32),
}; };
peer.state = PeerSyncState::DownloadingNew(range.start); peer.state = PeerSyncState::DownloadingNew(range.start);
protocol.send_message(io, peer_id, GenericMessage::BlockRequest(request)); protocol.send_message(peer_id, GenericMessage::BlockRequest(request));
} else { } else {
trace!(target: "sync", "Nothing to request"); trace!(target: "sync", "Nothing to request");
} }
@@ -451,7 +450,7 @@ impl<B: BlockT> ChainSync<B> where
} }
} }
fn request_ancestry(io: &mut SyncIo, protocol: &Protocol<B>, peer_id: PeerId, block: u64) { fn request_ancestry(protocol: &mut Context<B>, peer_id: PeerId, block: u64) {
trace!(target: "sync", "Requesting ancestry block #{} from {}", block, peer_id); trace!(target: "sync", "Requesting ancestry block #{} from {}", block, peer_id);
let request = message::generic::BlockRequest { let request = message::generic::BlockRequest {
id: 0, id: 0,
@@ -461,6 +460,6 @@ impl<B: BlockT> ChainSync<B> where
direction: message::Direction::Ascending, direction: message::Direction::Ascending,
max: Some(1), max: Some(1),
}; };
protocol.send_message(io, peer_id, GenericMessage::BlockRequest(request)); protocol.send_message(peer_id, GenericMessage::BlockRequest(request));
} }
} }
@@ -1,53 +0,0 @@
// Copyright 2017 Parity Technologies (UK) Ltd.
// This file is part of Polkadot.
// Polkadot is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Polkadot is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
use super::*;
use message::{Message, generic};
use futures::Stream;
use test_client::runtime::Block;
#[test]
fn bft_messages_include_those_sent_before_asking_for_stream() {
let mut config = ::config::ProtocolConfig::default();
config.roles = ::service::Role::VALIDATOR | ::service::Role::FULL;
let mut net = TestNet::new_with_config(2, config);
net.sync(); // necessary for handshaking
let peer = net.peer(0);
let mut io = TestIo::new(&peer.queue, None);
let bft_message = generic::BftMessage::Consensus(generic::SignedConsensusMessage::Vote(generic::SignedConsensusVote {
vote: generic::ConsensusVote::AdvanceRound(0),
sender: Default::default(),
signature: Default::default(),
}));
let parent_hash = peer.genesis_hash();
let localized = ::message::LocalizedBftMessage::<Block> {
message: bft_message,
parent_hash: parent_hash,
};
let message: Message<Block> = generic::Message::BftMessage(localized.clone());
let as_bytes = ::serde_json::to_vec(&message).unwrap();
peer.sync.handle_packet(&mut io, 1, &as_bytes[..]);
let stream = peer.sync.bft_messages(parent_hash);
assert_eq!(stream.wait().next(), Some(Ok(localized)));
}
+42 -29
View File
@@ -14,7 +14,6 @@
// You should have received a copy of the GNU General Public License // You should have received a copy of the GNU General Public License
// along with Polkadot. If not, see <http://www.gnu.org/licenses/>. // along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
mod consensus;
mod sync; mod sync;
use std::collections::{VecDeque, HashSet, HashMap}; use std::collections::{VecDeque, HashSet, HashMap};
@@ -26,7 +25,7 @@ use client::block_builder::BlockBuilder;
use runtime_primitives::traits::Block as BlockT; use runtime_primitives::traits::Block as BlockT;
use runtime_primitives::generic::BlockId; use runtime_primitives::generic::BlockId;
use io::SyncIo; use io::SyncIo;
use protocol::Protocol; use protocol::{Context, Protocol};
use config::ProtocolConfig; use config::ProtocolConfig;
use service::TransactionPool; use service::TransactionPool;
use network::{PeerId, SessionInfo, Error as NetworkError}; use network::{PeerId, SessionInfo, Error as NetworkError};
@@ -34,20 +33,39 @@ use keyring::Keyring;
use codec::Slicable; use codec::Slicable;
use test_client::{self, TestClient}; use test_client::{self, TestClient};
use test_client::runtime::{Block, Hash, Transfer, Extrinsic}; use test_client::runtime::{Block, Hash, Transfer, Extrinsic};
use specialization::Specialization;
pub struct DummySpecialization;
impl Specialization<Block> for DummySpecialization {
fn status(&self) -> Vec<u8> { vec![] }
fn on_connect(&mut self, _ctx: &mut Context<Block>, _peer_id: PeerId, _status: ::message::Status<Block>) {
}
fn on_disconnect(&mut self, _ctx: &mut Context<Block>, _peer_id: PeerId) {
}
fn on_message(&mut self, _ctx: &mut Context<Block>, _peer_id: PeerId, _message: ::message::Message<Block>) {
}
}
pub struct TestIo<'p> { pub struct TestIo<'p> {
pub queue: &'p RwLock<VecDeque<TestPacket>>, queue: &'p RwLock<VecDeque<TestPacket>>,
pub sender: Option<PeerId>,
pub to_disconnect: HashSet<PeerId>, pub to_disconnect: HashSet<PeerId>,
pub packets: Vec<TestPacket>, packets: Vec<TestPacket>,
pub peers_info: HashMap<PeerId, String>, peers_info: HashMap<PeerId, String>,
_sender: Option<PeerId>,
} }
impl<'p> TestIo<'p> where { impl<'p> TestIo<'p> where {
pub fn new(queue: &'p RwLock<VecDeque<TestPacket>>, sender: Option<PeerId>) -> TestIo<'p> { pub fn new(queue: &'p RwLock<VecDeque<TestPacket>>, sender: Option<PeerId>) -> TestIo<'p> {
TestIo { TestIo {
queue: queue, queue: queue,
sender: sender, _sender: sender,
to_disconnect: HashSet::new(), to_disconnect: HashSet::new(),
packets: Vec::new(), packets: Vec::new(),
peers_info: HashMap::new(), peers_info: HashMap::new(),
@@ -95,13 +113,13 @@ impl<'p> SyncIo for TestIo<'p> {
/// Mocked subprotocol packet /// Mocked subprotocol packet
pub struct TestPacket { pub struct TestPacket {
pub data: Vec<u8>, data: Vec<u8>,
pub recipient: PeerId, recipient: PeerId,
} }
pub struct Peer { pub struct Peer {
client: Arc<client::Client<test_client::Backend, test_client::Executor, Block>>, client: Arc<client::Client<test_client::Backend, test_client::Executor, Block>>,
pub sync: Protocol<Block>, pub sync: Protocol<Block, DummySpecialization>,
pub queue: RwLock<VecDeque<TestPacket>>, pub queue: RwLock<VecDeque<TestPacket>>,
} }
@@ -186,14 +204,9 @@ impl Peer {
self.generate_blocks(count, |_| ()); self.generate_blocks(count, |_| ());
} }
} }
pub fn genesis_hash(&self) -> Hash {
let info = self.client.info().expect("In-mem client does not fail");
info.chain.genesis_hash
}
} }
struct EmptyTransactionPool; pub struct EmptyTransactionPool;
impl TransactionPool<Block> for EmptyTransactionPool { impl TransactionPool<Block> for EmptyTransactionPool {
fn transactions(&self) -> Vec<(Hash, Extrinsic)> { fn transactions(&self) -> Vec<(Hash, Extrinsic)> {
@@ -208,17 +221,17 @@ impl TransactionPool<Block> for EmptyTransactionPool {
} }
pub struct TestNet { pub struct TestNet {
pub peers: Vec<Arc<Peer>>, peers: Vec<Arc<Peer>>,
pub started: bool, started: bool,
pub disconnect_events: Vec<(PeerId, PeerId)>, //disconnected (initiated by, to) disconnect_events: Vec<(PeerId, PeerId)>, //disconnected (initiated by, to)
} }
impl TestNet { impl TestNet {
pub fn new(n: usize) -> Self { fn new(n: usize) -> Self {
Self::new_with_config(n, ProtocolConfig::default()) Self::new_with_config(n, ProtocolConfig::default())
} }
pub fn new_with_config(n: usize, config: ProtocolConfig) -> Self { fn new_with_config(n: usize, config: ProtocolConfig) -> Self {
let mut net = TestNet { let mut net = TestNet {
peers: Vec::new(), peers: Vec::new(),
started: false, started: false,
@@ -234,7 +247,7 @@ impl TestNet {
pub fn add_peer(&mut self, config: &ProtocolConfig) { pub fn add_peer(&mut self, config: &ProtocolConfig) {
let client = Arc::new(test_client::new()); let client = Arc::new(test_client::new());
let tx_pool = Arc::new(EmptyTransactionPool); let tx_pool = Arc::new(EmptyTransactionPool);
let sync = Protocol::new(config.clone(), client.clone(), None, tx_pool).unwrap(); let sync = Protocol::new(config.clone(), client.clone(), None, tx_pool, DummySpecialization).unwrap();
self.peers.push(Arc::new(Peer { self.peers.push(Arc::new(Peer {
sync: sync, sync: sync,
client: client, client: client,
@@ -246,7 +259,7 @@ impl TestNet {
&self.peers[i] &self.peers[i]
} }
pub fn start(&mut self) { fn start(&mut self) {
if self.started { if self.started {
return; return;
} }
@@ -261,7 +274,7 @@ impl TestNet {
self.started = true; self.started = true;
} }
pub fn sync_step(&mut self) { fn sync_step(&mut self) {
for peer in 0..self.peers.len() { for peer in 0..self.peers.len() {
let packet = self.peers[peer].pending_message(); let packet = self.peers[peer].pending_message();
if let Some(packet) = packet { if let Some(packet) = packet {
@@ -286,15 +299,15 @@ impl TestNet {
} }
} }
pub fn sync_step_peer(&mut self, peer_num: usize) { fn sync_step_peer(&mut self, peer_num: usize) {
self.peers[peer_num].sync_step(); self.peers[peer_num].sync_step();
} }
pub fn restart_peer(&mut self, i: usize) { fn restart_peer(&mut self, i: usize) {
self.peers[i].restart_sync(); self.peers[i].restart_sync();
} }
pub fn sync(&mut self) -> u32 { fn sync(&mut self) -> u32 {
self.start(); self.start();
let mut total_steps = 0; let mut total_steps = 0;
while !self.done() { while !self.done() {
@@ -304,14 +317,14 @@ impl TestNet {
total_steps total_steps
} }
pub fn sync_steps(&mut self, count: usize) { fn sync_steps(&mut self, count: usize) {
self.start(); self.start();
for _ in 0..count { for _ in 0..count {
self.sync_step(); self.sync_step();
} }
} }
pub fn done(&self) -> bool { fn done(&self) -> bool {
self.peers.iter().all(|p| p.is_done()) self.peers.iter().all(|p| p.is_done())
} }
} }
@@ -26,6 +26,7 @@ pub struct AuthorityId(pub [u8; 32]);
impl AuthorityId { impl AuthorityId {
/// Create an id from a 32-byte slice. Panics with other lengths. /// Create an id from a 32-byte slice. Panics with other lengths.
#[cfg(feature = "std")]
fn from_slice(data: &[u8]) -> Self { fn from_slice(data: &[u8]) -> Self {
let mut r = [0u8; 32]; let mut r = [0u8; 32];
r.copy_from_slice(data); r.copy_from_slice(data);
+1 -1
View File
@@ -17,7 +17,7 @@ substrate-extrinsic-pool = { path = "../extrinsic-pool" }
substrate-primitives = { path = "../primitives" } substrate-primitives = { path = "../primitives" }
substrate-runtime-primitives = { path = "../runtime/primitives" } substrate-runtime-primitives = { path = "../runtime/primitives" }
substrate-state-machine = { path = "../state-machine" } substrate-state-machine = { path = "../state-machine" }
tokio-core = "0.1.12" tokio = "0.1.7"
[dev-dependencies] [dev-dependencies]
assert_matches = "1.1" assert_matches = "1.1"
+3 -3
View File
@@ -27,7 +27,7 @@ use jsonrpc_macros::pubsub;
use jsonrpc_pubsub::SubscriptionId; use jsonrpc_pubsub::SubscriptionId;
use rpc::Result as RpcResult; use rpc::Result as RpcResult;
use rpc::futures::{Future, Sink, Stream}; use rpc::futures::{Future, Sink, Stream};
use tokio_core::reactor::Remote; use tokio::runtime::TaskExecutor;
use subscriptions::Subscriptions; use subscriptions::Subscriptions;
@@ -72,10 +72,10 @@ pub struct Chain<B, E, Block: BlockT> {
impl<B, E, Block: BlockT> Chain<B, E, Block> { impl<B, E, Block: BlockT> Chain<B, E, Block> {
/// Create new Chain API RPC handler. /// Create new Chain API RPC handler.
pub fn new(client: Arc<Client<B, E, Block>>, remote: Remote) -> Self { pub fn new(client: Arc<Client<B, E, Block>>, executor: TaskExecutor) -> Self {
Chain { Chain {
client, client,
subscriptions: Subscriptions::new(remote), subscriptions: Subscriptions::new(executor),
} }
} }
} }
+7 -7
View File
@@ -22,8 +22,8 @@ use test_client::runtime::Header;
#[test] #[test]
fn should_return_header() { fn should_return_header() {
let core = ::tokio_core::reactor::Core::new().unwrap(); let core = ::tokio::runtime::Runtime::new().unwrap();
let remote = core.remote(); let remote = core.executor();
let client = Chain { let client = Chain {
client: Arc::new(test_client::new()), client: Arc::new(test_client::new()),
@@ -48,8 +48,8 @@ fn should_return_header() {
#[test] #[test]
fn should_notify_about_latest_block() { fn should_notify_about_latest_block() {
let mut core = ::tokio_core::reactor::Core::new().unwrap(); let mut core = ::tokio::runtime::Runtime::new().unwrap();
let remote = core.remote(); let remote = core.executor();
let (subscriber, id, transport) = pubsub::Subscriber::new_test("test"); let (subscriber, id, transport) = pubsub::Subscriber::new_test("test");
{ {
@@ -61,17 +61,17 @@ fn should_notify_about_latest_block() {
api.subscribe_new_head(Default::default(), subscriber); api.subscribe_new_head(Default::default(), subscriber);
// assert id assigned // assert id assigned
assert_eq!(core.run(id), Ok(Ok(SubscriptionId::Number(0)))); assert_eq!(core.block_on(id), Ok(Ok(SubscriptionId::Number(0))));
let builder = api.client.new_block().unwrap(); let builder = api.client.new_block().unwrap();
api.client.justify_and_import(BlockOrigin::Own, builder.bake().unwrap()).unwrap(); api.client.justify_and_import(BlockOrigin::Own, builder.bake().unwrap()).unwrap();
} }
// assert notification send to transport // assert notification send to transport
let (notification, next) = core.run(transport.into_future()).unwrap(); let (notification, next) = core.block_on(transport.into_future()).unwrap();
assert_eq!(notification, Some( assert_eq!(notification, Some(
r#"{"jsonrpc":"2.0","method":"test","params":{"result":{"digest":{"logs":[]},"extrinsicsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","number":1,"parentHash":"0x50fb1e7f32e8ad17f553846f4338861e17eb95132e7c3b433e0429ffab2f8f13","stateRoot":"0x17dccc74bd9200b7ce5a2f6a1bf379f1cdcf91bca3d19c3d17e1478b8d404703"},"subscription":0}}"#.to_owned() r#"{"jsonrpc":"2.0","method":"test","params":{"result":{"digest":{"logs":[]},"extrinsicsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","number":1,"parentHash":"0x50fb1e7f32e8ad17f553846f4338861e17eb95132e7c3b433e0429ffab2f8f13","stateRoot":"0x17dccc74bd9200b7ce5a2f6a1bf379f1cdcf91bca3d19c3d17e1478b8d404703"},"subscription":0}}"#.to_owned()
)); ));
// no more notifications on this channel // no more notifications on this channel
assert_eq!(core.run(next.into_future()).unwrap().0, None); assert_eq!(core.block_on(next.into_future()).unwrap().0, None);
} }
+1 -1
View File
@@ -27,7 +27,7 @@ extern crate substrate_extrinsic_pool as extrinsic_pool;
extern crate substrate_primitives as primitives; extern crate substrate_primitives as primitives;
extern crate substrate_runtime_primitives as runtime_primitives; extern crate substrate_runtime_primitives as runtime_primitives;
extern crate substrate_state_machine as state_machine; extern crate substrate_state_machine as state_machine;
extern crate tokio_core; extern crate tokio;
#[macro_use] #[macro_use]
extern crate error_chain; extern crate error_chain;
+6 -7
View File
@@ -22,7 +22,7 @@ use jsonrpc_pubsub::SubscriptionId;
use parking_lot::Mutex; use parking_lot::Mutex;
use rpc::futures::sync::oneshot; use rpc::futures::sync::oneshot;
use rpc::futures::{Future, future}; use rpc::futures::{Future, future};
use tokio_core::reactor::Remote; use tokio::runtime::TaskExecutor;
type Id = u64; type Id = u64;
@@ -34,16 +34,16 @@ type Id = u64;
pub struct Subscriptions { pub struct Subscriptions {
next_id: AtomicUsize, next_id: AtomicUsize,
active_subscriptions: Mutex<HashMap<Id, oneshot::Sender<()>>>, active_subscriptions: Mutex<HashMap<Id, oneshot::Sender<()>>>,
event_loop: Remote, executor: TaskExecutor,
} }
impl Subscriptions { impl Subscriptions {
/// Creates new `Subscriptions` object. /// Creates new `Subscriptions` object.
pub fn new(event_loop: Remote) -> Self { pub fn new(executor: TaskExecutor) -> Self {
Subscriptions { Subscriptions {
next_id: Default::default(), next_id: Default::default(),
active_subscriptions: Default::default(), active_subscriptions: Default::default(),
event_loop, executor,
} }
} }
@@ -63,11 +63,10 @@ impl Subscriptions {
let future = into_future(sink) let future = into_future(sink)
.into_future() .into_future()
.select(rx.map_err(|e| warn!("Error timeing out: {:?}", e))) .select(rx.map_err(|e| warn!("Error timeing out: {:?}", e)))
.map(|_| ()) .then(|_| Ok(()));
.map_err(|_| ());
self.active_subscriptions.lock().insert(id, tx); self.active_subscriptions.lock().insert(id, tx);
self.event_loop.spawn(|_| future); self.executor.spawn(future);
} }
} }
@@ -32,11 +32,15 @@ pub trait Lazy<T: ?Sized> {
fn get(&mut self) -> &T; fn get(&mut self) -> &T;
} }
impl<'a> Lazy<[u8]> for &'a [u8] {
fn get(&mut self) -> &[u8] { &**self }
}
/// Means of signature verification. /// Means of signature verification.
pub trait Verify { pub trait Verify {
/// Type of the signer. /// Type of the signer.
type Signer; type Signer;
/// Verify a signature. /// Verify a signature. Return `true` if signature is valid for the value.
fn verify<L: Lazy<[u8]>>(&self, msg: L, signer: &Self::Signer) -> bool; fn verify<L: Lazy<[u8]>>(&self, msg: L, signer: &Self::Signer) -> bool;
} }