primitives - ToETHChecksum trait

Author: elpiel

adapter/src/dummy.rs

@@ -2,7 +2,7 @@ use futures::future::{BoxFuture, FutureExt};
 use primitives::adapter::{Adapter, AdapterError, AdapterResult, DummyAdapterOptions, Session};
 use primitives::channel_validator::ChannelValidator;
 use primitives::config::Config;
-use primitives::{Channel, ValidatorId};
+use primitives::{Channel, ToETHChecksum, ValidatorId};
 use std::collections::HashMap;
 
 #[derive(Debug, Clone)]
@@ -43,7 +43,7 @@ impl Adapter for DummyAdapter {
         let signature = format!(
             "Dummy adapter signature for {} by {}",
             state_root,
-            self.whoami().to_hex_checksummed_string()
+            self.whoami().to_checksum()
         );
         Ok(signature)
     }
@@ -57,7 +57,7 @@ impl Adapter for DummyAdapter {
         // select the `identity` and compare it to the signer
         // for empty string this will return array with 1 element - an empty string `[""]`
         let is_same = match signature.rsplit(' ').take(1).next() {
-            Some(from) => from == signer.to_hex_checksummed_string(),
+            Some(from) => from == signer.to_checksum(),
             None => false,
         };
 

adapter/src/ethereum.rs

@@ -13,7 +13,7 @@ use primitives::{
     adapter::{Adapter, AdapterError, AdapterResult, KeystoreOptions, Session},
     channel_validator::ChannelValidator,
     config::Config,
-    Channel, ValidatorId,
+    Channel, ToETHChecksum, ValidatorId,
 };
 use serde::{Deserialize, Serialize};
 use serde_hex::{SerHexOpt, StrictPfx};
@@ -211,7 +211,7 @@ impl Adapter for EthereumAdapter {
             let verified = ewt_verify(header_encoded, payload_encoded, token_encoded)
                 .map_err(|e| map_error(&e.to_string()))?;
 
-            if self.whoami().to_hex_checksummed_string() != verified.payload.id {
+            if self.whoami().to_checksum() != verified.payload.id {
                 return Err(AdapterError::Configuration(
                     "token payload.id !== whoami(): token was not intended for us".to_string(),
                 ));
@@ -265,10 +265,10 @@ impl Adapter for EthereumAdapter {
 
         let era = Utc::now().timestamp_millis() as f64 / 60000.0;
         let payload = Payload {
-            id: validator.to_hex_checksummed_string(),
+            id: validator.to_checksum(),
             era: era.floor() as i64,
             identity: None,
-            address: self.whoami().to_hex_checksummed_string(),
+            address: self.whoami().to_checksum(),
         };
 
         ewt_sign(&wallet, &self.keystore_pwd, &payload)
@@ -460,7 +460,7 @@ mod test {
         let payload = Payload {
             id: "awesomeValidator".into(),
             era: 100_000,
-            address: eth_adapter.whoami().to_hex_checksummed_string(),
+            address: eth_adapter.whoami().to_checksum(),
             identity: None,
         };
         let wallet = eth_adapter.wallet.clone();
@@ -669,7 +669,7 @@ mod test {
             .expect("failed to deserialize address");
 
         let payload = Payload {
-            id: eth_adapter.whoami().to_hex_checksummed_string(),
+            id: eth_adapter.whoami().to_checksum(),
             era: 100_000,
             address: format!("{:?}", leader_account),
             identity: Some(identity),

primitives/src/lib.rs

@@ -55,3 +55,11 @@ impl error::Error for DomainError {
         None
     }
 }
+
+/// Trait that creates a String which is `0x` prefixed and encodes the bytes by `eth_checksum`
+pub trait ToETHChecksum: AsRef<[u8]> {
+    fn to_checksum(&self) -> String {
+        // checksum replaces `0x` prefix and adds one itself
+        eth_checksum::checksum(&hex::encode(self.as_ref()))
+    }
+}

primitives/src/validator.rs

@@ -3,7 +3,7 @@ use serde::{Deserialize, Serialize};
 use serde_hex::{SerHex, StrictPfx};
 use std::fmt;
 
-use crate::{BalancesMap, BigNum, DomainError};
+use crate::{BalancesMap, BigNum, DomainError, ToETHChecksum};
 use std::convert::TryFrom;
 
 #[derive(Debug)]
@@ -23,15 +23,24 @@ impl ValidatorId {
         &self.0
     }
 
+    /// To Hex non-`0x` prefixed string without **Checksum**ing the string
     pub fn to_hex_non_prefix_string(&self) -> String {
         hex::encode(self.0)
     }
 
+    /// To Hex `0x` prefixed string **without** __Checksum__ing the string
+    pub fn to_hex_prefix_string(&self) -> String {
+        format!("0x{}", self.to_hex_non_prefix_string())
+    }
+
+    // To Hex `0x` prefixed string **with** **Checksum**ing the string
     pub fn to_hex_checksummed_string(&self) -> String {
         eth_checksum::checksum(&format!("0x{}", self.to_hex_non_prefix_string()))
     }
 }
 
+impl ToETHChecksum for ValidatorId {}
+
 impl From<&[u8; 20]> for ValidatorId {
     fn from(bytes: &[u8; 20]) -> Self {
         Self(*bytes)
@@ -79,7 +88,7 @@ impl TryFrom<&String> for ValidatorId {
 
 impl fmt::Display for ValidatorId {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "{}", format!("0x{}", self.to_hex_non_prefix_string()))
+        write!(f, "{}", self.to_checksum())
     }
 }
 

validator_worker/src/sentry_interface.rs

@@ -9,7 +9,7 @@ use primitives::sentry::{
     ValidatorMessageResponse,
 };
 use primitives::validator::MessageTypes;
-use primitives::{Channel, Config, ValidatorDesc, ValidatorId};
+use primitives::{Channel, Config, ToETHChecksum, ValidatorDesc, ValidatorId};
 use reqwest::{Client, Response};
 use std::collections::HashMap;
 use std::time::Duration;
@@ -95,7 +95,7 @@ impl<T: Adapter + 'static> SentryApi<T> {
         let url = format!(
             "{}/validator-messages/{}/{}?limit=1",
             self.validator_url,
-            from.to_hex_checksummed_string(),
+            from.to_checksum(),
             message_type
         );
         let result = self
@@ -220,7 +220,7 @@ async fn fetch_page(
 
     let query = [
         format!("page={}", page),
-        format!("validator={}", validator.to_hex_checksummed_string()),
+        format!("validator={}", validator.to_checksum()),
     ]
     .join("&");