Skip to main content

nautilus_blockchain/exchanges/parsing/uniswap_v3/
mint.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16use alloy::{dyn_abi::SolType, primitives::Address, sol};
17use nautilus_model::defi::{PoolIdentifier, SharedDex, rpc::RpcLog};
18use ustr::Ustr;
19
20use crate::{
21    events::mint::MintEvent,
22    exchanges::parsing::core,
23    hypersync::{
24        HypersyncLog,
25        log::{
26            extract_address_from_topic, extract_block_hash, extract_block_number,
27            extract_log_index, extract_transaction_hash, extract_transaction_index,
28            validate_event_signature_hash,
29        },
30    },
31    rpc::log as rpc_log,
32};
33
34const MINT_EVENT_SIGNATURE_HASH: &str =
35    "7a53080ba414158be7ec69b987b5fb7d07dee101fe85488f0853ae16239d0bde";
36
37// Define sol macro for easier parsing of Mint event data
38// It contains 4 parameters of 32 bytes each:
39// sender (address), amount (uint128), amount0 (uint256), amount1 (uint256)
40sol! {
41    struct MintEventData {
42        address sender;
43        uint128 amount;
44        uint256 amount0;
45        uint256 amount1;
46    }
47}
48
49/// Parses a mint event from a HyperSync log.
50///
51/// # Errors
52///
53/// Returns an error if the log parsing fails or if the event data is invalid.
54///
55/// # Panics
56///
57/// Panics if the contract address is not set in the log.
58pub fn parse_mint_event_hypersync(dex: SharedDex, log: &HypersyncLog) -> anyhow::Result<MintEvent> {
59    validate_event_signature_hash("Mint", MINT_EVENT_SIGNATURE_HASH, log)?;
60
61    let owner = extract_address_from_topic(log, 1, "owner")?;
62
63    // Extract int24 tickLower from topic2 (stored as a 32-byte padded value)
64    let tick_lower = match log.topics.get(2).and_then(|t| t.as_ref()) {
65        Some(topic) => {
66            let tick_lower_bytes: [u8; 32] = topic.as_ref().try_into()?;
67            i32::from_be_bytes(tick_lower_bytes[28..32].try_into()?)
68        }
69        None => anyhow::bail!("Missing tickLower in topic2 when parsing mint event"),
70    };
71
72    // Extract int24 tickUpper from topic3 (stored as a 32-byte padded value)
73    let tick_upper = match log.topics.get(3).and_then(|t| t.as_ref()) {
74        Some(topic) => {
75            let tick_upper_bytes: [u8; 32] = topic.as_ref().try_into()?;
76            i32::from_be_bytes(tick_upper_bytes[28..32].try_into()?)
77        }
78        None => anyhow::bail!("Missing tickUpper in topic3 when parsing mint event"),
79    };
80
81    if let Some(data) = &log.data {
82        let data_bytes = data.as_ref();
83
84        // Validate if data contains 4 parameters of 32 bytes each
85        if data_bytes.len() < 4 * 32 {
86            anyhow::bail!("Mint event data is too short");
87        }
88
89        // Decode the data using the MintEventData struct
90        let decoded = match <MintEventData as SolType>::abi_decode(data_bytes) {
91            Ok(decoded) => decoded,
92            Err(e) => anyhow::bail!("Failed to decode mint event data: {e}"),
93        };
94
95        let pool_address = Address::from_slice(
96            log.address
97                .clone()
98                .expect("Contract address should be set in logs")
99                .as_ref(),
100        );
101        let pool_identifier = PoolIdentifier::Address(Ustr::from(&pool_address.to_string()));
102        Ok(MintEvent::new(
103            dex,
104            pool_identifier,
105            extract_block_number(log)?,
106            extract_block_hash(log),
107            extract_transaction_hash(log)?,
108            extract_transaction_index(log)?,
109            extract_log_index(log)?,
110            decoded.sender,
111            owner,
112            tick_lower,
113            tick_upper,
114            decoded.amount,
115            decoded.amount0,
116            decoded.amount1,
117        ))
118    } else {
119        Err(anyhow::anyhow!("Missing data in mint event log"))
120    }
121}
122
123/// Parses a mint event from an RPC log.
124///
125/// # Errors
126///
127/// Returns an error if the log parsing fails or if the event data is invalid.
128pub fn parse_mint_event_rpc(dex: SharedDex, log: &RpcLog) -> anyhow::Result<MintEvent> {
129    rpc_log::validate_event_signature(log, MINT_EVENT_SIGNATURE_HASH, "Mint")?;
130
131    let owner = rpc_log::extract_address_from_topic(log, 1, "owner")?;
132
133    // Extract int24 tickLower from topic2 (stored as a 32-byte padded value)
134    let tick_lower_bytes = rpc_log::extract_topic_bytes(log, 2)?;
135    let tick_lower = core::extract_i32_from_bytes(&tick_lower_bytes)?;
136
137    // Extract int24 tickUpper from topic3 (stored as a 32-byte padded value)
138    let tick_upper_bytes = rpc_log::extract_topic_bytes(log, 3)?;
139    let tick_upper = core::extract_i32_from_bytes(&tick_upper_bytes)?;
140
141    let data_bytes = rpc_log::extract_data_bytes(log)?;
142
143    // Validate if data contains 4 parameters of 32 bytes each
144    if data_bytes.len() < 4 * 32 {
145        anyhow::bail!("Mint event data is too short");
146    }
147
148    // Decode the data using the MintEventData struct
149    let decoded = match <MintEventData as SolType>::abi_decode(&data_bytes) {
150        Ok(decoded) => decoded,
151        Err(e) => anyhow::bail!("Failed to decode mint event data: {e}"),
152    };
153
154    let pool_address = rpc_log::extract_address(log)?;
155    let pool_identifier = PoolIdentifier::Address(Ustr::from(&pool_address.to_string()));
156    Ok(MintEvent::new(
157        dex,
158        pool_identifier,
159        rpc_log::extract_block_number(log)?,
160        rpc_log::extract_block_hash(log)?,
161        rpc_log::extract_transaction_hash(log)?,
162        rpc_log::extract_transaction_index(log)?,
163        rpc_log::extract_log_index(log)?,
164        decoded.sender,
165        owner,
166        tick_lower,
167        tick_upper,
168        decoded.amount,
169        decoded.amount0,
170        decoded.amount1,
171    ))
172}
173
174#[cfg(test)]
175mod tests {
176    use std::{str::FromStr, sync::Arc};
177
178    use alloy::primitives::{B256, U256};
179    use rstest::*;
180    use serde_json::json;
181
182    use super::*;
183    use crate::exchanges::arbitrum;
184
185    /// Real HyperSync log from Arbitrum Mint event at block 391053023
186    /// Pool: 0xd13040d4fe917ee704158cfcb3338dcd2838b245
187    /// owner: 0xc36442b4a4522e871399cd717abdd847ab11fe88 (NonfungiblePositionManager)
188    /// tickLower: -887272 (0xfff27618)
189    /// tickUpper: 887272 (0x0d89e8)
190    #[fixture]
191    fn hypersync_log() -> HypersyncLog {
192        let log_json = json!({
193            "removed": null,
194            "log_index": "0x8",
195            "transaction_index": "0x3",
196            "transaction_hash": "0x8f91d60156ea7a34a6bf1d411852f3ef2ad255ec84e493c9e902e4a1ff4a46af",
197            "block_hash": null,
198            "block_number": "0x175122df",
199            "address": "0xd13040d4fe917EE704158CfCB3338dCd2838B245",
200            "data": "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88000000000000000000000000000000000000000000000074009aac72ba0a9b1c00000000000000000000000000000000000000000001e4d2be93cf3635c879b10000000000000000000000000000000000000000000000001bc16d674ec80000",
201            "topics": [
202                "0x7a53080ba414158be7ec69b987b5fb7d07dee101fe85488f0853ae16239d0bde",
203                "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88",
204                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffff27618",
205                "0x00000000000000000000000000000000000000000000000000000000000d89e8"
206            ]
207        });
208        serde_json::from_value(log_json).expect("Failed to deserialize HyperSync log")
209    }
210
211    /// Real RPC log from Arbitrum Mint event at block 391053023
212    #[fixture]
213    fn rpc_log() -> RpcLog {
214        let log_json = json!({
215            "removed": false,
216            "logIndex": "0x8",
217            "transactionIndex": "0x3",
218            "transactionHash": "0x8f91d60156ea7a34a6bf1d411852f3ef2ad255ec84e493c9e902e4a1ff4a46af",
219            "blockHash": "0xfc49f94161e2cdef8339c0b430868d64ee1f5d0bd8b8b6e45a25487958d68b25",
220            "blockNumber": "0x175122df",
221            "address": "0xd13040d4fe917EE704158CfCB3338dCd2838B245",
222            "data": "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88000000000000000000000000000000000000000000000074009aac72ba0a9b1c00000000000000000000000000000000000000000001e4d2be93cf3635c879b10000000000000000000000000000000000000000000000001bc16d674ec80000",
223            "topics": [
224                "0x7a53080ba414158be7ec69b987b5fb7d07dee101fe85488f0853ae16239d0bde",
225                "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88",
226                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffff27618",
227                "0x00000000000000000000000000000000000000000000000000000000000d89e8"
228            ]
229        });
230        serde_json::from_value(log_json).expect("Failed to deserialize RPC log")
231    }
232
233    #[rstest]
234    fn test_parse_mint_event_hypersync(hypersync_log: HypersyncLog) {
235        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
236        let event = parse_mint_event_hypersync(dex, &hypersync_log).unwrap();
237
238        assert_eq!(event.block_hash, None);
239
240        assert_eq!(
241            event.pool_identifier.to_string(),
242            "0xd13040d4fe917EE704158CfCB3338dCd2838B245"
243        );
244        assert_eq!(
245            event.owner.to_string().to_lowercase(),
246            "0xc36442b4a4522e871399cd717abdd847ab11fe88"
247        );
248        assert_eq!(event.tick_lower, -887272);
249        assert_eq!(event.tick_upper, 887272);
250        assert_eq!(event.block_number, 391193311);
251        let expected_amount = u128::from_str_radix("74009aac72ba0a9b1c", 16).unwrap();
252        assert_eq!(event.amount, expected_amount);
253        let expected_amount0 = U256::from_str_radix("1e4d2be93cf3635c879b1", 16).unwrap();
254        assert_eq!(event.amount0, expected_amount0);
255        let expected_amount1 = U256::from_str_radix("1bc16d674ec80000", 16).unwrap();
256        assert_eq!(event.amount1, expected_amount1);
257    }
258
259    #[rstest]
260    fn test_parse_mint_event_rpc(rpc_log: RpcLog) {
261        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
262        let event = parse_mint_event_rpc(dex, &rpc_log).unwrap();
263
264        let expected =
265            B256::from_str("0xfc49f94161e2cdef8339c0b430868d64ee1f5d0bd8b8b6e45a25487958d68b25")
266                .unwrap();
267        assert_eq!(event.block_hash, Some(expected));
268
269        assert_eq!(
270            event.pool_identifier.to_string(),
271            "0xd13040d4fe917EE704158CfCB3338dCd2838B245"
272        );
273        assert_eq!(
274            event.owner.to_string().to_lowercase(),
275            "0xc36442b4a4522e871399cd717abdd847ab11fe88"
276        );
277        assert_eq!(event.tick_lower, -887272);
278        assert_eq!(event.tick_upper, 887272);
279        assert_eq!(event.block_number, 391193311);
280        let expected_amount = u128::from_str_radix("74009aac72ba0a9b1c", 16).unwrap();
281        assert_eq!(event.amount, expected_amount);
282        let expected_amount0 = U256::from_str_radix("1e4d2be93cf3635c879b1", 16).unwrap();
283        assert_eq!(event.amount0, expected_amount0);
284        let expected_amount1 = U256::from_str_radix("1bc16d674ec80000", 16).unwrap();
285        assert_eq!(event.amount1, expected_amount1);
286    }
287
288    #[rstest]
289    #[case(2, 1)]
290    #[case(3, 1)]
291    #[case(2, 31)]
292    #[case(2, 33)]
293    fn test_parse_mint_event_rpc_rejects_noncanonical_tick_topic(
294        mut rpc_log: RpcLog,
295        #[case] topic_index: usize,
296        #[case] byte_len: usize,
297    ) {
298        let valid_log = rpc_log.clone();
299        rpc_log.topics[topic_index] = format!("0x{}", "00".repeat(byte_len));
300        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
301
302        let error = parse_mint_event_rpc(Arc::clone(&dex), &rpc_log).unwrap_err();
303        let event = parse_mint_event_rpc(dex, &valid_log).unwrap();
304
305        assert_eq!(
306            error.to_string(),
307            format!("Topic must be 32 bytes, was {byte_len}")
308        );
309        assert_eq!(event.block_number, 391193311);
310    }
311
312    #[rstest]
313    fn test_hypersync_rpc_match(hypersync_log: HypersyncLog, rpc_log: RpcLog) {
314        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
315        let event_hypersync = parse_mint_event_hypersync(Arc::clone(&dex), &hypersync_log).unwrap();
316        let event_rpc = parse_mint_event_rpc(dex, &rpc_log).unwrap();
317
318        // Both parsers should produce identical results
319        assert_eq!(event_hypersync.pool_identifier, event_rpc.pool_identifier);
320        assert_eq!(event_hypersync.owner, event_rpc.owner);
321        assert_eq!(event_hypersync.tick_lower, event_rpc.tick_lower);
322        assert_eq!(event_hypersync.tick_upper, event_rpc.tick_upper);
323        assert_eq!(event_hypersync.block_number, event_rpc.block_number);
324        assert_eq!(event_hypersync.transaction_hash, event_rpc.transaction_hash);
325        assert_eq!(event_hypersync.sender, event_rpc.sender);
326        assert_eq!(event_hypersync.amount, event_rpc.amount);
327        assert_eq!(event_hypersync.amount0, event_rpc.amount0);
328        assert_eq!(event_hypersync.amount1, event_rpc.amount1);
329    }
330}