grandpa: report equivocations (#3868)

* session: runtime api for generating session membership proofs

* grandpa: add runtime api for creating equivocation report txs

* grandpa: submit signed equivocation report transactions

* grandpa: use proper equivocation report type

* grandpa: report equivocations

* grandpa: validate equivocation proof

* grandpa: update to finality-grandpa 0.9.1

* grandpa: fix encoding of session membership proof

* grandpa: initialize set id session mapping for genesis session

* grandpa: fix bug in set_id session validation

* fix compilation

* cleanup from merge conflicts

* cleanup crate tomls

* grandpa: refactor equivocation handling to separate trait

* node-template: fix compilation

* fix test compilation

* bump finality-grandpa to v0.10.2

* rpc: fix runtime version test

* CHERRY-PICK #4200: Add documentation to SubmitSignedTransaction and actually make it work

Squashed commit of the following:

commit 4f2cb0b1c588a06f2f3b478bb4b28b5cb29d54b9
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Tue Dec 3 16:29:33 2019 +0100

    Split the method to avoid confusing type error message.

commit c5bf24eeaaf902add89ed1b046b22c4a4aaeb2cd
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Tue Dec 3 16:19:55 2019 +0100

    Make accounts optional, fix logic.

commit 97db1ef556e023cf6847e5ffdb036c0e3ea6fb0a
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Tue Dec 3 10:06:20 2019 +0100

    Remove warning.

commit 535f5c116d1a2e826eaf90c3f7e6798e443d61d8
Merge: 516257217 0f1a5f651
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Tue Dec 3 07:08:05 2019 +0100

    Merge branch 'master' into td-signed-transactions

commit 516257217bac89fcebd083712f4ea68b7b23b55a
Merge: ac98248c6 2e68c80c2
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Mon Dec 2 13:57:25 2019 +0100

    Merge branch 'master' into td-signed-transactions

commit ac98248c6c56cff381130645a82a13d29933cf83
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Mon Nov 25 17:34:52 2019 +0100

    Forgotten import.

commit 67a3c19031506c28e31c6bc4a90fff62d467dd58
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Mon Nov 25 17:32:10 2019 +0100

    Fix naming and bounds.

commit 93e768ea9df97a4629fca1f9bc4b108fdb33f876
Author: Tomasz Drwięga <tomasz@parity.io>
Date:   Mon Nov 25 17:01:05 2019 +0100

    Add documentation to signed transactions and actually make them work.

* grandpa: skip block initialization on report submission method

* primitives: allow transaction pool access by default for offchain calls

* grandpa: unused parameters

* grandpa: remove unused method

* grandpa: enable equivocation reporting

* grandpa: add workaround for parameter encoding

* grandpa: fix localized_payload calls in tests

* fix submit_report_equivocation_extrinsic in runtimes

* node: fix submit transaction test compilation

* node: bump spec_version

* rpc: fix api version test

* grandpa: allow custom equivocation offence type

* grandpa: add test for authorities::next_change_height

* grandpa: cleanup report_equivocation function

* node: move reporting app crypto to node-primitives

* grandpa: move equivocation traits to own module

* grandpa: rename app-crypto crate import

* grandpa: export equivocation types

* node: bump spec_version

* grandpa: rename EquivocationReport to EquivocationProof

* grandpa: add missing docs to primitives

* grandpa: add missing docs to equivocation

* node: fix compilation

* grandpa: add missing docs to pallet

* node: bump spec_version

* fix whitespace

* grandpa: return error on offence reporting

* grandpa: expose session and validator count in proofs through traits

* grandpa: use strong key in module KeyOwnerProofSystem

* grandpa: move key ownership proof to grandpa runtime api

* grandpa: remove unnecessary cloning when checking equivocation proof

* grandpa: make report_equivocation a method in Environment

* support: implement KeyOwnerProofSystem for ()

* grandpa: move KeyOwnerProofSystem to module trait

* test-utils: fix runtime compilation

* grandpa: fix test compilation

* grandpa: fix test compilation after merge

* grandpa: simplify transaction submission types

* grandpa: validate equivocation report in signed extension

* client: fix test

* node: use ValidateEquivocationReport signed extension

* grandpa: expose key ownership proof under opaque type

* grandpa: better docs on key ownership proofs

* grandpa: add note about signed extension

* grandpa: add ValidateEquivocationReport::new

* grandpa: remove skip_initialize_block from runtime api

* grandpa: use new offchain transaction submission API

* grandpa: take set_id in generate_key_ownership_proof

* grandpa: update to finality-grandpa v0.12.2

* grandpa: cleanup usages of AuthoritySet::current

* grandpa: fix test

* grandpa: add mocking utilities for equivocation reporting

* grandpa: add test for equivocation reporting

* grandpa: move SetIdSession initialization

* grandpa: add more tests

* node: enable historical session manager

* node: bump spec_version

* node: use strong key types in KeyOwnerProofSystem definitions

* grandpa: export GrandpaEquivocationOffence type
This commit is contained in:
André Silva
2020-05-06 17:25:51 +01:00
committed by GitHub
parent a1127f8f9d
commit fbd2ac8f3b
38 changed files with 2249 additions and 296 deletions
@@ -100,15 +100,17 @@ pub(crate) struct Status<H, N> {
/// A set of authorities.
#[derive(Debug, Clone, Encode, Decode, PartialEq)]
pub(crate) struct AuthoritySet<H, N> {
/// The current active authorities.
pub(crate) current_authorities: AuthorityList,
set_id: u64,
// Tree of pending standard changes across forks. Standard changes are
// enacted on finality and must be enacted (i.e. finalized) in-order across
// a given branch
/// The current set id.
pub(crate) set_id: u64,
/// Tree of pending standard changes across forks. Standard changes are
/// enacted on finality and must be enacted (i.e. finalized) in-order across
/// a given branch
pub(crate) pending_standard_changes: ForkTree<H, N, PendingChange<H, N>>,
// Pending forced changes across different forks (at most one per fork).
// Forced changes are enacted on block depth (not finality), for this reason
// only one forced change should exist per fork.
/// Pending forced changes across different forks (at most one per fork).
/// Forced changes are enacted on block depth (not finality), for this reason
/// only one forced change should exist per fork.
pending_forced_changes: Vec<PendingChange<H, N>>,
}
@@ -162,9 +164,55 @@ where H: PartialEq,
impl<H: Eq, N> AuthoritySet<H, N>
where
N: Add<Output=N> + Ord + Clone + Debug,
H: Clone + Debug
N: Add<Output = N> + Ord + Clone + Debug,
H: Clone + Debug,
{
/// Returns the block hash and height at which the next pending change in
/// the given chain (i.e. it includes `best_hash`) was signalled, `None` if
/// there are no pending changes for the given chain.
///
/// This is useful since we know that when a change is signalled the
/// underlying runtime authority set management module (e.g. session module)
/// has updated its internal state (e.g. a new session started).
pub(crate) fn next_change<F, E>(
&self,
best_hash: &H,
is_descendent_of: &F,
) -> Result<Option<(H, N)>, fork_tree::Error<E>>
where
F: Fn(&H, &H) -> Result<bool, E>,
E: std::error::Error,
{
let mut forced = None;
for change in &self.pending_forced_changes {
if is_descendent_of(&change.canon_hash, best_hash)? {
forced = Some((change.canon_hash.clone(), change.canon_height.clone()));
break;
}
}
let mut standard = None;
for (_, _, change) in self.pending_standard_changes.roots() {
if is_descendent_of(&change.canon_hash, best_hash)? {
standard = Some((change.canon_hash.clone(), change.canon_height.clone()));
break;
}
}
let earliest = match (forced, standard) {
(Some(forced), Some(standard)) => Some(if forced.1 < standard.1 {
forced
} else {
standard
}),
(Some(forced), None) => Some(forced),
(None, Some(standard)) => Some(standard),
(None, None) => None,
};
Ok(earliest)
}
fn add_standard_change<F, E>(
&mut self,
pending: PendingChange<H, N>,
@@ -922,6 +970,128 @@ mod tests {
);
}
#[test]
fn next_change_works() {
let current_authorities = vec![(AuthorityId::from_slice(&[1; 32]), 1)];
let mut authorities = AuthoritySet {
current_authorities: current_authorities.clone(),
set_id: 0,
pending_standard_changes: ForkTree::new(),
pending_forced_changes: Vec::new(),
};
let new_set = current_authorities.clone();
// We have three pending changes with 2 possible roots that are enacted
// immediately on finality (i.e. standard changes).
let change_a0 = PendingChange {
next_authorities: new_set.clone(),
delay: 0,
canon_height: 5,
canon_hash: "hash_a0",
delay_kind: DelayKind::Finalized,
};
let change_a1 = PendingChange {
next_authorities: new_set.clone(),
delay: 0,
canon_height: 10,
canon_hash: "hash_a1",
delay_kind: DelayKind::Finalized,
};
let change_b = PendingChange {
next_authorities: new_set.clone(),
delay: 0,
canon_height: 4,
canon_hash: "hash_b",
delay_kind: DelayKind::Finalized,
};
// A0 (#5) <- A10 (#8) <- A1 (#10) <- best_a
// B (#4) <- best_b
let is_descendent_of = is_descendent_of(|base, hash| match (*base, *hash) {
("hash_a0", "hash_a1") => true,
("hash_a0", "best_a") => true,
("hash_a1", "best_a") => true,
("hash_a10", "best_a") => true,
("hash_b", "best_b") => true,
_ => false,
});
// add the three pending changes
authorities
.add_pending_change(change_b, &is_descendent_of)
.unwrap();
authorities
.add_pending_change(change_a0, &is_descendent_of)
.unwrap();
authorities
.add_pending_change(change_a1, &is_descendent_of)
.unwrap();
// the earliest change at block `best_a` should be the change at A0 (#5)
assert_eq!(
authorities
.next_change(&"best_a", &is_descendent_of)
.unwrap(),
Some(("hash_a0", 5)),
);
// the earliest change at block `best_b` should be the change at B (#4)
assert_eq!(
authorities
.next_change(&"best_b", &is_descendent_of)
.unwrap(),
Some(("hash_b", 4)),
);
// we apply the change at A0 which should prune it and the fork at B
authorities
.apply_standard_changes("hash_a0", 5, &is_descendent_of, false)
.unwrap();
// the next change is now at A1 (#10)
assert_eq!(
authorities
.next_change(&"best_a", &is_descendent_of)
.unwrap(),
Some(("hash_a1", 10)),
);
// there's no longer any pending change at `best_b` fork
assert_eq!(
authorities
.next_change(&"best_b", &is_descendent_of)
.unwrap(),
None,
);
// we a forced change at A10 (#8)
let change_a10 = PendingChange {
next_authorities: new_set.clone(),
delay: 0,
canon_height: 8,
canon_hash: "hash_a10",
delay_kind: DelayKind::Best {
median_last_finalized: 0,
},
};
authorities
.add_pending_change(change_a10, &static_is_descendent_of(false))
.unwrap();
// it should take precedence over the change at A1 (#10)
assert_eq!(
authorities
.next_change(&"best_a", &is_descendent_of)
.unwrap(),
Some(("hash_a10", 8)),
);
}
#[test]
fn maintains_authority_list_invariants() {
// empty authority lists are invalid