Skip to main content

nautilus_blockchain/exchanges/parsing/uniswap_v3/
collect.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::collect::CollectEvent,
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 COLLECT_EVENT_SIGNATURE_HASH: &str =
35    "70935338e69775456a85ddef226c395fb668b63fa0115f5f20610b388e6ca9c0";
36
37// Define sol macro for easier parsing of Collect event data
38// It contains 3 parameters of 32 bytes each:
39// recipient (address), amount0 (uint128), amount1 (uint128)
40sol! {
41    struct CollectEventData {
42        address recipient;
43        uint128 amount0;
44        uint128 amount1;
45    }
46}
47
48/// Parses a collect event from a Uniswap V3 log.
49///
50/// # Errors
51///
52/// Returns an error if the log parsing fails or if the event data is invalid.
53///
54/// # Panics
55///
56/// Panics if the contract address is not set in the log.
57pub fn parse_collect_event_hypersync(
58    dex: SharedDex,
59    log: &HypersyncLog,
60) -> anyhow::Result<CollectEvent> {
61    validate_event_signature_hash("Collect", COLLECT_EVENT_SIGNATURE_HASH, log)?;
62
63    let owner = extract_address_from_topic(log, 1, "owner")?;
64
65    // Extract int24 tickLower from topic2 (stored as a 32-byte padded value)
66    let tick_lower = match log.topics.get(2).and_then(|t| t.as_ref()) {
67        Some(topic) => {
68            let tick_lower_bytes: [u8; 32] = topic.as_ref().try_into()?;
69            i32::from_be_bytes(tick_lower_bytes[28..32].try_into()?)
70        }
71        None => anyhow::bail!("Missing tickLower in topic2 when parsing collect event"),
72    };
73
74    // Extract int24 tickUpper from topic3 (stored as a 32-byte padded value)
75    let tick_upper = match log.topics.get(3).and_then(|t| t.as_ref()) {
76        Some(topic) => {
77            let tick_upper_bytes: [u8; 32] = topic.as_ref().try_into()?;
78            i32::from_be_bytes(tick_upper_bytes[28..32].try_into()?)
79        }
80        None => anyhow::bail!("Missing tickUpper in topic3 when parsing collect event"),
81    };
82
83    if let Some(data) = &log.data {
84        let data_bytes = data.as_ref();
85
86        // Validate if data contains 3 parameters of 32 bytes each
87        if data_bytes.len() < 3 * 32 {
88            anyhow::bail!("Collect event data is too short");
89        }
90
91        // Decode the data using the CollectEventData struct
92        let decoded = match <CollectEventData as SolType>::abi_decode(data_bytes) {
93            Ok(decoded) => decoded,
94            Err(e) => anyhow::bail!("Failed to decode collect event data: {e}"),
95        };
96
97        let pool_address = Address::from_slice(
98            log.address
99                .clone()
100                .expect("Contract address should be set in logs")
101                .as_ref(),
102        );
103        let pool_identifier = PoolIdentifier::Address(Ustr::from(&pool_address.to_string()));
104        Ok(CollectEvent::new(
105            dex,
106            pool_identifier,
107            extract_block_number(log)?,
108            extract_block_hash(log),
109            extract_transaction_hash(log)?,
110            extract_transaction_index(log)?,
111            extract_log_index(log)?,
112            owner,
113            decoded.recipient,
114            tick_lower,
115            tick_upper,
116            decoded.amount0,
117            decoded.amount1,
118        ))
119    } else {
120        Err(anyhow::anyhow!("Missing data in collect event log"))
121    }
122}
123
124/// Parses a collect event from an RPC log.
125///
126/// # Errors
127///
128/// Returns an error if the log parsing fails or if the event data is invalid.
129pub fn parse_collect_event_rpc(dex: SharedDex, log: &RpcLog) -> anyhow::Result<CollectEvent> {
130    rpc_log::validate_event_signature(log, COLLECT_EVENT_SIGNATURE_HASH, "Collect")?;
131
132    let owner = rpc_log::extract_address_from_topic(log, 1, "owner")?;
133
134    // Extract int24 tickLower from topic2 (stored as a 32-byte padded value)
135    let tick_lower_bytes = rpc_log::extract_topic_bytes(log, 2)?;
136    let tick_lower = core::extract_i32_from_bytes(&tick_lower_bytes)?;
137
138    // Extract int24 tickUpper from topic3 (stored as a 32-byte padded value)
139    let tick_upper_bytes = rpc_log::extract_topic_bytes(log, 3)?;
140    let tick_upper = core::extract_i32_from_bytes(&tick_upper_bytes)?;
141
142    let data_bytes = rpc_log::extract_data_bytes(log)?;
143
144    // Validate if data contains 3 parameters of 32 bytes each
145    if data_bytes.len() < 3 * 32 {
146        anyhow::bail!("Collect event data is too short");
147    }
148
149    // Decode the data using the CollectEventData struct
150    let decoded = match <CollectEventData as SolType>::abi_decode(&data_bytes) {
151        Ok(decoded) => decoded,
152        Err(e) => anyhow::bail!("Failed to decode collect event data: {e}"),
153    };
154
155    let pool_address = rpc_log::extract_address(log)?;
156    let pool_identifier = PoolIdentifier::Address(Ustr::from(&pool_address.to_string()));
157    Ok(CollectEvent::new(
158        dex,
159        pool_identifier,
160        rpc_log::extract_block_number(log)?,
161        rpc_log::extract_block_hash(log)?,
162        rpc_log::extract_transaction_hash(log)?,
163        rpc_log::extract_transaction_index(log)?,
164        rpc_log::extract_log_index(log)?,
165        owner,
166        decoded.recipient,
167        tick_lower,
168        tick_upper,
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;
179    use rstest::*;
180    use serde_json::json;
181
182    use super::*;
183    use crate::exchanges::arbitrum;
184
185    /// Real HyperSync log from Arbitrum Collect event at block 0x175a6484 (391799940)
186    /// Pool: 0xd13040d4fe917ee704158cfcb3338dcd2838b245
187    /// owner: 0xc36442b4a4522e871399cd717abdd847ab11fe88 (NonfungiblePositionManager)
188    /// recipient: 0xa61da382c18d9d5beb905ea192bae25e4c15d512
189    /// tickLower: -139767 (0xfffdde09)
190    /// tickUpper: -139764 (0xfffdde0c)
191    #[fixture]
192    fn hypersync_log() -> HypersyncLog {
193        let log_json = json!({
194            "removed": null,
195            "log_index": "0x11",
196            "transaction_index": "0x5",
197            "transaction_hash": "0x0c70f6d6bcf8508ba620b9d1250c95ad67108e35707c5d7456349ea207051bae",
198            "block_hash": null,
199            "block_number": "0x175a6484",
200            "address": "0xd13040d4fe917EE704158CfCB3338dCd2838B245",
201            "data": "0x000000000000000000000000a61da382c18d9d5beb905ea192bae25e4c15d5120000000000000000000000000000000000000000000000bf28af828dd3ae56340000000000000000000000000000000000000000000000000665eae21b1cffc8",
202            "topics": [
203                "0x70935338e69775456a85ddef226c395fb668b63fa0115f5f20610b388e6ca9c0",
204                "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88",
205                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffdde09",
206                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffdde0c"
207            ]
208        });
209        serde_json::from_value(log_json).expect("Failed to deserialize HyperSync log")
210    }
211
212    /// Real RPC log from Arbitrum Collect event at block 0x175a6484 (391799940)
213    #[fixture]
214    fn rpc_log() -> RpcLog {
215        let log_json = json!({
216            "removed": false,
217            "logIndex": "0x11",
218            "transactionIndex": "0x5",
219            "transactionHash": "0x0c70f6d6bcf8508ba620b9d1250c95ad67108e35707c5d7456349ea207051bae",
220            "blockHash": "0xe925eaa1f5178ceedfa24043a974edb928ddab7195600b6b99ff5403fbf13c8b",
221            "blockNumber": "0x175a6484",
222            "address": "0xd13040d4fe917EE704158CfCB3338dCd2838B245",
223            "data": "0x000000000000000000000000a61da382c18d9d5beb905ea192bae25e4c15d5120000000000000000000000000000000000000000000000bf28af828dd3ae56340000000000000000000000000000000000000000000000000665eae21b1cffc8",
224            "topics": [
225                "0x70935338e69775456a85ddef226c395fb668b63fa0115f5f20610b388e6ca9c0",
226                "0x000000000000000000000000c36442b4a4522e871399cd717abdd847ab11fe88",
227                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffdde09",
228                "0xfffffffffffffffffffffffffffffffffffffffffffffffffffffffffffdde0c"
229            ]
230        });
231        serde_json::from_value(log_json).expect("Failed to deserialize RPC log")
232    }
233
234    #[rstest]
235    fn test_parse_collect_event_hypersync(hypersync_log: HypersyncLog) {
236        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
237        let event = parse_collect_event_hypersync(dex, &hypersync_log).unwrap();
238
239        assert_eq!(event.block_hash, None);
240
241        assert_eq!(
242            event.pool_identifier.to_string(),
243            "0xd13040d4fe917EE704158CfCB3338dCd2838B245"
244        );
245        assert_eq!(
246            event.owner.to_string().to_lowercase(),
247            "0xc36442b4a4522e871399cd717abdd847ab11fe88"
248        );
249        assert_eq!(
250            event.recipient.to_string().to_lowercase(),
251            "0xa61da382c18d9d5beb905ea192bae25e4c15d512"
252        );
253        assert_eq!(event.tick_lower, -139767);
254        assert_eq!(event.tick_upper, -139764);
255        let expected_amount0 = u128::from_str_radix("bf28af828dd3ae5634", 16).unwrap();
256        assert_eq!(event.amount0, expected_amount0);
257        let expected_amount1 = u128::from_str_radix("665eae21b1cffc8", 16).unwrap();
258        assert_eq!(event.amount1, expected_amount1);
259        assert_eq!(event.block_number, 391799940);
260    }
261
262    #[rstest]
263    fn test_parse_collect_event_rpc(rpc_log: RpcLog) {
264        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
265        let event = parse_collect_event_rpc(dex, &rpc_log).unwrap();
266
267        let expected =
268            B256::from_str("0xe925eaa1f5178ceedfa24043a974edb928ddab7195600b6b99ff5403fbf13c8b")
269                .unwrap();
270        assert_eq!(event.block_hash, Some(expected));
271
272        assert_eq!(
273            event.pool_identifier.to_string(),
274            "0xd13040d4fe917EE704158CfCB3338dCd2838B245"
275        );
276        assert_eq!(
277            event.owner.to_string().to_lowercase(),
278            "0xc36442b4a4522e871399cd717abdd847ab11fe88"
279        );
280        assert_eq!(
281            event.recipient.to_string().to_lowercase(),
282            "0xa61da382c18d9d5beb905ea192bae25e4c15d512"
283        );
284        assert_eq!(event.tick_lower, -139767);
285        assert_eq!(event.tick_upper, -139764);
286        let expected_amount0 = u128::from_str_radix("bf28af828dd3ae5634", 16).unwrap();
287        assert_eq!(event.amount0, expected_amount0);
288        let expected_amount1 = u128::from_str_radix("665eae21b1cffc8", 16).unwrap();
289        assert_eq!(event.amount1, expected_amount1);
290        assert_eq!(event.block_number, 391799940);
291    }
292
293    #[rstest]
294    #[case(2, 1)]
295    #[case(3, 1)]
296    #[case(2, 31)]
297    #[case(2, 33)]
298    fn test_parse_collect_event_rpc_rejects_noncanonical_tick_topic(
299        mut rpc_log: RpcLog,
300        #[case] topic_index: usize,
301        #[case] byte_len: usize,
302    ) {
303        let valid_log = rpc_log.clone();
304        rpc_log.topics[topic_index] = format!("0x{}", "00".repeat(byte_len));
305        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
306
307        let error = parse_collect_event_rpc(Arc::clone(&dex), &rpc_log).unwrap_err();
308        let event = parse_collect_event_rpc(dex, &valid_log).unwrap();
309
310        assert_eq!(
311            error.to_string(),
312            format!("Topic must be 32 bytes, was {byte_len}")
313        );
314        assert_eq!(event.block_number, 391799940);
315    }
316
317    #[rstest]
318    fn test_hypersync_rpc_match(hypersync_log: HypersyncLog, rpc_log: RpcLog) {
319        let dex = Arc::clone(&arbitrum::UNISWAP_V3.dex);
320        let event_hypersync =
321            parse_collect_event_hypersync(Arc::clone(&dex), &hypersync_log).unwrap();
322        let event_rpc = parse_collect_event_rpc(dex, &rpc_log).unwrap();
323
324        assert_eq!(event_hypersync.pool_identifier, event_rpc.pool_identifier);
325        assert_eq!(event_hypersync.owner, event_rpc.owner);
326        assert_eq!(event_hypersync.recipient, event_rpc.recipient);
327        assert_eq!(event_hypersync.tick_lower, event_rpc.tick_lower);
328        assert_eq!(event_hypersync.tick_upper, event_rpc.tick_upper);
329        assert_eq!(event_hypersync.amount0, event_rpc.amount0);
330        assert_eq!(event_hypersync.amount1, event_rpc.amount1);
331        assert_eq!(event_hypersync.block_number, event_rpc.block_number);
332        assert_eq!(event_hypersync.transaction_hash, event_rpc.transaction_hash);
333    }
334}