relay_dynamic_config/
trusted_relay.rs

1use serde::{Deserialize, Serialize};
2
3/// Configuration to control communication from trusted relays.
4#[derive(Debug, Clone, Default, Serialize, Deserialize)]
5#[serde(default, rename_all = "camelCase")]
6pub struct TrustedRelayConfig {
7    /// Checks the signature of an event and rejects it if enabled.
8    #[serde(skip_serializing_if = "SignatureVerification::is_default")]
9    pub verify_signature: SignatureVerification,
10}
11
12impl TrustedRelayConfig {
13    /// Checks whether the config can be considered empty.
14    ///
15    /// Empty here means that all values are equal to their default values.
16    pub fn is_empty(&self) -> bool {
17        self.verify_signature == SignatureVerification::default()
18    }
19}
20
21/// Types of verification that can be performed on the signature.
22#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
23#[serde(rename_all = "camelCase")]
24pub enum SignatureVerification {
25    /// Checks the signature for validity and verifies that the embedded timestamp
26    /// is not too old.
27    Enabled,
28    /// Does not perform any validation on the signature.
29    #[default]
30    Disabled,
31}
32
33impl SignatureVerification {
34    /// Checks if it is the default variant.
35    pub fn is_default(&self) -> bool {
36        *self == SignatureVerification::default()
37    }
38}
39
40#[cfg(test)]
41mod tests {
42    use super::*;
43
44    #[test]
45    fn test_serialize_with_timestamp() {
46        let json = r#"{"verifySignature":"enabled"}"#;
47        let result: TrustedRelayConfig = serde_json::from_str(json).unwrap();
48        let serialized = serde_json::to_string(&result).unwrap();
49        assert_eq!(json, serialized);
50    }
51
52    #[test]
53    fn test_with_timestamp() {
54        let json = r#"{"verifySignature":"enabled"}"#;
55        let result: TrustedRelayConfig = serde_json::from_str(json).unwrap();
56        assert_eq!(result.verify_signature, SignatureVerification::Enabled);
57    }
58
59    #[test]
60    fn test_disabled() {
61        let json = r#"{"verifySignature":"disabled"}"#;
62        let result: TrustedRelayConfig = serde_json::from_str(json).unwrap();
63        assert_eq!(result.verify_signature, SignatureVerification::Disabled);
64    }
65
66    #[test]
67    fn test_default() {
68        let config = TrustedRelayConfig::default();
69        assert_eq!(config.verify_signature, SignatureVerification::Disabled);
70    }
71
72    #[test]
73    fn test_default_serialize() {
74        let serialized = serde_json::to_string(&TrustedRelayConfig::default()).unwrap();
75        assert_eq!(serialized, r#"{}"#);
76    }
77}
relay_dynamic_config/trusted_relay.rs

relay_dynamic_config/
trusted_relay.rs
