nautilus-blockchain 0.55.0

Blockchain and DeFi integration adapter for the Nautilus trading engine
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
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
// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

use std::{ops::Deref, sync::Arc};

use nautilus_model::defi::{
    dex::{Dex, SharedDex},
    rpc::RpcLog,
};

use crate::{
    events::{
        burn::BurnEvent, collect::CollectEvent, flash::FlashEvent, initialize::InitializeEvent,
        mint::MintEvent, pool_created::PoolCreatedEvent, swap::SwapEvent,
    },
    hypersync::HypersyncLog,
};

/// Extended DEX wrapper that adds provider-specific event parsing capabilities to the domain `Dex` model.
#[derive(Debug, Clone)]
pub struct DexExtended {
    /// The core domain Dex object being extended.
    pub dex: SharedDex,
    // === HyperSync parsers ===
    /// Function to parse pool creation events from HyperSync logs.
    pub parse_pool_created_event_hypersync_fn:
        Option<fn(HypersyncLog) -> anyhow::Result<PoolCreatedEvent>>,
    /// Function to parse initialize events from HyperSync logs.
    pub parse_initialize_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<InitializeEvent>>,
    /// Function to parse swap events from HyperSync logs.
    pub parse_swap_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<SwapEvent>>,
    /// Function to parse mint events from HyperSync logs.
    pub parse_mint_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<MintEvent>>,
    /// Function to parse burn events from HyperSync logs.
    pub parse_burn_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<BurnEvent>>,
    /// Function to parse collect events from HyperSync logs.
    pub parse_collect_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<CollectEvent>>,
    /// Function to parse flash events from HyperSync logs.
    pub parse_flash_event_hypersync_fn:
        Option<fn(SharedDex, &HypersyncLog) -> anyhow::Result<FlashEvent>>,
    // === RPC parsers (hex-decode, standard Ethereum format) ===
    /// Function to parse pool creation events from RPC logs.
    pub parse_pool_created_event_rpc_fn: Option<fn(&RpcLog) -> anyhow::Result<PoolCreatedEvent>>,
    /// Function to parse initialize events from RPC logs.
    pub parse_initialize_event_rpc_fn:
        Option<fn(SharedDex, &RpcLog) -> anyhow::Result<InitializeEvent>>,
    /// Function to parse swap events from RPC logs.
    pub parse_swap_event_rpc_fn: Option<fn(SharedDex, &RpcLog) -> anyhow::Result<SwapEvent>>,
    /// Function to parse mint events from RPC logs.
    pub parse_mint_event_rpc_fn: Option<fn(SharedDex, &RpcLog) -> anyhow::Result<MintEvent>>,
    /// Function to parse burn events from RPC logs.
    pub parse_burn_event_rpc_fn: Option<fn(SharedDex, &RpcLog) -> anyhow::Result<BurnEvent>>,
    /// Function to parse collect events from RPC logs.
    pub parse_collect_event_rpc_fn: Option<fn(SharedDex, &RpcLog) -> anyhow::Result<CollectEvent>>,
    /// Function to parse flash events from RPC logs.
    pub parse_flash_event_rpc_fn: Option<fn(SharedDex, &RpcLog) -> anyhow::Result<FlashEvent>>,
}

impl DexExtended {
    /// Creates a new [`DexExtended`] wrapper around a domain `Dex` object.
    #[must_use]
    pub fn new(dex: Dex) -> Self {
        Self {
            dex: Arc::new(dex),
            // HyperSync parsers
            parse_pool_created_event_hypersync_fn: None,
            parse_initialize_event_hypersync_fn: None,
            parse_swap_event_hypersync_fn: None,
            parse_mint_event_hypersync_fn: None,
            parse_burn_event_hypersync_fn: None,
            parse_collect_event_hypersync_fn: None,
            parse_flash_event_hypersync_fn: None,
            // RPC parsers
            parse_pool_created_event_rpc_fn: None,
            parse_initialize_event_rpc_fn: None,
            parse_swap_event_rpc_fn: None,
            parse_mint_event_rpc_fn: None,
            parse_burn_event_rpc_fn: None,
            parse_collect_event_rpc_fn: None,
            parse_flash_event_rpc_fn: None,
        }
    }

    /// Sets the function used to parse pool creation events from HyperSync logs.
    pub fn set_pool_created_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(HypersyncLog) -> anyhow::Result<PoolCreatedEvent>,
    ) {
        self.parse_pool_created_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse initialize events from HyperSync logs.
    pub fn set_initialize_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<InitializeEvent>,
    ) {
        self.parse_initialize_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse swap events from HyperSync logs.
    pub fn set_swap_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<SwapEvent>,
    ) {
        self.parse_swap_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse mint events from HyperSync logs.
    pub fn set_mint_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<MintEvent>,
    ) {
        self.parse_mint_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse burn events from HyperSync logs.
    pub fn set_burn_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<BurnEvent>,
    ) {
        self.parse_burn_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse collect events from HyperSync logs.
    pub fn set_collect_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<CollectEvent>,
    ) {
        self.parse_collect_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse flash events from HyperSync logs.
    pub fn set_flash_event_hypersync_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &HypersyncLog) -> anyhow::Result<FlashEvent>,
    ) {
        self.parse_flash_event_hypersync_fn = Some(parse_fn);
    }

    /// Sets the function used to parse pool creation events from RPC logs.
    pub fn set_pool_created_event_rpc_parsing(
        &mut self,
        parse_fn: fn(&RpcLog) -> anyhow::Result<PoolCreatedEvent>,
    ) {
        self.parse_pool_created_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse initialize events from RPC logs.
    pub fn set_initialize_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<InitializeEvent>,
    ) {
        self.parse_initialize_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse swap events from RPC logs.
    pub fn set_swap_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<SwapEvent>,
    ) {
        self.parse_swap_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse mint events from RPC logs.
    pub fn set_mint_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<MintEvent>,
    ) {
        self.parse_mint_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse burn events from RPC logs.
    pub fn set_burn_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<BurnEvent>,
    ) {
        self.parse_burn_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse collect events from RPC logs.
    pub fn set_collect_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<CollectEvent>,
    ) {
        self.parse_collect_event_rpc_fn = Some(parse_fn);
    }

    /// Sets the function used to parse flash events from RPC logs.
    pub fn set_flash_event_rpc_parsing(
        &mut self,
        parse_fn: fn(SharedDex, &RpcLog) -> anyhow::Result<FlashEvent>,
    ) {
        self.parse_flash_event_rpc_fn = Some(parse_fn);
    }

    /// Parses a pool creation event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync pool creation event parser defined or if parsing fails.
    pub fn parse_pool_created_event_hypersync(
        &self,
        log: HypersyncLog,
    ) -> anyhow::Result<PoolCreatedEvent> {
        if let Some(parse_fn) = &self.parse_pool_created_event_hypersync_fn {
            parse_fn(log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of pool created event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name,
            )
        }
    }

    /// Parses a swap event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync swap event parser defined or if parsing fails.
    pub fn parse_swap_event_hypersync(&self, log: &HypersyncLog) -> anyhow::Result<SwapEvent> {
        if let Some(parse_fn) = &self.parse_swap_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of swap event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a mint event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync mint event parser defined or if parsing fails.
    pub fn parse_mint_event_hypersync(&self, log: &HypersyncLog) -> anyhow::Result<MintEvent> {
        if let Some(parse_fn) = &self.parse_mint_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of mint event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a burn event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync burn event parser defined or if parsing fails.
    pub fn parse_burn_event_hypersync(&self, log: &HypersyncLog) -> anyhow::Result<BurnEvent> {
        if let Some(parse_fn) = &self.parse_burn_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of burn event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses an initialize event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync initialize event parser defined or if parsing fails.
    pub fn parse_initialize_event_hypersync(
        &self,
        log: &HypersyncLog,
    ) -> anyhow::Result<InitializeEvent> {
        if let Some(parse_fn) = &self.parse_initialize_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of initialize event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a collect event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync collect event parser defined or if parsing fails.
    pub fn parse_collect_event_hypersync(
        &self,
        log: &HypersyncLog,
    ) -> anyhow::Result<CollectEvent> {
        if let Some(parse_fn) = &self.parse_collect_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of collect event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a flash event from a HyperSync log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have a HyperSync flash event parser defined or if parsing fails.
    pub fn parse_flash_event_hypersync(&self, log: &HypersyncLog) -> anyhow::Result<FlashEvent> {
        if let Some(parse_fn) = &self.parse_flash_event_hypersync_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "HyperSync parsing of flash event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a pool creation event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC pool creation event parser defined or if parsing fails.
    pub fn parse_pool_created_event_rpc(&self, log: &RpcLog) -> anyhow::Result<PoolCreatedEvent> {
        if let Some(parse_fn) = &self.parse_pool_created_event_rpc_fn {
            parse_fn(log)
        } else {
            anyhow::bail!(
                "RPC parsing of pool created event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name,
            )
        }
    }

    /// Parses a swap event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC swap event parser defined or if parsing fails.
    pub fn parse_swap_event_rpc(&self, log: &RpcLog) -> anyhow::Result<SwapEvent> {
        if let Some(parse_fn) = &self.parse_swap_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of swap event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a mint event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC mint event parser defined or if parsing fails.
    pub fn parse_mint_event_rpc(&self, log: &RpcLog) -> anyhow::Result<MintEvent> {
        if let Some(parse_fn) = &self.parse_mint_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of mint event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a burn event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC burn event parser defined or if parsing fails.
    pub fn parse_burn_event_rpc(&self, log: &RpcLog) -> anyhow::Result<BurnEvent> {
        if let Some(parse_fn) = &self.parse_burn_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of burn event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses an initialize event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC initialize event parser defined or if parsing fails.
    pub fn parse_initialize_event_rpc(&self, log: &RpcLog) -> anyhow::Result<InitializeEvent> {
        if let Some(parse_fn) = &self.parse_initialize_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of initialize event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a collect event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC collect event parser defined or if parsing fails.
    pub fn parse_collect_event_rpc(&self, log: &RpcLog) -> anyhow::Result<CollectEvent> {
        if let Some(parse_fn) = &self.parse_collect_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of collect event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Parses a flash event from an RPC log.
    ///
    /// # Errors
    ///
    /// Returns an error if the DEX does not have an RPC flash event parser defined or if parsing fails.
    pub fn parse_flash_event_rpc(&self, log: &RpcLog) -> anyhow::Result<FlashEvent> {
        if let Some(parse_fn) = &self.parse_flash_event_rpc_fn {
            parse_fn(self.dex.clone(), log)
        } else {
            anyhow::bail!(
                "RPC parsing of flash event is not defined in this dex: {}:{}",
                self.dex.chain,
                self.dex.name
            )
        }
    }

    /// Checks if this DEX requires pool initialization events.
    #[must_use]
    pub fn needs_initialization(&self) -> bool {
        self.dex.initialize_event.is_some()
    }
}

impl Deref for DexExtended {
    type Target = Dex;

    fn deref(&self) -> &Self::Target {
        &self.dex
    }
}