Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make scp::Msg derive(Digestible) #127

Merged
merged 8 commits into from
May 1, 2020
Merged

make scp::Msg derive(Digestible) #127

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
aac83fe
initial take on making scp::Topic and friends digestible
eranrund Apr 30, 2020
32761eb
scp::Msg (and friends) is Digestible
eranrund May 1, 2020
8e4d5fe
testcase for enum serialization
eranrund May 1, 2020
baf51c5
lock file and downgrades
eranrund May 1, 2020
03a12b6
clippppppy
eranrund May 1, 2020
bb419a6
cr fixes
eranrund May 1, 2020
fac90f4
fix and relocate tests
eranrund May 1, 2020
a17a25d
include specific type
eranrund May 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
131 changes: 66 additions & 65 deletions Cargo.lock
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion common/src/node_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use core::{
};
use failure::Fail;
use hex_fmt::HexFmt;
use mc_crypto_digestible::Digestible;
use mc_crypto_keys::{Ed25519Public, KeyError};
use serde::{Deserialize, Serialize};

Expand Down Expand Up @@ -45,7 +46,7 @@ impl From<KeyError> for NodeIDError {
}

/// Node unique identifier containing a responder_id as well as a unique public key
#[derive(Clone, Serialize, Deserialize)]
#[derive(Clone, Serialize, Deserialize, Digestible)]
pub struct NodeID {
pub responder_id: ResponderId,
pub public_key: Ed25519Public,
Expand Down
5 changes: 4 additions & 1 deletion common/src/responder_id.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use core::{
str::FromStr,
};
use failure::Fail;
use mc_crypto_digestible::Digestible;
use serde::{Deserialize, Serialize};

/// Potential parse errors
Expand All @@ -23,7 +24,9 @@ pub enum ResponderIdParseError {
}

/// Node unique identifier.
#[derive(Clone, Default, Debug, Eq, Serialize, Deserialize, PartialEq, PartialOrd, Ord, Hash)]
#[derive(
Clone, Default, Debug, Eq, Serialize, Deserialize, PartialEq, PartialOrd, Ord, Hash, Digestible,
)]
pub struct ResponderId(pub String);

impl Display for ResponderId {
Expand Down
41 changes: 3 additions & 38 deletions consensus/enclave/trusted/Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions consensus/scp/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ test_utils = []
[dependencies]
mc-common = { path = "../../common", features = ["log"] }
mc-crypto-keys = { path = "../../crypto/keys" }
mc-crypto-digestible = { path = "../../crypto/digestible" }
mc-util-from-random = { path = "../../util/from-random" }
mc-util-metrics = { path = "../../util/metrics" }
mc-util-serial = { path = "../../util/serial", features = ["std"] }
Expand Down
19 changes: 10 additions & 9 deletions consensus/scp/src/core_types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// Copyright (c) 2018-2020 MobileCoin Inc.

//! Core types for MobileCoin's implementation of SCP.
use mc_crypto_digestible::Digestible;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{
clone::Clone,
Expand All @@ -13,9 +14,9 @@ use std::{
};

/// A generic node identifier.
pub trait GenericNodeId: Clone + Debug + Display + Eq + PartialEq + Hash {}
pub trait GenericNodeId: Clone + Debug + Display + Eq + PartialEq + Hash + Digestible {}
impl<T> GenericNodeId for T where
T: Clone + Debug + Display + Serialize + DeserializeOwned + Eq + PartialEq + Hash
T: Clone + Debug + Display + Serialize + DeserializeOwned + Eq + PartialEq + Hash + Digestible
{
}

Expand All @@ -40,12 +41,12 @@ pub type SlotIndex = u64;

/// The value on which to consense.
pub trait Value:
Hash + Eq + PartialEq + Debug + Clone + PartialOrd + Ord + Send + Serialize
Hash + Eq + PartialEq + Debug + Clone + PartialOrd + Ord + Send + Serialize + Digestible
{
}

impl<T> Value for T where
T: Hash + Eq + PartialEq + Debug + Clone + PartialOrd + Ord + Send + Serialize
T: Hash + Eq + PartialEq + Debug + Clone + PartialOrd + Ord + Send + Serialize + Digestible
{
}

Expand All @@ -55,7 +56,7 @@ impl<T> Value for T where
/// which are moving through the phases of the federated voting.
///
/// Ballots are totally ordered, with "counter" more significant than "value."
#[derive(Hash, Eq, PartialEq, Debug, Clone, Serialize, Deserialize)]
#[derive(Hash, Eq, PartialEq, Debug, Clone, Serialize, Deserialize, Digestible)]
pub struct Ballot<V: Value> {
/// Counter.
pub N: u32,
Expand Down Expand Up @@ -114,8 +115,8 @@ mod core_types_tests {
fn total_ordering() {
// Ballots are ordered first by counter `N`.
{
let high_ballot: Ballot<u8> = Ballot { N: 13, X: vec![] };
let low_ballot = Ballot {
let high_ballot: Ballot<u32> = Ballot { N: 13, X: vec![] };
let low_ballot: Ballot<u32> = Ballot {
N: 4,
X: vec![100, 200, 88],
};
Expand All @@ -124,11 +125,11 @@ mod core_types_tests {

// Ballots are then ordered lexicographically by `X`.
{
let high_ballot = Ballot {
let high_ballot: Ballot<u32> = Ballot {
N: 13,
X: vec![2000, 1000],
};
let low_ballot = Ballot {
let low_ballot: Ballot<u32> = Ballot {
N: 13,
X: vec![1000, 2001],
};
Expand Down
13 changes: 7 additions & 6 deletions consensus/scp/src/msg.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ use crate::{
quorum_set::QuorumSet,
};
use mc_common::{HashSet, NodeID};
use mc_crypto_digestible::Digestible;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{
cmp,
Expand All @@ -20,7 +21,7 @@ use std::{
pub const INFINITY: u32 = <u32>::max_value();

/// The contents of a Nominate Message.
#[derive(Clone, Debug, Eq, Hash, Serialize, Deserialize, PartialEq)]
#[derive(Clone, Debug, Eq, Hash, Serialize, Deserialize, PartialEq, Digestible)]
pub struct NominatePayload<V: Value> {
/// Voted values.
pub X: BTreeSet<V>,
Expand Down Expand Up @@ -57,7 +58,7 @@ impl<V: Value> PartialOrd for NominatePayload<V> {
/// The contents of a Prepare Message.
///
/// See [IETF Draft 0](https://tools.ietf.org/html/draft-mazieres-dinrg-scp-00#page-7)
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash)]
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash, Digestible)]
pub struct PreparePayload<V: Value> {
/// The ballot, containing the current and highest prepare vote.
pub B: Ballot<V>,
Expand Down Expand Up @@ -106,7 +107,7 @@ impl<V: Value> PartialOrd for PreparePayload<V> {
/// The contents of a Commit Message.
///
/// See Commit Message in [IETF Draft 05](https://tools.ietf.org/pdf/draft-mazieres-dinrg-scp-05.pdf)
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash)]
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash, Digestible)]
pub struct CommitPayload<V: Value> {
/// The ballot, containing the current and highest commit vote.
///
Expand Down Expand Up @@ -147,7 +148,7 @@ impl<V: Value> PartialOrd for CommitPayload<V> {
}

/// The contents of an Externalize Message.
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash)]
#[derive(Clone, Debug, Eq, Serialize, Deserialize, PartialEq, Hash, Digestible)]
pub struct ExternalizePayload<V: Value> {
/// The lowest confirmed committed ballot.
pub C: Ballot<V>,
Expand All @@ -174,7 +175,7 @@ impl<V: Value> PartialOrd for ExternalizePayload<V> {
}

/// Encapsulates phase of SCP, and contains the appropriate payload.
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Hash)]
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, Hash, Digestible)]
pub enum Topic<V: Value> {
/// Nominate Messages.
Nominate(NominatePayload<V>),
Expand Down Expand Up @@ -253,7 +254,7 @@ impl<V: Value> PartialOrd for Topic<V> {
}

/// The Messsage type for Consensus.
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash)]
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Digestible)]
pub struct Msg<V: Value, ID: GenericNodeId = NodeID> {
/// ID of the node sending this message.
pub sender_id: ID,
Expand Down
5 changes: 3 additions & 2 deletions consensus/scp/src/quorum_set.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
//!
//! A quorum set includes the members of the network, which a given node trusts and depends on.
use mc_common::{HashMap, HashSet, NodeID, ResponderId};
use mc_crypto_digestible::Digestible;
use serde::{de::DeserializeOwned, Deserialize, Serialize};
use std::{
fmt::{Debug, Display},
Expand All @@ -18,7 +19,7 @@ use crate::{
};

/// The quorum set defining the trusted set of peers.
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash)]
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Digestible)]
pub struct QuorumSet<ID: GenericNodeId = NodeID> {
/// Threshold (how many members do we need to reach quorum).
pub threshold: u32,
Expand All @@ -28,7 +29,7 @@ pub struct QuorumSet<ID: GenericNodeId = NodeID> {
}

/// A member in a QuorumSet. Can be either a Node or another QuorumSet.
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash)]
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq, Hash, Digestible)]
#[serde(tag = "type", content = "args")]
pub enum QuorumSetMember<ID: GenericNodeId> {
/// A single trusted entity with an identity.
Expand Down
6 changes: 3 additions & 3 deletions crypto/digestible/derive/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ edition = "2018"
proc_macro = true

[dependencies]
proc-macro2 = "0.4.4"
quote = "0.6.3"
syn = { version = "0.15", features = [ "extra-traits" ] }
proc-macro2 = "1.0.8"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are actually newer versions, but courtesy of mbedtls and its dependency on an old bindgen, we need to pin to these exact versions :(

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one thing is, there was a new version of cargo feature that can allow separating dependencies for build-time tools -- I don't know that we ever enabled it but it might help here? i'm not sure

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rust-lang/cargo#8003

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it sounds like it might not actually help yet anyways

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, this is caused because we can only have one version of clang-sys at a time. Right now grpc and mbedtls both need version 6, so that's the one we're stuck on.

quote = "1.0.2"
syn = { version = "1.0.14", features = [ "extra-traits" ] }

[dev-dependencies]
mc-crypto-digestible = { path = "../../digestible" }
Expand Down
Loading