1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
// Copyright 2018-2019 Parity Technologies (UK) Ltd
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! A voter in GRANDPA. This transitions between rounds and casts votes.
//!
//! Voters rely on some external context to function:
//!   - setting timers to cast votes.
//!   - incoming vote streams.
//!   - providing voter weights.
//!   - getting the local voter id.
//!
//!  The local voter id is used to check whether to cast votes for a given
//!  round. If no local id is defined or if it's not part of the voter set then
//!  votes will not be pushed to the sink. The protocol state machine still
//!  transitions state as if the votes had been pushed out.

use futures::{prelude::*, ready};
use futures::channel::mpsc::{self, UnboundedReceiver};
#[cfg(feature = "std")]
use log::trace;

use parking_lot::RwLock;

use std::collections::VecDeque;
use std::pin::Pin;
use std::sync::Arc;
use std::task::{Context, Poll};
use std::hash::Hash;

use crate::round::State as RoundState;
use crate::{
	CatchUp, Chain, Commit, CompactCommit, Equivocation, Message, Prevote, Precommit,
	PrimaryPropose, SignedMessage, BlockNumberOps, validate_commit, CommitValidationResult,
	HistoricalVotes,
};
use crate::voter_set::VoterSet;
use crate::weights::VoteWeight;
use past_rounds::PastRounds;
use voting_round::{VotingRound, State as VotingRoundState};

mod past_rounds;
mod voting_round;

/// Necessary environment for a voter.
///
/// This encapsulates the database and networking layers of the chain.
pub trait Environment<H: Eq, N: BlockNumberOps>: Chain<H, N> {
	/// Associated timer for the Environment. See also
	/// [round_commit_data](trait.Environment.html#tymethod.round_commit_timer).
	type Timer: Future<Output=Result<(),Self::Error>> + Unpin;
	/// The associated Id for the Environment.
	type Id: Ord + Clone + Eq + ::std::fmt::Debug;
	/// The associated Signature type for the Environment.
	type Signature: Eq + Clone;
	/// The input stream used to communicate with the outside world.
	type In: Stream<Item=Result<SignedMessage<H, N, Self::Signature, Self::Id>, Self::Error>> + Unpin;
	/// The output stream used to communicate with the outside world.
	type Out: Sink<Message<H, N>, Error=Self::Error> + Unpin;
	/// The associated Error type.
	type Error: From<crate::Error> + ::std::error::Error;

	/// Produce data necessary to start a round of voting. This may also be called
	/// with the round number of the most recently completed round, in which case
	/// it should yield a valid input stream.
	///
	/// The input stream should provide messages which correspond to known blocks
	/// only.
	///
	/// The voting logic will push unsigned messages over-eagerly into the
	/// output stream. It is the job of this stream to determine if those messages
	/// should be sent (for example, if the process actually controls a permissioned key)
	/// and then to sign the message, multicast it to peers, and schedule it to be
	/// returned by the `In` stream.
	///
	/// This allows the voting logic to maintain the invariant that only incoming messages
	/// may alter the state, and the logic remains the same regardless of whether a node
	/// is a regular voter, the proposer, or simply an observer.
	///
	/// Furthermore, this means that actual logic of creating and verifying
	/// signatures is flexible and can be maintained outside this crate.
	fn round_data(&self, round: u64) -> RoundData<
		Self::Id,
		Self::Timer,
		Self::In,
		Self::Out,
	>;

	/// Return a timer that will be used to delay the broadcast of a commit
	/// message. This delay should not be static to minimize the amount of
	/// commit messages that are sent (e.g. random value in [0, 1] seconds).
	fn round_commit_timer(&self) -> Self::Timer;

	/// Note that we've done a primary proposal in the given round.
	fn proposed(&self, round: u64, propose: PrimaryPropose<H, N>) -> Result<(), Self::Error>;

	/// Note that we have prevoted in the given round.
	fn prevoted(&self, round: u64, prevote: Prevote<H, N>) -> Result<(), Self::Error>;

	/// Note that we have precommitted in the given round.
	fn precommitted(&self, round: u64, precommit: Precommit<H, N>) -> Result<(), Self::Error>;

	/// Note that a round is completed. This is called when a round has been
	/// voted in and the next round can start. The round may continue to be run
	/// in the background until _concluded_.
	/// Should return an error when something fatal occurs.
	fn completed(
		&self,
		round: u64,
		state: RoundState<H, N>,
		base: (H, N),
		votes: &HistoricalVotes<H, N, Self::Signature, Self::Id>,
	) -> Result<(), Self::Error>;

	/// Note that a round has concluded. This is called when a round has been
	/// `completed` and additionally, the round's estimate has been finalized.
	///
	/// There may be more votes than when `completed`, and it is the responsibility
	/// of the `Environment` implementation to deduplicate. However, the caller guarantees
	/// that the votes passed to `completed` for this round are a prefix of the votes passed here.
	fn concluded(
		&self,
		round: u64,
		state: RoundState<H, N>,
		base: (H, N),
		votes: &HistoricalVotes<H, N, Self::Signature, Self::Id>,
	) -> Result<(), Self::Error>;

	/// Called when a block should be finalized.
	// TODO: make this a future that resolves when it's e.g. written to disk?
	fn finalize_block(&self, hash: H, number: N, round: u64, commit: Commit<H, N, Self::Signature, Self::Id>) -> Result<(), Self::Error>;

	/// Note that an equivocation in prevotes has occurred.
	fn prevote_equivocation(&self, round: u64, equivocation: Equivocation<Self::Id, Prevote<H, N>, Self::Signature>);
	/// Note that an equivocation in precommits has occurred.
	fn precommit_equivocation(&self, round: u64, equivocation: Equivocation<Self::Id, Precommit<H, N>, Self::Signature>);
}

/// Communication between nodes that is not round-localized.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CommunicationOut<H, N, S, Id> {
	/// A commit message.
	Commit(u64, Commit<H, N, S, Id>),
}

/// The outcome of processing a commit.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CommitProcessingOutcome {
	/// It was beneficial to process this commit.
	Good(GoodCommit),
	/// It wasn't beneficial to process this commit. We wasted resources.
	Bad(BadCommit),
}

#[cfg(any(test, feature = "test-helpers"))]
impl CommitProcessingOutcome {
	/// Returns a `Good` instance of commit processing outcome's opaque type. Useful for testing.
	pub fn good() -> CommitProcessingOutcome {
		CommitProcessingOutcome::Good(GoodCommit::new())
	}

	/// Returns a `Bad` instance of commit processing outcome's opaque type. Useful for testing.
	pub fn bad() -> CommitProcessingOutcome {
		CommitProcessingOutcome::Bad(CommitValidationResult::<(), ()>::default().into())
	}
}

/// The result of processing for a good commit.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct GoodCommit {
	_priv: (), // lets us add stuff without breaking API.
}

impl GoodCommit {
	pub(crate) fn new() -> Self {
		GoodCommit { _priv: () }
	}
}

/// The result of processing for a bad commit
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BadCommit {
	_priv: (), // lets us add stuff without breaking API.
	num_precommits: usize,
	num_duplicated_precommits: usize,
	num_equivocations: usize,
	num_invalid_voters: usize,
}

impl BadCommit {
	/// Get the number of precommits
	pub fn num_precommits(&self) -> usize {
		self.num_precommits
	}

	/// Get the number of duplicated precommits
	pub fn num_duplicated(&self) -> usize {
		self.num_duplicated_precommits
	}

	/// Get the number of equivocations in the precommits
	pub fn num_equivocations(&self) -> usize {
		self.num_equivocations
	}

	/// Get the number of invalid voters in the precommits
	pub fn num_invalid_voters(&self) -> usize {
		self.num_invalid_voters
	}
}

impl<H, N> From<CommitValidationResult<H, N>> for BadCommit {
	fn from(r: CommitValidationResult<H, N>) -> Self {
		BadCommit {
			num_precommits: r.num_precommits,
			num_duplicated_precommits: r.num_duplicated_precommits,
			num_equivocations: r.num_equivocations,
			num_invalid_voters: r.num_invalid_voters,
			_priv: (),
		}
	}
}

/// The outcome of processing a catch up.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum CatchUpProcessingOutcome {
	/// It was beneficial to process this catch up.
	Good(GoodCatchUp),
	/// It wasn't beneficial to process this catch up, it is invalid and we
	/// wasted resources.
	Bad(BadCatchUp),
	/// The catch up wasn't processed because it is useless, e.g. it is for a
	/// round lower than we're currently in.
	Useless,
}

#[cfg(any(test, feature = "test-helpers"))]
impl CatchUpProcessingOutcome {
	/// Returns a `Bad` instance of catch up processing outcome's opaque type. Useful for testing.
	pub fn bad() -> CatchUpProcessingOutcome {
		CatchUpProcessingOutcome::Bad(BadCatchUp::new())
	}

	/// Returns a `Good` instance of catch up processing outcome's opaque type. Useful for testing.
	pub fn good() -> CatchUpProcessingOutcome {
		CatchUpProcessingOutcome::Good(GoodCatchUp::new())
	}
}

/// The result of processing for a good catch up.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct GoodCatchUp {
	_priv: (), // lets us add stuff without breaking API.
}

impl GoodCatchUp {
	pub(crate) fn new() -> Self {
		GoodCatchUp { _priv: () }
	}
}

/// The result of processing for a bad catch up.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct BadCatchUp {
	_priv: (), // lets us add stuff without breaking API.
}

impl BadCatchUp {
	pub(crate) fn new() -> Self {
		BadCatchUp { _priv: () }
	}
}

/// Callback used to pass information about the outcome of importing a given
/// message (e.g. vote, commit, catch up). Useful to propagate data to the
/// network after making sure the import is successful.
pub enum Callback<O> {
	/// Default value.
	Blank,
	/// Callback to execute given a processing outcome.
	Work(Box<dyn FnMut(O) + Send>),
}

#[cfg(any(test, feature = "test-helpers"))]
impl<O> Clone for Callback<O> {
	fn clone(&self) -> Self {
		Callback::Blank
	}
}

impl<O> Callback<O> {
	/// Do the work associated with the callback, if any.
	pub fn run(&mut self, o: O) {
		match self {
			Callback::Blank => {},
			Callback::Work(cb) => cb(o),
		}
	}
}

/// Communication between nodes that is not round-localized.
#[cfg_attr(any(test, feature = "test-helpers"), derive(Clone))]
pub enum CommunicationIn<H, N, S, Id> {
	/// A commit message.
	Commit(u64, CompactCommit<H, N, S, Id>, Callback<CommitProcessingOutcome>),
	/// A catch up message.
	CatchUp(CatchUp<H, N, S, Id>, Callback<CatchUpProcessingOutcome>),
}

impl<H, N, S, Id> Unpin for CommunicationIn<H, N, S, Id> {}

/// Data necessary to participate in a round.
pub struct RoundData<Id, Timer, Input, Output> {
	/// Local voter id (if any.)
	pub voter_id: Option<Id>,
	/// Timer before prevotes can be cast. This should be Start + 2T
	/// where T is the gossip time estimate.
	pub prevote_timer: Timer,
	/// Timer before precommits can be cast. This should be Start + 4T
	pub precommit_timer: Timer,
	/// Incoming messages.
	pub incoming: Input,
	/// Outgoing messages.
	pub outgoing: Output,
}

struct Buffered<S, I> {
	inner: S,
	buffer: VecDeque<I>,
}

impl<S: Sink<I> + Unpin, I> Buffered<S, I> {
	fn new(inner: S) -> Buffered<S, I> {
		Buffered {
			buffer: VecDeque::new(),
			inner
		}
	}

	// push an item into the buffered sink.
	// the sink _must_ be driven to completion with `poll` afterwards.
	fn push(&mut self, item: I) {
		self.buffer.push_back(item);
	}

	// returns ready when the sink and the buffer are completely flushed.
	fn poll(&mut self, cx: &mut Context) -> Poll<Result<(), S::Error>> {
		let polled = self.schedule_all(cx)?;

		match polled {
			Poll::Ready(()) => Sink::poll_flush(Pin::new(&mut self.inner), cx),
			Poll::Pending => {
				ready!(Sink::poll_flush(Pin::new(&mut self.inner), cx))?;
				Poll::Pending
			}
		}
	}

	fn schedule_all(&mut self, cx: &mut Context) -> Poll<Result<(), S::Error>> {
		while !self.buffer.is_empty() {
			ready!(Sink::poll_ready(Pin::new(&mut self.inner), cx))?;

			let item = self.buffer.pop_front()
				.expect("we checked self.buffer.is_empty() just above; qed");
			Sink::start_send(Pin::new(&mut self.inner), item)?;
		}

		Poll::Ready(Ok(()))
	}
}

type FinalizedNotification<H, N, E> = (
	H,
	N,
	u64,
	Commit<H, N, <E as Environment<H, N>>::Signature, <E as Environment<H, N>>::Id>,
);

// Instantiates the given last round, to be backgrounded until its estimate is finalized.
//
// This round must be completable based on the passed votes (and if not, `None` will be returned),
// but it may be the case that there are some more votes to propagate in order to push
// the estimate backwards and conclude the round (i.e. finalize its estimate).
//
// may only be called with non-zero last round.
fn instantiate_last_round<H, N, E: Environment<H, N>>(
	voters: VoterSet<E::Id>,
	last_round_votes: Vec<SignedMessage<H, N, E::Signature, E::Id>>,
	last_round_number: u64,
	last_round_base: (H, N),
	finalized_sender: mpsc::UnboundedSender<FinalizedNotification<H, N, E>>,
	env: Arc<E>,
) -> Option<VotingRound<H, N, E>> where
	H: Clone + Eq + Ord + ::std::fmt::Debug,
	N: Copy + BlockNumberOps + ::std::fmt::Debug,
{
	let last_round_tracker = crate::round::Round::new(crate::round::RoundParams {
		voters,
		base: last_round_base,
		round_number: last_round_number,
	});

	// start as completed so we don't cast votes.
	let mut last_round = VotingRound::completed(
		last_round_tracker,
		finalized_sender,
		None,
		env,
	);

	for vote in last_round_votes {
		// bail if any votes are bad.
		last_round.handle_vote(vote).ok()?;
	}

	if last_round.round_state().completable {
		Some(last_round)
	} else {
		None
	}
}

// The inner state of a voter aggregating the currently running round state
// (i.e. best and background rounds). This state exists separately since it's
// useful to wrap in a `Arc<RwLock<_>>` for sharing.
struct InnerVoterState<H, N, E> where
	H: Clone + Ord + std::fmt::Debug,
	N: BlockNumberOps,
	E: Environment<H, N>,
{
	best_round: VotingRound<H, N, E>,
	past_rounds: PastRounds<H, N, E>,
}

/// A future that maintains and multiplexes between different rounds,
/// and caches votes.
///
/// This voter also implements the commit protocol.
/// The commit protocol allows a node to broadcast a message that finalizes a
/// given block and includes a set of precommits as proof.
///
/// - When a round is completable and we precommitted we start a commit timer
/// and start accepting commit messages;
/// - When we receive a commit message if it targets a block higher than what
/// we've finalized we validate it and import its precommits if valid;
/// - When our commit timer triggers we check if we've received any commit
/// message for a block equal to what we've finalized, if we haven't then we
/// broadcast a commit.
///
/// Additionally, we also listen to commit messages from rounds that aren't
/// currently running, we validate the commit and dispatch a finalization
/// notification (if any) to the environment.
pub struct Voter<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> where
	H: Clone + Eq + Ord + ::std::fmt::Debug,
	N: Copy + BlockNumberOps + ::std::fmt::Debug,
	GlobalIn: Stream<Item=Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
	GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error=E::Error> + Unpin,
{
	env: Arc<E>,
	voters: VoterSet<E::Id>,
	inner: Arc<RwLock<InnerVoterState<H, N, E>>>,
	finalized_notifications: UnboundedReceiver<FinalizedNotification<H, N, E>>,
	last_finalized_number: N,
	global_in: GlobalIn,
	global_out: Buffered<GlobalOut, CommunicationOut<H, N, E::Signature, E::Id>>,
	// the commit protocol might finalize further than the current round (if we're
	// behind), we keep track of last finalized in round so we don't violate any
	// assumptions from round-to-round.
	last_finalized_in_rounds: (H, N),
}

impl<'a, H: 'a, N, E: 'a, GlobalIn, GlobalOut> Voter<H, N, E, GlobalIn, GlobalOut> where
	H: Clone + Ord + ::std::fmt::Debug + Sync + Send,
	N: BlockNumberOps + Sync + Send,
	E: Environment<H, N> + Sync + Send,
	GlobalIn: Stream<Item=Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
	GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error=E::Error> + Unpin,
{
	/// Returns an object allowing to query the voter state.
	pub fn voter_state(&self) -> Box<dyn VoterState<E::Id> + 'a + Send + Sync>
	where
		<E as Environment<H, N>>::Signature: Send + Sync,
		<E as Environment<H, N>>::Id: Hash + Send + Sync,
		<E as Environment<H, N>>::Timer: Send + Sync,
		<E as Environment<H, N>>::Out: Send + Sync,
		<E as Environment<H, N>>::In: Send + Sync,
	{
		Box::new(SharedVoterState(self.inner.clone()))
	}
}

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Voter<H, N, E, GlobalIn, GlobalOut> where
	H: Clone + Eq + Ord + ::std::fmt::Debug,
	N: Copy + BlockNumberOps + ::std::fmt::Debug,
	GlobalIn: Stream<Item=Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
	GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error=E::Error> + Unpin,
{
	/// Create new `Voter` tracker with given round number and base block.
	///
	/// Provide data about the last completed round. If there is no
	/// known last completed round, the genesis state (round number 0, no votes, genesis base),
	/// should be provided. When available, all messages required to complete
	/// the last round should be provided.
	///
	/// The input stream for commit messages should provide commits which
	/// correspond to known blocks only (including all its precommits). It
	/// is also responsible for validating the signature data in commit
	/// messages.
	pub fn new(
		env: Arc<E>,
		voters: VoterSet<E::Id>,
		global_comms: (GlobalIn, GlobalOut),
		last_round_number: u64,
		last_round_votes: Vec<SignedMessage<H, N, E::Signature, E::Id>>,
		last_round_base: (H, N),
		last_finalized: (H, N),
	) -> Self {
		let (finalized_sender, finalized_notifications) = mpsc::unbounded();
		let last_finalized_number = last_finalized.1;

		// re-start the last round and queue all messages to be processed on first poll.
		// keep it in the background so we can push the estimate backwards until finalized
		// by actually waiting for more messages.
		let mut past_rounds = PastRounds::new();
		let mut last_round_state = crate::bridge_state::bridge_state(RoundState::genesis(last_round_base.clone())).1;

		if last_round_number > 0 {
			let maybe_completed_last_round = instantiate_last_round(
				voters.clone(),
				last_round_votes,
				last_round_number,
				last_round_base,
				finalized_sender.clone(),
				env.clone(),
			);

			if let Some(mut last_round) = maybe_completed_last_round {
				last_round_state = last_round.bridge_state();
				past_rounds.push(&*env, last_round);
			}

			// when there is no information about the last completed round,
			// the best we can do is assume that the estimate == the given base
			// and that it is finalized. This is always the case for the genesis
			// round of a set.
		}

		let best_round = VotingRound::new(
			last_round_number + 1,
			voters.clone(),
			last_finalized.clone(),
			Some(last_round_state),
			finalized_sender,
			env.clone(),
		);

		let (global_in, global_out) = global_comms;

		let inner = Arc::new(RwLock::new(InnerVoterState {
			best_round,
			past_rounds,
		}));

		Voter {
			env,
			voters,
			inner,
			finalized_notifications,
			last_finalized_number,
			last_finalized_in_rounds: last_finalized,
			global_in,
			global_out: Buffered::new(global_out),
		}
	}

	fn prune_background_rounds(&mut self, cx: &mut Context) -> Result<(), E::Error> {
		{
			let mut inner = self.inner.write();

			// Do work on all background rounds, broadcasting any commits generated.
			while let Poll::Ready(Some(item)) = Stream::poll_next(Pin::new(&mut inner.past_rounds), cx) {
				let (number, commit) = item?;
				self.global_out.push(CommunicationOut::Commit(number, commit));
			}
		}

		while let Poll::Ready(res) = Stream::poll_next(Pin::new(&mut self.finalized_notifications), cx) {
			let inner = self.inner.clone();
			let mut inner = inner.write();

			let (f_hash, f_num, round, commit) =
				res.expect("one sender always kept alive in self.best_round; qed");

			inner.past_rounds.update_finalized(f_num);

			if self.set_last_finalized_number(f_num) {
				self.env.finalize_block(f_hash.clone(), f_num, round, commit)?;
			}

			if f_num > self.last_finalized_in_rounds.1 {
				self.last_finalized_in_rounds = (f_hash, f_num);
			}
		}

		Ok(())
	}

	/// Process all incoming messages from other nodes.
	///
	/// Commit messages are handled with extra care. If a commit message references
	/// a currently backgrounded round, we send it to that round so that when we commit
	/// on that round, our commit message will be informed by those that we've seen.
	///
	/// Otherwise, we will simply handle the commit and issue a finalization command
	/// to the environment.
	fn process_incoming(&mut self, cx: &mut Context) -> Result<(), E::Error> {
		while let Poll::Ready(Some(item)) = Stream::poll_next(Pin::new(&mut self.global_in), cx) {
			match item? {
				CommunicationIn::Commit(round_number, commit, mut process_commit_outcome) => {
					trace!(target: "afg", "Got commit for round_number {:?}: target_number: {:?}, target_hash: {:?}",
						round_number,
						commit.target_number,
						commit.target_hash,
					);

					let commit: Commit<_, _, _, _> = commit.into();

					let mut inner = self.inner.write();

					// if the commit is for a background round dispatch to round committer.
					// that returns Some if there wasn't one.
					if let Some(commit) = inner.past_rounds.import_commit(round_number, commit) {
						// otherwise validate the commit and signal the finalized block
						// (if any) to the environment
						let validation_result = validate_commit(&commit, &self.voters, &*self.env)?;

						if let Some((finalized_hash, finalized_number)) = validation_result.ghost {
							// this can't be moved to a function because the compiler
							// will complain about getting two mutable borrows to self
							// (due to the call to `self.rounds.get_mut`).
							let last_finalized_number = &mut self.last_finalized_number;

							// clean up any background rounds
							inner.past_rounds.update_finalized(finalized_number);

							if finalized_number > *last_finalized_number {
								*last_finalized_number = finalized_number;
								self.env.finalize_block(finalized_hash, finalized_number, round_number, commit)?;
							}

							process_commit_outcome.run(CommitProcessingOutcome::Good(GoodCommit::new()));
						} else {
							// Failing validation of a commit is bad.
							process_commit_outcome.run(
								CommitProcessingOutcome::Bad(BadCommit::from(validation_result)),
							);
						}
					} else {
						// Import to backgrounded round is good.
						process_commit_outcome.run(CommitProcessingOutcome::Good(GoodCommit::new()));
					}
				}
				CommunicationIn::CatchUp(catch_up, mut process_catch_up_outcome) => {
					trace!(target: "afg", "Got catch-up message for round {}", catch_up.round_number);

					let mut inner = self.inner.write();

					let round = if let Some(round) = validate_catch_up(
						catch_up,
						&*self.env,
						&self.voters,
						inner.best_round.round_number(),
					) {
						round
					} else {
						process_catch_up_outcome.run(CatchUpProcessingOutcome::Bad(BadCatchUp::new()));
						return Ok(());
					};

					let state = round.state();

					// beyond this point, we set this round to the past and
					// start voting in the next round.
					let mut just_completed = VotingRound::completed(
						round,
						inner.best_round.finalized_sender(),
						None,
						self.env.clone(),
					);

					let new_best = VotingRound::new(
						just_completed.round_number() + 1,
						self.voters.clone(),
						self.last_finalized_in_rounds.clone(),
						Some(just_completed.bridge_state()),
						inner.best_round.finalized_sender(),
						self.env.clone(),
					);

					// update last-finalized in rounds _after_ starting new round.
					// otherwise the base could be too eagerly set forward.
					if let Some((f_hash, f_num)) = state.finalized.clone() {
						if f_num > self.last_finalized_in_rounds.1 {
							self.last_finalized_in_rounds = (f_hash, f_num);
						}
					}

					self.env.completed(
						just_completed.round_number(),
						just_completed.round_state(),
						just_completed.dag_base(),
						just_completed.historical_votes(),
					)?;

					inner.past_rounds.push(&*self.env, just_completed);

					let old_best = std::mem::replace(&mut inner.best_round, new_best);
					inner.past_rounds.push(
						&*self.env,
						old_best,
					);

					process_catch_up_outcome.run(CatchUpProcessingOutcome::Good(GoodCatchUp::new()));
				},
			}
		}

		Ok(())
	}

	// process the logic of the best round.
	fn process_best_round(&mut self, cx: &mut Context) -> Poll<Result<(), E::Error>> {
		// If the current `best_round` is completable and we've already precommitted,
		// we start a new round at `best_round + 1`.
		{
			let mut inner = self.inner.write();

			let should_start_next = {
				let completable = match inner.best_round.poll(cx)? {
					Poll::Ready(()) => true,
					Poll::Pending => false,
				};

				let precommitted = match inner.best_round.state() {
					Some(&VotingRoundState::Precommitted) => true, // start when we've cast all votes.
					_ => false,
				};

				completable && precommitted
			};

			if !should_start_next { return Poll::Pending }

			trace!(target: "afg", "Best round at {} has become completable. Starting new best round at {}",
				inner.best_round.round_number(),
				inner.best_round.round_number() + 1,
			);
		}

		self.completed_best_round()?;

		// round has been updated. so we need to re-poll.
		self.poll_unpin(cx)
	}

	fn completed_best_round(&mut self) -> Result<(), E::Error> {
		let mut inner = self.inner.write();

		self.env.completed(
			inner.best_round.round_number(),
			inner.best_round.round_state(),
			inner.best_round.dag_base(),
			inner.best_round.historical_votes(),
		)?;

		let old_round_number = inner.best_round.round_number();

		let next_round = VotingRound::new(
			old_round_number + 1,
			self.voters.clone(),
			self.last_finalized_in_rounds.clone(),
			Some(inner.best_round.bridge_state()),
			inner.best_round.finalized_sender(),
			self.env.clone(),
		);

		let old_round = ::std::mem::replace(&mut inner.best_round, next_round);
		inner.past_rounds.push(&*self.env, old_round);
		Ok(())
	}

	fn set_last_finalized_number(&mut self, finalized_number: N) -> bool {
		let last_finalized_number = &mut self.last_finalized_number;
		if finalized_number > *last_finalized_number {
			*last_finalized_number = finalized_number;
			return true;
		}
		false
	}
}

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Future for Voter<H, N, E, GlobalIn, GlobalOut> where
	H: Clone + Eq + Ord + ::std::fmt::Debug,
	N: Copy + BlockNumberOps + ::std::fmt::Debug,
	GlobalIn: Stream<Item=Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
	GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error=E::Error> + Unpin,
{
	type Output = Result<(), E::Error>;

	fn poll(mut self: Pin<&mut Self>, cx: &mut Context) -> Poll<Result<(), E::Error>> {
		self.process_incoming(cx)?;
		self.prune_background_rounds(cx)?;
		let _ = self.global_out.poll(cx)?;

		self.process_best_round(cx)
	}
}

impl<H, N, E: Environment<H, N>, GlobalIn, GlobalOut> Unpin for Voter<H, N, E, GlobalIn, GlobalOut> where
	H: Clone + Eq + Ord + ::std::fmt::Debug,
	N: Copy + BlockNumberOps + ::std::fmt::Debug,
	GlobalIn: Stream<Item=Result<CommunicationIn<H, N, E::Signature, E::Id>, E::Error>> + Unpin,
	GlobalOut: Sink<CommunicationOut<H, N, E::Signature, E::Id>, Error=E::Error> + Unpin,
{
}

/// Trait for querying the state of the voter. Used by `Voter` to return a queryable object
/// without exposing too many data types.
pub trait VoterState<Id: Eq + std::hash::Hash> {
	/// Returns a plain data type, `report::VoterState`, describing the current state
	/// of the voter relevant to the voting process.
	fn get(&self) -> report::VoterState<Id>;
}

/// Contains a number of data transfer objects for reporting data to the outside world.
pub mod report {
	use std::collections::{HashMap, HashSet};
	use crate::weights::{VoteWeight, VoterWeight};

	/// Basic data struct for the state of a round.
	#[derive(PartialEq, Eq, Clone)]
	#[cfg_attr(test, derive(Debug))]
	pub struct RoundState<Id: Eq + std::hash::Hash> {
		/// Total weight of all votes.
		pub total_weight: VoterWeight,
		/// The threshold voter weight.
		pub threshold_weight: VoterWeight,

		/// Current weight of the prevotes.
		pub prevote_current_weight: VoteWeight,
		/// The identities of nodes that have cast prevotes so far.
		pub prevote_ids: HashSet<Id>,

		/// Current weight of the precommits.
		pub precommit_current_weight: VoteWeight,
		/// The identities of nodes that have cast precommits so far.
		pub precommit_ids: HashSet<Id>,
	}

	/// Basic data struct for the current state of the voter in a form suitable
	/// for passing on to other systems.
	#[derive(PartialEq, Eq)]
	#[cfg_attr(test, derive(Debug))]
	pub struct VoterState<Id: Eq + std::hash::Hash> {
		/// Voting rounds running in the background.
		pub background_rounds: HashMap<u64, RoundState<Id>>,
		/// The current best voting round.
		pub best_round: (u64, RoundState<Id>),
	}
}

struct SharedVoterState<H, N, E>(Arc<RwLock<InnerVoterState<H, N, E>>>) where
	H: Clone + Ord + std::fmt::Debug,
	N: BlockNumberOps,
	E: Environment<H, N>;

impl<H, N, E> VoterState<E::Id> for SharedVoterState<H, N, E> where
	H: Clone + Eq + Ord + std::fmt::Debug,
	N: BlockNumberOps,
	E: Environment<H, N>,
	<E as Environment<H, N>>::Id: Hash,
{
	fn get(&self) -> report::VoterState<E::Id> {
		let to_round_state = |voting_round: &VotingRound<H, N, E>| {
			(
				voting_round.round_number(),
				report::RoundState {
					total_weight: voting_round.voters().total_weight(),
					threshold_weight: voting_round.voters().threshold(),
					prevote_current_weight: voting_round.prevote_weight(),
					prevote_ids: voting_round.prevote_ids().collect(),
					precommit_current_weight: voting_round.precommit_weight(),
					precommit_ids: voting_round.precommit_ids().collect(),
				}
			)
		};

		let lock = self.0.read();
		let best_round = to_round_state(&lock.best_round);
		let background_rounds = lock
			.past_rounds
			.voting_rounds()
			.map(to_round_state)
			.collect();

		report::VoterState {
			best_round,
			background_rounds,
		}
	}
}

/// Validate the given catch up and return a completed round with all prevotes
/// and precommits from the catch up imported. If the catch up is invalid `None`
/// is returned instead.
fn validate_catch_up<H, N, S, I, E>(
	catch_up: CatchUp<H, N, S, I>,
	env: &E,
	voters: &VoterSet<I>,
	best_round_number: u64,
) -> Option<crate::round::Round<I, H, N, S>> where
	H: Clone + Eq + Ord + std::fmt::Debug,
	N: BlockNumberOps + std::fmt::Debug,
	S: Clone + Eq,
	I: Clone + Eq + std::fmt::Debug + Ord,
	E: Environment<H, N>,
{
	if catch_up.round_number <= best_round_number {
		trace!(target: "afg", "Ignoring because best round number is {}",
			   best_round_number);

		return None;
	}

	// check threshold support in prevotes and precommits.
	{
		let mut map = std::collections::BTreeMap::new();

		for prevote in &catch_up.prevotes {
			if !voters.contains(&prevote.id) {
				trace!(target: "afg",
					   "Ignoring invalid catch up, invalid voter: {:?}",
					   prevote.id,
				);

				return None;
			}

			map.entry(prevote.id.clone()).or_insert((false, false)).0 = true;
		}

		for precommit in &catch_up.precommits {
			if !voters.contains(&precommit.id) {
				trace!(target: "afg",
					   "Ignoring invalid catch up, invalid voter: {:?}",
					   precommit.id,
				);

				return None;
			}

			map.entry(precommit.id.clone()).or_insert((false, false)).1 = true;
		}

		let (pv, pc) = map.into_iter().fold(
			(VoteWeight(0), VoteWeight(0)),
			|(mut pv, mut pc), (id, (prevoted, precommitted))| {
				if let Some(v) = voters.get(&id) {
					if prevoted {
						pv = pv + v.weight();
					}

					if precommitted {
						pc = pc + v.weight();
					}
				}

				(pv, pc)
			},
		);

		let threshold = voters.threshold();
		if pv < threshold || pc < threshold {
			trace!(target: "afg",
				   "Ignoring invalid catch up, missing voter threshold"
			);

			return None;
		}
	}

	let mut round = crate::round::Round::new(crate::round::RoundParams {
		round_number: catch_up.round_number,
		voters: voters.clone(),
		base: (catch_up.base_hash.clone(), catch_up.base_number),
	});

	// import prevotes first.
	for crate::SignedPrevote { prevote, id, signature } in catch_up.prevotes {
		match round.import_prevote(env, prevote, id, signature) {
			Ok(_) => {},
			Err(e) => {
				trace!(target: "afg",
					   "Ignoring invalid catch up, error importing prevote: {:?}",
					   e,
				);

				return None;
			},
		}
	}

	// then precommits.
	for crate::SignedPrecommit { precommit, id, signature } in catch_up.precommits {
		match round.import_precommit(env, precommit, id, signature) {
			Ok(_) => {},
			Err(e) => {
				trace!(target: "afg",
					   "Ignoring invalid catch up, error importing precommit: {:?}",
					   e,
				);

				return None;
			},
		}
	}

	let state = round.state();
	if !state.completable {
		return None;
	}

	Some(round)
}

#[cfg(test)]
mod tests {
	use super::*;
	use crate::SignedPrecommit;
	use crate::testing::{
		self,
		chain::GENESIS_HASH,
		environment::{Environment, Id, Signature},
	};
	use crate::weights::{VoteWeight, VoterWeight};
	use futures::executor::LocalPool;
	use futures::task::SpawnExt;
	use futures_timer::Delay;
	use std::iter;
	use std::time::Duration;
	use std::collections::HashSet;

	#[test]
	fn talking_to_myself() {
		let local_id = Id(5);
		let voters = VoterSet::new(std::iter::once((local_id, 100))).unwrap();

		let (network, routing_task) = testing::environment::make_network();

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network, local_id));

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		// run voter in background. scheduling it to shut down at the end.
		let finalized = env.finalized_stream();
		let voter = Voter::new(
			env.clone(),
			voters,
			global_comms,
			0,
			Vec::new(),
			last_finalized,
			last_finalized,
		);

		let mut pool = LocalPool::new();
		pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();
		pool.spawner().spawn(routing_task).unwrap();

		// wait for the best block to finalize.
		pool.run_until(finalized
			.take_while(|&(_, n, _)| future::ready(n < 6))
			.for_each(|_| future::ready(())))
	}

	#[test]
	fn finalizing_at_fault_threshold() {
		// 10 voters
		let voters = VoterSet::new((0..10).map(|i| (Id(i), 1))).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();
		let mut pool = LocalPool::new();

		// 3 voters offline.
		let finalized_streams = (0..7).map(|i| {
			let local_id = Id(i);
			// initialize chain
			let env = Arc::new(Environment::new(network.clone(), local_id));
			let last_finalized = env.with_chain(|chain| {
				chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
				chain.last_finalized()
			});

			// run voter in background. scheduling it to shut down at the end.
			let finalized = env.finalized_stream();
			let voter = Voter::new(
				env.clone(),
				voters.clone(),
				network.make_global_comms(),
				0,
				Vec::new(),
				last_finalized,
				last_finalized,
			);

			pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();

			// wait for the best block to be finalized by all honest voters
			finalized
				.take_while(|&(_, n, _)| future::ready(n < 6))
				.for_each(|_| future::ready(()))
		}).collect::<Vec<_>>();

		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		pool.run_until(future::join_all(finalized_streams.into_iter()));
	}

	#[test]
	fn exposing_voter_state() {
		let num_voters = 10;
		let voters_online = 7;
		let voters = VoterSet::new((0..num_voters).map(|i| (Id(i), 1))).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();
		let mut pool = LocalPool::new();

		// some voters offline
		let (finalized_streams, voter_states): (Vec<_>, Vec<_>) = (0..voters_online).map(|i| {
			let local_id = Id(i);
			// initialize chain
			let env = Arc::new(Environment::new(network.clone(), local_id));
			let last_finalized = env.with_chain(|chain| {
				chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
				chain.last_finalized()
			});

			// run voter in background. scheduling it to shut down at the end.
			let finalized = env.finalized_stream();
			let voter = Voter::new(
				env.clone(),
				voters.clone(),
				network.make_global_comms(),
				0,
				Vec::new(),
				last_finalized,
				last_finalized,
			);
			let voter_state = voter.voter_state();

			pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();

			(
				// wait for the best block to be finalized by all honest voters
				finalized
					.take_while(|&(_, n, _)| future::ready(n < 6))
					.for_each(|_| future::ready(())),
				voter_state,
			)
		}).unzip();

		let voter_state = &voter_states[0];
		voter_states.iter().all(|vs| vs.get() == voter_state.get());

		let expected_round_state = report::RoundState::<Id> {
			total_weight: VoterWeight::new(num_voters.into()).expect("nonzero"),
			threshold_weight: VoterWeight::new(voters_online.into()).expect("nonzero"),
			prevote_current_weight: VoteWeight(0),
			prevote_ids: Default::default(),
			precommit_current_weight: VoteWeight(0),
			precommit_ids: Default::default(),
		};

		assert_eq!(
			voter_state.get(),
			report::VoterState {
				background_rounds: Default::default(),
				best_round: (1, expected_round_state.clone()),
			}
		);

		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();
		pool.run_until(future::join_all(finalized_streams.into_iter()));

		assert_eq!(voter_state.get().best_round, (2, expected_round_state.clone()));
	}

	#[test]
	fn broadcast_commit() {
		let local_id = Id(5);
		let voters = VoterSet::new([(local_id, 100)].iter().cloned()).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();
		let (commits, _) = network.make_global_comms();

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network, local_id));

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		// run voter in background. scheduling it to shut down at the end.
		let voter = Voter::new(
			env.clone(),
			voters.clone(),
			global_comms,
			0,
			Vec::new(),
			last_finalized,
			last_finalized,
		);

		let mut pool = LocalPool::new();
		pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();
		pool.spawner().spawn(routing_task).unwrap();

		// wait for the node to broadcast a commit message
		pool.run_until(commits.take(1).for_each(|_| future::ready(())))
	}

	#[test]
	fn broadcast_commit_only_if_newer() {
		let local_id = Id(5);
		let test_id = Id(42);
		let voters = VoterSet::new([
			(local_id, 100),
			(test_id, 201),
		].iter().cloned()).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();
		let (commits_stream, commits_sink) = network.make_global_comms();
		let (round_stream, round_sink) = network.make_round_comms(1, test_id);

		let prevote = Message::Prevote(Prevote {
			target_hash: "E",
			target_number: 6,
		});

		let precommit = Message::Precommit(Precommit {
			target_hash: "E",
			target_number: 6,
		});

		let commit = (1, Commit {
			target_hash: "E",
			target_number: 6,
			precommits: vec![SignedPrecommit {
				precommit: Precommit { target_hash: "E", target_number: 6 },
				signature: Signature(test_id.0),
				id: test_id
			}],
		});

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network, local_id));

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		// run voter in background. scheduling it to shut down at the end.
		let voter = Voter::new(
			env.clone(),
			voters.clone(),
			global_comms,
			0,
			Vec::new(),
			last_finalized,
			last_finalized,
		);

		let mut pool = LocalPool::new();
		pool.spawner().spawn(voter.map(|v| v.expect("Error voting: {:?}"))).unwrap();
		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		pool.spawner().spawn(
			round_stream.into_future()
				.then(|(value, stream)| { // wait for a prevote
					assert!(match value {
						Some(Ok(SignedMessage { message: Message::Prevote(_), id: Id(5), .. })) => true,
						_ => false,
					});
					let votes = vec![prevote, precommit].into_iter().map(Result::Ok);
					futures::stream::iter(votes).forward(round_sink).map(|_| stream) // send our prevote
				})
				.then(|stream| {
					stream.take_while(|value| match value { // wait for a precommit
						Ok(SignedMessage { message: Message::Precommit(_), id: Id(5), .. }) => future::ready(false),
						_ => future::ready(true),
					}).for_each(|_| future::ready(()))
				})
				.then(|_| {
					// send our commit
					stream::iter(iter::once(Ok(CommunicationOut::Commit(commit.0, commit.1)))).forward(commits_sink)
				})
				.map(|_| ())
		).unwrap();

		let res = pool.run_until(
			// wait for the first commit (ours)
			commits_stream.into_future()
				.then(|(_, stream)| {
					// the second commit should never arrive
					let await_second = stream.take(1)
						.for_each(|_| future::ready(()));
					let delay = Delay::new(Duration::from_millis(500));
					future::select(await_second, delay)
				}));

		match res {
			future::Either::Right(((), _work)) => {
				// the future timed out as expected
			}
			_ => panic!("Unexpected result")
		}
	}

	#[test]
	fn import_commit_for_any_round() {
		let local_id = Id(5);
		let test_id = Id(42);
		let voters = VoterSet::new([
			(local_id, 100),
			(test_id, 201),
		].iter().cloned()).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();
		let (_, commits_sink) = network.make_global_comms();

		// this is a commit for a previous round
		let commit = Commit {
			target_hash: "E",
			target_number: 6,
			precommits: vec![SignedPrecommit {
				precommit: Precommit { target_hash: "E", target_number: 6 },
				signature: Signature(test_id.0),
				id: test_id
			}],
		};

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network, local_id));

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		// run voter in background.
		let voter = Voter::new(
			env.clone(),
			voters.clone(),
			global_comms,
			1,
			Vec::new(),
			last_finalized,
			last_finalized,
		);

		let mut pool = LocalPool::new();
		pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();
		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		// Send the commit message.
		pool.spawner().spawn(
			stream::iter(iter::once(Ok(CommunicationOut::Commit(0, commit.clone()))))
				.forward(commits_sink)
				.map(|_| ())).unwrap();

		// Wait for the commit message to be processed.
		let finalized = pool.run_until(
			env.finalized_stream()
				.into_future()
				.map(move |(msg, _)| msg.unwrap().2));

		assert_eq!(finalized, commit);
	}

	#[test]
	fn skips_to_latest_round_after_catch_up() {
		// 3 voters
		let voters = VoterSet::new((0..3).map(|i| (Id(i), 1u64))).expect("nonempty");
		let total_weight = voters.total_weight();
		let threshold_weight = voters.threshold();
		let voter_ids: HashSet<Id> = (0..3).map(|i| Id(i)).collect();

		let (network, routing_task) = testing::environment::make_network();
		let mut pool = LocalPool::new();

		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		// initialize unsynced voter at round 0
		let (env, unsynced_voter) = {
			let local_id = Id(4);

			let env = Arc::new(Environment::new(network.clone(), local_id));
			let last_finalized = env.with_chain(|chain| {
				chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
				chain.last_finalized()
			});

			let voter = Voter::new(
				env.clone(),
				voters.clone(),
				network.make_global_comms(),
				0,
				Vec::new(),
				last_finalized,
				last_finalized,
			);

			(env, voter)
		};

		let pv = |id| crate::SignedPrevote {
			prevote: crate::Prevote { target_hash: "C", target_number: 4 },
			id: Id(id),
			signature: Signature(99),
		};

		let pc = |id| crate::SignedPrecommit {
			precommit: crate::Precommit { target_hash: "C", target_number: 4 },
			id: Id(id),
			signature: Signature(99),
		};

		// send in a catch-up message for round 5.
		network.send_message(CommunicationIn::CatchUp(
			CatchUp {
				base_number: 1,
				base_hash: GENESIS_HASH,
				round_number: 5,
				prevotes: vec![pv(0), pv(1), pv(2)],
				precommits: vec![pc(0), pc(1), pc(2)],
			},
			Callback::Blank,
		));

		let voter_state = unsynced_voter.voter_state();
		assert_eq!(voter_state.get().background_rounds.get(&5), None);

		// spawn the voter in the background
		pool.spawner().spawn(unsynced_voter.map(|_| ())).unwrap();

		// wait until it's caught up, it should skip to round 6 and send a
		// finality notification for the block that was finalized by catching
		// up.
		let caught_up = future::poll_fn(|_| {
			if voter_state.get().best_round.0 == 6 {
				Poll::Ready(())
			} else {
				Poll::Pending
			}
		});

		let finalized = env.finalized_stream().take(1).into_future();

		pool.run_until(caught_up.then(|_| finalized.map(|_| ())));

		assert_eq!(
			voter_state.get().best_round,
			(
				6,
				report::RoundState::<Id> {
					total_weight,
					threshold_weight,
					prevote_current_weight: VoteWeight(0),
					prevote_ids: Default::default(),
					precommit_current_weight: VoteWeight(0),
					precommit_ids: Default::default(),
				}
			)
		);

		assert_eq!(
			voter_state.get().background_rounds.get(&5),
			Some(&report::RoundState::<Id> {
				total_weight,
				threshold_weight,
				prevote_current_weight: VoteWeight(3),
				prevote_ids: voter_ids.clone(),
				precommit_current_weight: VoteWeight(3),
				precommit_ids: voter_ids,
			})
		);
	}

	#[test]
	fn pick_up_from_prior_without_grandparent_state() {
		let local_id = Id(5);
		let voters = VoterSet::new(std::iter::once((local_id, 100))).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network, local_id));

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		// run voter in background. scheduling it to shut down at the end.
		let voter = Voter::new(
			env.clone(),
			voters,
			global_comms,
			10,
			Vec::new(),
			last_finalized,
			last_finalized,
		);

		let mut pool = LocalPool::new();
		pool.spawner().spawn(voter.map(|v| v.expect("Error voting"))).unwrap();
		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		// wait for the best block to finalize.
		pool.run_until(env.finalized_stream()
			.take_while(|&(_, n, _)| future::ready(n < 6))
			.for_each(|_| future::ready(())))
	}

	#[test]
	fn pick_up_from_prior_with_grandparent_state() {
		let local_id = Id(99);
		let voters = VoterSet::new((0..100).map(|i| (Id(i), 1))).expect("nonempty");

		let (network, routing_task) = testing::environment::make_network();

		let global_comms = network.make_global_comms();
		let env = Arc::new(Environment::new(network.clone(), local_id));
		let outer_env = env.clone();

		// initialize chain
		let last_finalized = env.with_chain(|chain| {
			chain.push_blocks(GENESIS_HASH, &["A", "B", "C", "D", "E"]);
			chain.last_finalized()
		});

		let mut pool = LocalPool::new();
		let mut last_round_votes = Vec::new();

		// round 1 state on disk: 67 prevotes for "E". 66 precommits for "D". 1 precommit "E".
		// the round is completable, but the estimate ("E") is not finalized.
		for id in 0..67 {
			let prevote = Message::Prevote(Prevote { target_hash: "E", target_number: 6 });
			let precommit = if id < 66 {
				Message::Precommit(Precommit { target_hash: "D", target_number: 5 })
			} else {
				Message::Precommit(Precommit { target_hash: "E", target_number: 6 })
			};

			last_round_votes.push(SignedMessage {
				message: prevote.clone(),
				signature: Signature(id),
				id: Id(id),
			});

			last_round_votes.push(SignedMessage {
				message: precommit.clone(),
				signature: Signature(id),
				id: Id(id),
			});

			// round 2 has the same votes.
			//
			// this means we wouldn't be able to start round 3 until
			// the estimate of round-1 moves backwards.
			let (_, round_sink) = network.make_round_comms(2, Id(id));
			let msgs = stream::iter(iter::once(Ok(prevote)).chain(iter::once(Ok(precommit))));
			pool.spawner().spawn(msgs.forward(round_sink).map(|r| r.unwrap())).unwrap();
		}

		// round 1 fresh communication. we send one more precommit for "D" so the estimate
		// moves backwards.
		let sender = Id(67);
		let (_, round_sink) = network.make_round_comms(1, sender);
		let last_precommit = Message::Precommit(Precommit { target_hash: "D", target_number: 3 });
		pool.spawner().spawn(
			stream::iter(iter::once(Ok(last_precommit)))
				.forward(round_sink)
				.map(|r| r.unwrap())).unwrap();

		// run voter in background. scheduling it to shut down at the end.
		let voter = Voter::new(
			env.clone(),
			voters,
			global_comms,
			1,
			last_round_votes,
			last_finalized,
			last_finalized,
		);

		pool.spawner().spawn(voter.map_err(|_| panic!("Error voting")).map(|_| ())).unwrap();
		pool.spawner().spawn(routing_task.map(|_| ())).unwrap();

		// wait until we see a prevote on round 3 from our local ID,
		// indicating that the round 3 has started.

		let (round_stream, _) = network.make_round_comms(3, Id(1000));
		pool.run_until(round_stream
			.skip_while(move |v| {
				let v = v.as_ref().unwrap();
				if let Message::Prevote(_) = v.message {
					future::ready(v.id != local_id)
				} else {
					future::ready(true)
				}
			})
			.into_future()
			.map(|_| ()));

		assert_eq!(outer_env.last_completed_and_concluded(), (2, 1));
	}
}