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
use alloy_primitives::U256;
use brontes_types::FastHashMap;
use super::{bit_math, error::UniswapV3MathError};
//Flips the initialized state for a given tick from false to true, or vice
// versa
pub fn flip_tick(
tick_bitmap: &mut FastHashMap<i16, U256>,
tick: i32,
tick_spacing: i32,
) -> Result<(), UniswapV3MathError> {
if (tick % tick_spacing) != 0 {
return Err(UniswapV3MathError::TickSpacingError);
}
let (word_pos, bit_pos) = position(tick / tick_spacing);
let mask = U256::from(1) << bit_pos;
let word = *tick_bitmap.get(&word_pos).unwrap_or(&U256::ZERO);
tick_bitmap.insert(word_pos, word ^ mask);
Ok(())
}
//Returns the next initialized tick contained in the same word (or adjacent
// word) as the tick that is either to the left (less than or equal to) or right
// (greater than) of the given tick
pub fn next_initialized_tick_within_one_word(
tick_bitmap: &FastHashMap<i16, U256>,
tick: i32,
tick_spacing: i32,
lte: bool,
) -> Result<(i32, bool), UniswapV3MathError> {
let compressed = if tick < 0 && tick % tick_spacing != 0 {
(tick / tick_spacing) - 1
} else {
tick / tick_spacing
};
if lte {
let (word_pos, bit_pos) = position(compressed);
let mask = (U256::from(1) << bit_pos) - U256::from(1) + (U256::from(1) << bit_pos);
let masked = *tick_bitmap.get(&word_pos).unwrap_or(&U256::ZERO) & mask;
let initialized = !masked.is_zero();
let next = if initialized {
(compressed
- (bit_pos
.overflowing_sub(bit_math::most_significant_bit(masked)?)
.0) as i32)
* tick_spacing
} else {
(compressed - bit_pos as i32) * tick_spacing
};
Ok((next, initialized))
} else {
let (word_pos, bit_pos) = position(compressed + 1);
let mask = !((U256::from(1) << bit_pos) - U256::from(1));
let masked = *tick_bitmap.get(&word_pos).unwrap_or(&U256::ZERO) & mask;
let initialized = !masked.is_zero();
let next = if initialized {
(compressed
+ 1
+ (bit_math::least_significant_bit(masked)?
.overflowing_sub(bit_pos)
.0) as i32)
* tick_spacing
} else {
(compressed + 1 + ((0xFF - bit_pos) as i32)) * tick_spacing
};
Ok((next, initialized))
}
}
//Computes the position in the mapping where the initialized bit for a tick
// lives
pub fn position(tick: i32) -> (i16, u8) {
((tick >> 8) as i16, (tick % 256) as u8)
}
// #[cfg(test)]
// mod test {
// use std::{collections::FastHashMap, vec};
//
// use ethers::types::U256;
//
// use super::{flip_tick, next_initialized_tick_within_one_word};
//
// pub fn init_test_ticks() -> eyre::Result<FastHashMap<i16, U256>> {
// let test_ticks = vec![-200, -55, -4, 70, 78, 84, 139, 240, 535];
// let mut tick_bitmap: FastHashMap<i16, U256> = FastHashMap::default();
// for tick in test_ticks {
// flip_tick(&mut tick_bitmap, tick, 1)?;
// }
// Ok(tick_bitmap)
// }
//
// pub fn initialized(tick: i32, tick_bitmap: &FastHashMap<i16, U256>) ->
// eyre::Result<bool> { let (next, initialized) =
// next_initialized_tick_within_one_word(tick_bitmap, tick, 1,
// true)?; if next == tick {
// Ok(initialized)
// } else {
// Ok(false)
// }
// }
//
// #[test]
// pub fn test_next_initialized_tick_within_one_word_lte_false() ->
// eyre::Result<()> { let mut tick_bitmap = init_test_ticks()?;
// //returns tick to right if at initialized tick
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 78, 1,
// false)?; assert_eq!(next, 84);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// // //returns the tick directly to the right
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 77, 1,
// false)?;
//
// assert_eq!(next, 78);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// // //returns the tick directly to the right
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, -56, 1,
// false)?;
//
// assert_eq!(next, -55);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //returns the next words initialized tick if on the right boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 255, 1,
// false)?;
//
// assert_eq!(next, 511);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //returns the next words initialized tick if on the right boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, -257, 1,
// false)?;
//
// assert_eq!(next, -200);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //returns the next initialized tick from the next word
// flip_tick(&mut tick_bitmap, 340, 1)?;
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 328, 1,
// false)?;
//
// assert_eq!(next, 340);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //does not exceed boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 508, 1,
// false)?;
//
// assert_eq!(next, 511);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //skips entire word
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 255, 1,
// false)?;
//
// assert_eq!(next, 511);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //skips half word
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 383, 1,
// false)?;
//
// assert_eq!(next, 511);
// assert_eq!(initialized, false);
// Ok(())
// }
//
// #[test]
// pub fn test_next_initialized_tick_within_one_word_lte_true() ->
// eyre::Result<()> { let mut tick_bitmap = init_test_ticks()?;
// //returns same tick if initialized
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 78, 1, true)?;
// assert_eq!(next, 78);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //returns tick directly to the left of input tick if not initialized
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 79, 1, true)?;
//
// assert_eq!(next, 78);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //will not exceed the word boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 258, 1,
// true)?;
//
// assert_eq!(next, 256);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //at the word boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 256, 1,
// true)?;
//
// assert_eq!(next, 256);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //word boundary less 1 (next initialized tick in next word)',
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 72, 1, true)?;
//
// assert_eq!(next, 70);
// assert_eq!(initialized, true);
// tick_bitmap = init_test_ticks()?;
// //word boundary
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, -257, 1,
// true)?;
//
// assert_eq!(next, -512);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //entire empty word
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 1023, 1,
// true)?;
//
// assert_eq!(next, 768);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //halfway through empty word
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 900, 1,
// true)?;
//
// assert_eq!(next, 768);
// assert_eq!(initialized, false);
// tick_bitmap = init_test_ticks()?;
// //boundary is initialized
// flip_tick(&mut tick_bitmap, 329, 1)?;
// let (next, initialized) =
// next_initialized_tick_within_one_word(&tick_bitmap, 456, 1,
// true)?;
//
// assert_eq!(next, 329);
// assert_eq!(initialized, true);
// Ok(())
// }
//
// #[test]
// pub fn test_initialized() -> eyre::Result<()> {
// //is false at first
// let mut tick_bitmap: FastHashMap<i16, U256> = FastHashMap::default();
// let is_initialized = initialized(1, &tick_bitmap)?;
//
// assert_eq!(is_initialized, false);
// //is flipped by #flipTick
// flip_tick(&mut tick_bitmap, 1, 1)?;
// let is_initialized: bool = initialized(1, &tick_bitmap)?;
// assert_eq!(is_initialized, true);
//
// //is flipped back by #flipTick
// tick_bitmap.clear();
// flip_tick(&mut tick_bitmap, 1, 1)?;
// flip_tick(&mut tick_bitmap, 1, 1)?;
// let is_initialized = initialized(1, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
//
// //is not changed by another flip to a different tick
// tick_bitmap.clear();
// flip_tick(&mut tick_bitmap, 2, 1)?;
// let is_initialized = initialized(1, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
//
// //is not changed by another flip to a different tick on another word
// tick_bitmap.clear();
// flip_tick(&mut tick_bitmap, 1 + 256, 1)?;
// let is_initialized = initialized(257, &tick_bitmap)?;
// assert_eq!(is_initialized, true);
// let is_initialized = initialized(1, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// Ok(())
// }
//
// #[test]
// pub fn test_flip_tick() -> eyre::Result<()> {
// //flips only the specified tick
// let mut tick_bitmap = FastHashMap::default();
// flip_tick(&mut tick_bitmap, -230, 1)?;
// let is_initialized = initialized(-230, &tick_bitmap)?;
// assert_eq!(is_initialized, true);
// let is_initialized = initialized(-231, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-229, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-230 + 256, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-230 - 256, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// flip_tick(&mut tick_bitmap, -230, 1)?;
// let is_initialized = initialized(-230, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-231, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-229, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-230 + 256, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// let is_initialized = initialized(-230 - 256, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
// //reverts only itself
// tick_bitmap.clear();
// flip_tick(&mut tick_bitmap, -230, 1)?;
// flip_tick(&mut tick_bitmap, -259, 1)?;
// flip_tick(&mut tick_bitmap, -229, 1)?;
// flip_tick(&mut tick_bitmap, 500, 1)?;
// flip_tick(&mut tick_bitmap, -259, 1)?;
// flip_tick(&mut tick_bitmap, -229, 1)?;
// flip_tick(&mut tick_bitmap, -259, 1)?;
// let is_initialized = initialized(-259, &tick_bitmap)?;
// assert_eq!(is_initialized, true);
// let is_initialized = initialized(-229, &tick_bitmap)?;
// assert_eq!(is_initialized, false);
//
// Ok(())
// }
// }