nox-core 0.1.0

Shared protocol types for the NOX mixnet (events, traits, models, fragmentation)
Documentation 
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

use std::sync::Arc;
use std::time::Duration;

use async_trait::async_trait;
use thiserror::Error;
use tokio::sync::broadcast;

use crate::events::NoxEvent;

#[derive(Debug, Error)]
pub enum InfrastructureError {
    #[error("Database error: {0}")]
    Database(String),
    #[error("Network error: {0}")]
    Network(String),
    #[error("Blockchain error: {0}")]
    Blockchain(String),
}

#[async_trait]
pub trait IStorageRepository: Send + Sync {
    async fn get(&self, key: &[u8]) -> Result<Option<Vec<u8>>, InfrastructureError>;
    async fn put(&self, key: &[u8], value: &[u8]) -> Result<(), InfrastructureError>;
    async fn exists(&self, key: &[u8]) -> Result<bool, InfrastructureError>;
    async fn delete(&self, key: &[u8]) -> Result<(), InfrastructureError>;
    async fn scan(&self, prefix: &[u8]) -> Result<Vec<(Vec<u8>, Vec<u8>)>, InfrastructureError>;
}

#[async_trait]
pub trait IChainService: Send + Sync {
    async fn get_block_number(&self) -> Result<u64, InfrastructureError>;
}

#[async_trait]
pub trait INetworkService: Send + Sync {
    async fn start(&self) -> Result<(), InfrastructureError>;
    async fn broadcast(&self, topic: &str, msg: &[u8]) -> Result<(), InfrastructureError>;
}

#[derive(Debug, Error)]
pub enum EventBusError {
    #[error("Failed to broadcast event: {0}")]
    BroadcastFailed(String),
    #[error("Lagged receiver skipped {0} messages")]
    Lagged(u64),
}

#[async_trait]
pub trait IEventPublisher: Send + Sync {
    fn publish(&self, event: NoxEvent) -> Result<usize, EventBusError>;
}

pub trait IEventSubscriber: Send + Sync {
    fn subscribe(&self) -> broadcast::Receiver<NoxEvent>;
}

pub trait IEventBus: IEventPublisher + IEventSubscriber {}

#[async_trait]
pub trait IReplayProtection: Send + Sync {
    async fn check_and_tag(
        &self,
        tag: &[u8],
        ttl_seconds: u64,
    ) -> Result<bool, InfrastructureError>;
    async fn prune_expired(&self) -> Result<usize, InfrastructureError>;
}

pub trait IMixStrategy: Send + Sync {
    fn get_delay(&self) -> Duration;
}

#[async_trait]
pub trait IChainClient: Send + Sync {
    async fn submit_tx(&self, to: &str, data: &[u8]) -> Result<String, InfrastructureError>;
    async fn simulate_tx(&self, to: &str, data: &[u8]) -> Result<Vec<u8>, InfrastructureError>;
}

pub use darkpool_crypto::IPoseidonHasher;

/// No-op `IEventPublisher` that silently discards all events.
pub struct NoopPublisher;

impl NoopPublisher {
    #[must_use]
    pub fn arc() -> Arc<dyn IEventPublisher> {
        Arc::new(Self)
    }
}

impl IEventPublisher for NoopPublisher {
    fn publish(&self, _event: NoxEvent) -> Result<usize, EventBusError> {
        Ok(0)
    }
}

#[async_trait]
pub trait IProverService: Send + Sync {
    async fn prove(
        &self,
        circuit_name: &str,
        inputs: std::collections::HashMap<String, String>,
    ) -> Result<ZKProofData, InfrastructureError>;
}

#[derive(Debug, Clone)]
pub struct ZKProofData {
    pub proof: Vec<u8>,
    pub public_inputs: Vec<String>,
}