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
use crate::{
    filter::Filter,
    handler::{callback::EventHandler, retry::RetryPolicy},
};
use anyhow::anyhow;
use core::str::FromStr;
use oura::{sources::MagicArg, utils::ChainWellKnownInfo};
use std::fmt;
use std::fs::File;
use std::io::BufReader;
use std::{error::Error, path::PathBuf};
use strum_macros::Display;

pub struct TxIndexerConfig<H: EventHandler> {
    pub handler: H,
    /// Event source
    pub source: TxIndexerSource,
    /// Retry policy - how much to retry for each event callback failure
    /// This only takes effect on ErrorPolicy for a particular error is `Retry`.
    /// Once retries are exhausted, the handler will error (same treatment as ErrorPolicy::Exit)
    pub retry_policy: RetryPolicy,
}

pub enum TxIndexerSource {
    CardanoNode {
        node_address: NodeAddress,
        network: NetworkConfig,
        /// Slot number and hash as hex string (optional).
        /// If not provided, sync will begin from the tip of the chain.
        since_slot: Option<(u64, String)>,
        /// Minimum depth a block has to be from the tip for it to be considered "confirmed"
        /// See: https://oura.txpipe.io/v1/advanced/rollback_buffer
        safe_block_depth: usize,
        /// Filter transaction events by specific component(s).
        event_filter: Filter,
    },
    FixtureFiles {
        dir_path: PathBuf,
    },
}

impl<H: EventHandler> TxIndexerConfig<H> {
    #[allow(clippy::too_many_arguments)]
    pub fn cardano_node(
        handler: H,
        node_address: NodeAddress,
        network: NetworkConfig,
        since_slot: Option<(u64, String)>,
        safe_block_depth: usize,
        event_filter: Filter,
        retry_policy: RetryPolicy,
    ) -> Self {
        Self {
            handler,
            source: TxIndexerSource::CardanoNode {
                node_address,
                network,
                since_slot,
                safe_block_depth,
                event_filter,
            },
            retry_policy,
        }
    }

    pub fn source_from_fixtures(handler: H, dir_path: PathBuf, retry_policy: RetryPolicy) -> Self {
        Self {
            handler,
            source: TxIndexerSource::FixtureFiles { dir_path },
            retry_policy,
        }
    }
}

/// Simple description on how to connect to a local or remote node.
/// Used to build Oura source config.
pub enum NodeAddress {
    /// Path to Unix node.socket
    UnixSocket(String),
    /// Hostname and port number for TCP connection to remote node
    TcpAddress(String, u16),
}

/// Typed network magic restricted to specific networks fully supported by Oura.
#[derive(Clone, Debug, Display)]
pub enum NetworkName {
    PREPROD,
    PREVIEW,
    MAINNET,
}

#[derive(Clone, Debug)]
pub enum NetworkConfig {
    ConfigPath {
        node_config_path: String,
        magic: u64,
    },
    WellKnown(NetworkName),
    Config {
        chain_info: ChainWellKnownInfo,
        magic: u64,
    },
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct NetworkNameParseErr;

impl fmt::Display for NetworkNameParseErr {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        "provided string was not `preprod` or `preview` or `mainnet`".fmt(f)
    }
}
impl Error for NetworkNameParseErr {}

impl FromStr for NetworkName {
    type Err = NetworkNameParseErr;
    fn from_str(s: &str) -> Result<NetworkName, Self::Err> {
        match &s.to_lowercase()[..] {
            "preprod" => Ok(NetworkName::PREPROD),
            "preview" => Ok(NetworkName::PREVIEW),
            "mainnet" => Ok(NetworkName::MAINNET),
            _ => Err(NetworkNameParseErr),
        }
    }
}

impl NetworkConfig {
    pub fn to_magic_arg(&self) -> MagicArg {
        MagicArg(match self {
            NetworkConfig::WellKnown(network_name) => match network_name {
                NetworkName::PREPROD => pallas::network::miniprotocols::PRE_PRODUCTION_MAGIC,
                NetworkName::PREVIEW => pallas::network::miniprotocols::PREVIEW_MAGIC,
                NetworkName::MAINNET => pallas::network::miniprotocols::MAINNET_MAGIC,
            },
            NetworkConfig::ConfigPath { magic, .. } => *magic,
            NetworkConfig::Config { magic, .. } => *magic,
        })
    }

    pub fn to_chain_info(&self) -> Result<ChainWellKnownInfo, anyhow::Error> {
        Ok(match self {
            NetworkConfig::WellKnown(network_name) => match network_name {
                NetworkName::PREPROD => ChainWellKnownInfo::preprod(),
                NetworkName::PREVIEW => ChainWellKnownInfo::preview(),
                NetworkName::MAINNET => ChainWellKnownInfo::mainnet(),
            },
            NetworkConfig::Config { chain_info, .. } => chain_info.clone(),
            NetworkConfig::ConfigPath {
                node_config_path, ..
            } => {
                let file = File::open(node_config_path.clone())
                    .map_err(|err| anyhow!("Chain Info not found at given path: {}", err))?;
                let reader = BufReader::new(file);
                serde_json::from_reader(reader).expect("Invalid JSON format for ChainWellKnownInfo")
            }
        })
    }
}

// Encapsulating usage of deprecated stuff (impossible to construct struct without it).
// This avoids having to put "#![allow(deprecated)]" on the top of this file.
pub mod deprecation_usage {
    #![allow(deprecated)]

    use oura::mapper::Config as MapperConfig;
    use oura::sources::n2c::Config as N2CConfig;
    use oura::sources::n2n::Config as N2NConfig;
    use oura::sources::{AddressArg, IntersectArg, MagicArg, PointArg};

    pub fn n2c_config(
        addr: AddressArg,
        magic: MagicArg,
        since_slot: Option<(u64, String)>,
        safe_block_depth: usize,
    ) -> N2CConfig {
        N2CConfig {
            address: addr,
            magic: Some(magic),
            intersect: since_slot
                .map(|since_slot| IntersectArg::Point(PointArg(since_slot.0, since_slot.1))),
            mapper: MapperConfig {
                include_transaction_details: true,
                ..Default::default()
            },
            min_depth: safe_block_depth,
            retry_policy: None,
            finalize: None,
            // Deprecated fields
            since: None,
            well_known: None,
        }
    }

    pub fn n2n_config(
        addr: AddressArg,
        magic: MagicArg,
        since_slot: Option<(u64, String)>,
        safe_block_depth: usize,
    ) -> N2NConfig {
        N2NConfig {
            address: addr,
            magic: Some(magic),
            intersect: since_slot
                .map(|since_slot| IntersectArg::Point(PointArg(since_slot.0, since_slot.1))),
            mapper: MapperConfig {
                include_transaction_details: true,
                ..Default::default()
            },
            min_depth: safe_block_depth,
            retry_policy: None,
            finalize: None,
            // Deprecated fields
            since: None,
            well_known: None,
        }
    }
}

pub use self::deprecation_usage::*;