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
use once_cell::sync::Lazy;
use serde::{Deserialize, Serialize};
use std::{borrow::Borrow, fmt, str::FromStr};

use crate::{
    address::Error,
    targeting::Value,
    util::{api::Error as ApiUrlError, ApiUrl},
    Address, DomainError, ToETHChecksum, ToHex, UnifiedNum,
};

#[doc(inline)]
pub use messages::*;

#[derive(Serialize, Deserialize, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
#[serde(transparent)]
pub struct ValidatorId(Address);

impl fmt::Debug for ValidatorId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "ValidatorId({})", self.to_hex_prefixed())
    }
}

impl ValidatorId {
    pub fn as_bytes(&self) -> &[u8; 20] {
        self.0.as_bytes()
    }

    pub fn to_address(self) -> Address {
        self.0
    }

    pub fn as_address(&self) -> &Address {
        &self.0
    }

    pub fn inner(&self) -> &[u8; 20] {
        self.0.as_bytes()
    }
}

impl ToETHChecksum for ValidatorId {}

impl From<&Address> for ValidatorId {
    fn from(address: &Address) -> Self {
        Self(*address)
    }
}

impl From<Address> for ValidatorId {
    fn from(address: Address) -> Self {
        Self(address)
    }
}

impl From<&Lazy<Address>> for ValidatorId {
    fn from(address: &Lazy<Address>) -> Self {
        // once for the reference of &Lazy into Lazy
        // and once for moving out of Lazy into Address
        Self(**address)
    }
}

impl From<&[u8; 20]> for ValidatorId {
    fn from(bytes: &[u8; 20]) -> Self {
        Self(Address::from(bytes))
    }
}

impl AsRef<[u8]> for ValidatorId {
    fn as_ref(&self) -> &[u8] {
        self.0.as_ref()
    }
}

impl FromStr for ValidatorId {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Address::try_from(s).map(Self)
    }
}

impl TryFrom<&str> for ValidatorId {
    type Error = Error;
    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Address::try_from(value).map(Self)
    }
}

impl TryFrom<&String> for ValidatorId {
    type Error = Error;

    fn try_from(value: &String) -> Result<Self, Self::Error> {
        Self::try_from(value.as_str())
    }
}

impl fmt::Display for ValidatorId {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.to_checksum())
    }
}

impl TryFrom<Value> for ValidatorId {
    type Error = DomainError;

    fn try_from(value: Value) -> Result<Self, Self::Error> {
        Address::try_from(value).map(Self)
    }
}

#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
#[serde(rename_all = "camelCase")]
/// A Validator description which includes the identity, fee (per event) and the Sentry URL.
pub struct ValidatorDesc {
    pub id: ValidatorId,
    /// The validator fee per event
    ///
    /// Each fee is calculated based on the payout for an event.
    ///
    /// payout * fee = event fee payout
    pub fee: UnifiedNum,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    /// The address which will receive the fees
    pub fee_addr: Option<Address>,
    /// The url of the Validator where Sentry API is running
    pub url: String,
}

impl ValidatorDesc {
    /// Tries to create an [`ApiUrl`] from the `url` field.
    pub fn try_api_url(&self) -> Result<ApiUrl, ApiUrlError> {
        self.url.parse()
    }
}

#[derive(Debug, PartialEq, Eq, Clone)]
pub enum Validator<T> {
    Leader(T),
    Follower(T),
}

impl<T> Validator<T> {
    pub fn into_inner(self) -> T {
        match self {
            Self::Leader(validator) => validator,
            Self::Follower(validator) => validator,
        }
    }
}

impl<T> Borrow<T> for Validator<T> {
    fn borrow(&self) -> &T {
        match self {
            Self::Leader(validator) => validator,
            Self::Follower(validator) => validator,
        }
    }
}

/// Validator Message Types
pub mod messages {
    use std::{any::type_name, fmt, marker::PhantomData};

    use parse_display::{Display, FromStr};
    use thiserror::Error;

    use crate::balances::{Balances, BalancesState, CheckedState, UncheckedState};
    use chrono::{DateTime, Utc};
    use serde::{Deserialize, Serialize};

    #[derive(Error, Debug)]
    pub enum MessageError<T: Type> {
        #[error(transparent)]
        Balances(#[from] crate::balances::Error),
        #[error("Expected {} message type but the actual is {actual}", type_name::<T>(), )]
        Type {
            expected: PhantomData<T>,
            actual: String,
        },
    }

    impl<T: Type> MessageError<T> {
        pub fn for_actual<A: Type>(_actual: &A) -> Self {
            Self::Type {
                expected: PhantomData::default(),
                actual: type_name::<A>().to_string(),
            }
        }
    }

    pub trait Type:
        fmt::Debug
        + Into<MessageTypes>
        + TryFrom<MessageTypes, Error = MessageError<Self>>
        + Clone
        + PartialEq
        + Eq
    {
    }

    impl Type for ApproveState {}
    impl TryFrom<MessageTypes> for ApproveState {
        type Error = MessageError<Self>;

        fn try_from(value: MessageTypes) -> Result<Self, Self::Error> {
            match value {
                MessageTypes::NewState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::RejectState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::Heartbeat(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::ApproveState(approve_state) => Ok(approve_state),
            }
        }
    }
    impl From<ApproveState> for MessageTypes {
        fn from(approve_state: ApproveState) -> Self {
            MessageTypes::ApproveState(approve_state)
        }
    }

    impl<S: BalancesState> Type for NewState<S> {}
    impl<S: BalancesState> TryFrom<MessageTypes> for NewState<S> {
        type Error = MessageError<Self>;

        fn try_from(value: MessageTypes) -> Result<Self, Self::Error> {
            match value {
                MessageTypes::ApproveState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::RejectState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::Heartbeat(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::NewState(new_state) => {
                    let balances = S::from_unchecked(new_state.balances)?;

                    Ok(Self {
                        state_root: new_state.state_root,
                        signature: new_state.signature,
                        balances,
                    })
                }
            }
        }
    }

    impl<S: BalancesState> From<NewState<S>> for MessageTypes {
        fn from(new_state: NewState<S>) -> Self {
            MessageTypes::NewState(NewState {
                state_root: new_state.state_root,
                signature: new_state.signature,
                balances: new_state.balances.into_unchecked(),
            })
        }
    }

    impl<S: BalancesState> Type for RejectState<S> {}
    impl<S: BalancesState> TryFrom<MessageTypes> for RejectState<S> {
        type Error = MessageError<Self>;

        fn try_from(value: MessageTypes) -> Result<Self, Self::Error> {
            match value {
                MessageTypes::ApproveState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::NewState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::Heartbeat(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::RejectState(reject_state) => {
                    let balances = reject_state.balances.map(S::from_unchecked).transpose()?;

                    Ok(Self {
                        reason: reject_state.reason,
                        state_root: reject_state.state_root,
                        signature: reject_state.signature,
                        balances,
                        timestamp: reject_state.timestamp,
                    })
                }
            }
        }
    }

    impl<S: BalancesState> From<RejectState<S>> for MessageTypes {
        fn from(reject_state: RejectState<S>) -> Self {
            MessageTypes::RejectState(RejectState {
                reason: reject_state.reason,
                state_root: reject_state.state_root,
                signature: reject_state.signature,
                balances: reject_state
                    .balances
                    .map(|balances| balances.into_unchecked()),
                timestamp: reject_state.timestamp,
            })
        }
    }

    impl Type for Heartbeat {}
    impl TryFrom<MessageTypes> for Heartbeat {
        type Error = MessageError<Self>;

        fn try_from(value: MessageTypes) -> Result<Self, Self::Error> {
            match value {
                MessageTypes::ApproveState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::NewState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::RejectState(msg) => Err(MessageError::for_actual(&msg)),
                MessageTypes::Heartbeat(heartbeat) => Ok(heartbeat),
            }
        }
    }

    impl From<Heartbeat> for MessageTypes {
        fn from(heartbeat: Heartbeat) -> Self {
            MessageTypes::Heartbeat(heartbeat)
        }
    }

    /// Generated by the follower when a [`NewState`]
    /// is generated by the leader and the state is signable and correct.
    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
    #[serde(rename_all = "camelCase")]
    pub struct ApproveState {
        pub state_root: String,
        pub signature: String,
        pub is_healthy: bool,
    }

    /// Generated by the [`Channel.leader`](crate::Channel::leader)
    /// on changed balances for the [`Channel`](crate::Channel).
    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
    #[serde(rename_all = "camelCase")]
    pub struct NewState<S: BalancesState> {
        pub state_root: String,
        pub signature: String,
        #[serde(flatten, bound = "S: BalancesState")]
        pub balances: Balances<S>,
    }

    impl NewState<UncheckedState> {
        pub fn try_checked(self) -> Result<NewState<CheckedState>, crate::balances::Error> {
            Ok(NewState {
                state_root: self.state_root,
                signature: self.signature,
                balances: self.balances.check()?,
            })
        }
    }

    /// Generated by the [`Channel.follower`] on:
    ///
    /// - Payout mismatch in the [`NewState`] between earner & spenders (i.e. their sum is not equal)
    /// - Invalid [`NewState`] root hash.
    /// - Failed verification of the expected signer ([`Channel.leader`])
    ///   with the proposed [`NewState`] signature and state root.
    /// - Invalid state transition (balances should always go up)
    /// - [`NewState`] is unsignable because the health is below the [`Config.health_unsignable_promilles`]
    ///
    /// [`Channel.follower`]: crate::Channel::follower
    /// [`Channel.leader`]: crate::Channel::leader
    /// [`Config.worker.health_unsignable_promilles`]: crate::config::ValidatorWorkerConfig::health_unsignable_promilles
    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
    #[serde(rename_all = "camelCase")]
    pub struct RejectState<S: BalancesState> {
        pub reason: String,
        pub state_root: String,
        pub signature: String,
        #[serde(flatten, bound = "S: BalancesState")]
        pub balances: Option<Balances<S>>,
        /// The timestamp when the [`NewState`] was rejected.
        pub timestamp: DateTime<Utc>,
    }

    /// Heartbeat sent to each [`Channel`] validator by the
    /// other validator of the [`Channel`].
    ///
    /// The Heartbeat is sent on regular intervals every [`Config.heartbeat_time`].
    ///
    /// [`Channel`]: crate::Channel
    /// [`Config.worker.heartbeat_time`]: crate::config::ValidatorWorkerConfig::heartbeat_time
    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
    #[serde(rename_all = "camelCase")]
    pub struct Heartbeat {
        pub signature: String,
        pub state_root: String,
        pub timestamp: DateTime<Utc>,
    }

    impl Heartbeat {
        pub fn new(signature: String, state_root: String) -> Self {
            Self {
                signature,
                state_root,
                timestamp: Utc::now(),
            }
        }
    }

    /// The message types used by validator.
    #[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
    #[serde(tag = "type")]
    pub enum MessageTypes {
        ApproveState(ApproveState),
        NewState(NewState<UncheckedState>),
        RejectState(RejectState<UncheckedState>),
        Heartbeat(Heartbeat),
    }

    impl MessageTypes {
        pub fn message_type(&self) -> MessageType {
            self.into()
        }
    }

    /// All available message type names.
    #[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq, Eq, FromStr, Display)]
    #[display(style = "CamelCase")]
    pub enum MessageType {
        ApproveState,
        NewState,
        RejectState,
        Heartbeat,
    }

    /// This ensures that all [`MessageTypes`] are also listed in the enum [`MessageType`]!
    impl From<&MessageTypes> for MessageType {
        fn from(message_types: &MessageTypes) -> Self {
            match message_types {
                MessageTypes::ApproveState(_) => Self::ApproveState,
                MessageTypes::NewState(_) => Self::NewState,
                MessageTypes::RejectState(_) => Self::RejectState,
                MessageTypes::Heartbeat(_) => Self::Heartbeat,
            }
        }
    }

    impl From<MessageTypes> for MessageType {
        fn from(message_types: MessageTypes) -> Self {
            Self::from(&message_types)
        }
    }

    #[cfg(test)]
    mod test {
        use super::MessageType;

        #[test]
        fn test_message_type_from_and_to_string() {
            let cases = [
                ("ApproveState", MessageType::ApproveState),
                ("NewState", MessageType::NewState),
                ("RejectState", MessageType::RejectState),
                ("Heartbeat", MessageType::Heartbeat),
            ];

            for (expected, value) in cases {
                assert_eq!(expected, value.to_string());
                assert_eq!(
                    expected
                        .parse::<MessageType>()
                        .expect("Should parse string"),
                    value
                );
            }
        }
    }
}
#[cfg(feature = "postgres")]
mod postgres {
    use super::{MessageType, ValidatorId};
    use crate::ToETHChecksum;
    use bytes::BytesMut;
    use std::error::Error;
    use tokio_postgres::types::{FromSql, IsNull, ToSql, Type};

    impl<'a> FromSql<'a> for ValidatorId {
        fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>> {
            let str_slice = <&str as FromSql>::from_sql(ty, raw)?;

            // FromHex::from_hex for fixed-sized arrays will guard against the length of the string!
            Ok(ValidatorId::try_from(str_slice)?)
        }

        fn accepts(ty: &Type) -> bool {
            matches!(*ty, Type::TEXT | Type::VARCHAR)
        }
    }

    impl ToSql for ValidatorId {
        fn to_sql(
            &self,
            ty: &Type,
            w: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            let string = self.to_checksum();

            <String as ToSql>::to_sql(&string, ty, w)
        }

        fn accepts(ty: &Type) -> bool {
            <String as ToSql>::accepts(ty)
        }

        fn to_sql_checked(
            &self,
            ty: &Type,
            out: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            let string = self.to_checksum();

            <String as ToSql>::to_sql_checked(&string, ty, out)
        }
    }

    impl<'a> FromSql<'a> for MessageType {
        fn from_sql(ty: &Type, raw: &'a [u8]) -> Result<Self, Box<dyn Error + Sync + Send>> {
            let str_slice = <&str as FromSql>::from_sql(ty, raw)?;

            Ok(str_slice.parse()?)
        }

        fn accepts(ty: &Type) -> bool {
            matches!(*ty, Type::TEXT | Type::VARCHAR)
        }
    }

    impl ToSql for MessageType {
        fn to_sql(
            &self,
            ty: &Type,
            w: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            <String as ToSql>::to_sql(&self.to_string(), ty, w)
        }

        fn accepts(ty: &Type) -> bool {
            <String as ToSql>::accepts(ty)
        }

        fn to_sql_checked(
            &self,
            ty: &Type,
            out: &mut BytesMut,
        ) -> Result<IsNull, Box<dyn Error + Sync + Send>> {
            <String as ToSql>::to_sql_checked(&self.to_string(), ty, out)
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn validator_id_is_checksummed_when_serialized() {
        let validator_id_checksum_str = "0xce07CbB7e054514D590a0262C93070D838bFBA2e";

        let validator_id =
            ValidatorId::try_from(validator_id_checksum_str).expect("Valid string was provided");
        let actual_json = serde_json::to_string(&validator_id).expect("Should serialize");
        let expected_json = format!(r#""{}""#, validator_id_checksum_str);
        assert_eq!(expected_json, actual_json);
    }
}