Skip to content

Commit d06bb6e

Browse files
committed
refactor: rename AsMessage to ToMessage
And the trait method from `message_string` to `to_message`.
1 parent eeb23cf commit d06bb6e

File tree

9 files changed

+35
-35
lines changed

9 files changed

+35
-35
lines changed

mithril-aggregator/src/multi_signer.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ mod tests {
139139

140140
use mithril_common::crypto_helper::tests_setup::*;
141141
use mithril_common::entities::{CardanoDbBeacon, Epoch, SignedEntityType, SignerWithStake};
142-
use mithril_common::protocol::AsMessage;
142+
use mithril_common::protocol::ToMessage;
143143
use mithril_common::test_utils::{fake_data, MithrilFixtureBuilder};
144144

145145
use crate::services::FakeEpochService;
@@ -186,11 +186,11 @@ mod tests {
186186
let signature = fixture.signers_fixture()[0].sign(&message).unwrap();
187187

188188
multi_signer
189-
.verify_single_signature(&message.message_string(), &signature)
189+
.verify_single_signature(&message.to_message(), &signature)
190190
.await
191191
.unwrap();
192192

193-
multi_signer.verify_single_signature_for_next_epoch(&message.message_string(), &signature).await.expect_err(
193+
multi_signer.verify_single_signature_for_next_epoch(&message.to_message(), &signature).await.expect_err(
194194
"single signature issued in the current epoch should not be valid for the next epoch",
195195
);
196196
}
@@ -200,13 +200,13 @@ mod tests {
200200

201201
multi_signer
202202
.verify_single_signature_for_next_epoch(
203-
&message.message_string(),
203+
&message.to_message(),
204204
&next_epoch_signature,
205205
)
206206
.await
207207
.unwrap();
208208

209-
multi_signer.verify_single_signature(&message.message_string(), &next_epoch_signature).await.expect_err(
209+
multi_signer.verify_single_signature(&message.to_message(), &next_epoch_signature).await.expect_err(
210210
"single signature issued in the next epoch should not be valid for the current epoch",
211211
);
212212
}
@@ -235,7 +235,7 @@ mod tests {
235235

236236
for signature in &signatures {
237237
multi_signer
238-
.verify_single_signature(&message.message_string(), signature)
238+
.verify_single_signature(&message.to_message(), signature)
239239
.await
240240
.expect("single signature should be valid");
241241
}

mithril-aggregator/src/services/certifier/certifier_service.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use mithril_common::entities::{
1111
Certificate, CertificateMetadata, CertificateSignature, Epoch, ProtocolMessage,
1212
SignedEntityType, SingleSignatures, StakeDistributionParty,
1313
};
14-
use mithril_common::protocol::AsMessage;
14+
use mithril_common::protocol::ToMessage;
1515
use mithril_common::{CardanoNetwork, StdResult, TickerService};
1616

1717
use crate::database::record::{OpenMessageRecord, OpenMessageWithSingleSignaturesRecord};
@@ -130,7 +130,7 @@ impl CertifierService for MithrilCertifierService {
130130
}
131131

132132
self.multi_signer
133-
.verify_single_signature(&open_message.protocol_message.message_string(), signature)
133+
.verify_single_signature(&open_message.protocol_message.to_message(), signature)
134134
.await
135135
.map_err(|err| {
136136
CertifierServiceError::InvalidSingleSignature(signed_entity_type.clone(), err)

mithril-common/src/certificate_chain/certificate_genesis.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ use crate::{
1515
ProtocolMessage, ProtocolMessagePartKey, ProtocolParameters,
1616
},
1717
era_deprecate,
18-
protocol::AsMessage,
18+
protocol::ToMessage,
1919
StdResult,
2020
};
2121

@@ -53,15 +53,15 @@ impl CertificateGenesisProducer {
5353
}
5454

5555
/// Sign the Genesis protocol message (test only)
56-
pub fn sign_genesis_protocol_message<T: AsMessage>(
56+
pub fn sign_genesis_protocol_message<T: ToMessage>(
5757
&self,
5858
genesis_message: T,
5959
) -> Result<ProtocolGenesisSignature, CertificateGenesisProducerError> {
6060
Ok(self
6161
.genesis_signer
6262
.as_ref()
6363
.ok_or_else(CertificateGenesisProducerError::MissingGenesisSigner)?
64-
.sign(genesis_message.message_string().as_bytes()))
64+
.sign(genesis_message.to_message().as_bytes()))
6565
}
6666

6767
era_deprecate!("Remove immutable_file_number");

mithril-common/src/entities/protocol_message.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ use serde::{Deserialize, Serialize};
22
use sha2::{Digest, Sha256};
33
use std::{collections::BTreeMap, fmt::Display};
44

5-
use crate::protocol::AsMessage;
5+
use crate::protocol::ToMessage;
66

77
/// The key of a ProtocolMessage
88
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord)]
@@ -97,8 +97,8 @@ impl ProtocolMessage {
9797
}
9898
}
9999

100-
impl AsMessage for ProtocolMessage {
101-
fn message_string(&self) -> String {
100+
impl ToMessage for ProtocolMessage {
101+
fn to_message(&self) -> String {
102102
self.compute_hash()
103103
}
104104
}

mithril-common/src/protocol/mod.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ pub use signer_builder::{SignerBuilder, SignerBuilderError};
1313
pub use single_signer::SingleSigner;
1414

1515
/// Trait to convert a type to a message that can be signed or verified by the Mithril protocol.
16-
pub trait AsMessage: Sync + Send {
16+
pub trait ToMessage: Sync + Send {
1717
/// Return a String representation of the message.
18-
fn message_string(&self) -> String;
18+
fn to_message(&self) -> String;
1919
}
2020

21-
impl AsMessage for String {
22-
fn message_string(&self) -> String {
21+
impl ToMessage for String {
22+
fn to_message(&self) -> String {
2323
self.clone()
2424
}
2525
}
2626

27-
impl AsMessage for &str {
28-
fn message_string(&self) -> String {
27+
impl ToMessage for &str {
28+
fn to_message(&self) -> String {
2929
self.to_string()
3030
}
3131
}

mithril-common/src/protocol/multi_signer.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use crate::{
77
ProtocolMultiSignature,
88
},
99
entities::SingleSignatures,
10-
protocol::AsMessage,
10+
protocol::ToMessage,
1111
StdResult,
1212
};
1313

@@ -26,7 +26,7 @@ impl MultiSigner {
2626
}
2727

2828
/// Aggregate the given single signatures into a multi-signature
29-
pub fn aggregate_single_signatures<T: AsMessage>(
29+
pub fn aggregate_single_signatures<T: ToMessage>(
3030
&self,
3131
single_signatures: &[SingleSignatures],
3232
message: &T,
@@ -37,7 +37,7 @@ impl MultiSigner {
3737
.collect();
3838

3939
self.protocol_clerk
40-
.aggregate(&protocol_signatures, message.message_string().as_bytes())
40+
.aggregate(&protocol_signatures, message.to_message().as_bytes())
4141
.map(|multi_sig| multi_sig.into())
4242
}
4343

@@ -47,7 +47,7 @@ impl MultiSigner {
4747
}
4848

4949
/// Verify a single signature
50-
pub fn verify_single_signature<T: AsMessage>(
50+
pub fn verify_single_signature<T: ToMessage>(
5151
&self,
5252
message: &T,
5353
single_signature: &SingleSignatures,
@@ -74,7 +74,7 @@ impl MultiSigner {
7474
&vk,
7575
&stake,
7676
&avk,
77-
message.message_string().as_bytes(),
77+
message.to_message().as_bytes(),
7878
)
7979
.with_context(|| {
8080
format!(

mithril-common/src/protocol/single_signer.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use crate::{
22
crypto_helper::ProtocolSigner,
33
entities::{PartyId, SingleSignatures},
4-
protocol::AsMessage,
4+
protocol::ToMessage,
55
StdResult,
66
};
77

@@ -23,8 +23,8 @@ impl SingleSigner {
2323
/// Issue a single signature for the given message.
2424
///
2525
/// If no lottery are won None will be returned.
26-
pub fn sign<T: AsMessage>(&self, message: &T) -> StdResult<Option<SingleSignatures>> {
27-
let signed_message = message.message_string();
26+
pub fn sign<T: ToMessage>(&self, message: &T) -> StdResult<Option<SingleSignatures>> {
27+
let signed_message = message.to_message();
2828
match self.protocol_signer.sign(signed_message.as_bytes()) {
2929
Some(signature) => {
3030
let won_indexes = signature.indexes.clone();

mithril-common/src/test_utils/mithril_fixture.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use crate::{
1818
ProtocolParameters, Signer, SignerWithStake, SingleSignatures, Stake, StakeDistribution,
1919
StakeDistributionParty,
2020
},
21-
protocol::{AsMessage, SignerBuilder},
21+
protocol::{SignerBuilder, ToMessage},
2222
};
2323

2424
/// A fixture of Mithril data types.
@@ -199,7 +199,7 @@ impl MithrilFixture {
199199

200200
/// Make all underlying signers sign the given message, filter the resulting list to remove
201201
/// the signers that did not sign because they loosed the lottery.
202-
pub fn sign_all<T: AsMessage>(&self, message: &T) -> Vec<SingleSignatures> {
202+
pub fn sign_all<T: ToMessage>(&self, message: &T) -> Vec<SingleSignatures> {
203203
self.signers
204204
.par_iter()
205205
.filter_map(|s| s.sign(message))
@@ -227,8 +227,8 @@ impl From<MithrilFixture> for Vec<SignerFixture> {
227227

228228
impl SignerFixture {
229229
/// Sign the given protocol message.
230-
pub fn sign<T: AsMessage>(&self, message: &T) -> Option<SingleSignatures> {
231-
let message = message.message_string();
230+
pub fn sign<T: ToMessage>(&self, message: &T) -> Option<SingleSignatures> {
231+
let message = message.to_message();
232232
self.protocol_signer
233233
.sign(message.as_bytes())
234234
.map(|signature| {

mithril-signer/src/message_adapters/to_register_signature_message.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
use anyhow::Context;
22
use mithril_common::entities::{ProtocolMessage, SignedEntityType, SingleSignatures};
33
use mithril_common::messages::{RegisterSignatureMessage, TryToMessageAdapter};
4-
use mithril_common::protocol::AsMessage;
4+
use mithril_common::protocol::ToMessage;
55
use mithril_common::StdResult;
66

77
pub struct ToRegisterSignatureMessageAdapter;
@@ -26,7 +26,7 @@ impl
2626
"'ToRegisterSignatureMessageAdapter' can not convert the single signature"
2727
})?,
2828
won_indexes: single_signature.won_indexes,
29-
signed_message: Some(protocol_message.message_string()),
29+
signed_message: Some(protocol_message.to_message()),
3030
};
3131

3232
Ok(message)
@@ -50,7 +50,7 @@ mod tests {
5050

5151
assert_eq!("party_id".to_string(), message.party_id);
5252
assert_eq!(
53-
Some(ProtocolMessage::default().message_string()),
53+
Some(ProtocolMessage::default().to_message()),
5454
message.signed_message
5555
);
5656
}

0 commit comments

Comments
 (0)