Merge branch 'main' of https://github.com/emarc99/spotnet into fix-685

Author: emarc99

margin/.tool-versions

@@ -1,2 +1,2 @@
 scarb 2.9.4
-starknet-foundry 0.38.0
+starknet-foundry 0.37.0

margin/Scarb.lock

@@ -6,11 +6,17 @@ name = "alexandria_math"
 version = "0.2.1"
 source = "git+https://github.com/keep-starknet-strange/alexandria.git#74cafd429eef374730f2c6fed9a74753103c6fdb"
 
+[[package]]
+name = "ekubo"
+version = "0.1.0"
+source = "git+https://github.com/ekuboprotocol/abis?rev=edb6de8#edb6de8c9baf515f1053bbab3d86825d54a63bc3"
+
 [[package]]
 name = "margin"
 version = "0.1.0"
 dependencies = [
  "alexandria_math",
+ "ekubo",
  "openzeppelin_token",
  "snforge_std",
 ]

margin/Scarb.toml

@@ -9,6 +9,7 @@ edition = "2023_11"
 starknet = "2.9.4"
 openzeppelin_token = "1.0.0"
 alexandria_math = { git = "https://github.com/keep-starknet-strange/alexandria.git" }
+ekubo = { git = "https://github.com/ekuboprotocol/abis", rev = "edb6de8" }
 
 
 [dev-dependencies]

margin/src/interface.cairo

@@ -1,16 +1,29 @@
 use starknet::ContractAddress;
-use crate::types::{TokenAmount, PositionParameters};
+use crate::types::{TokenAmount, PositionParameters, EkuboSlippageLimits};
+use ekubo::types::keys::PoolKey;
 
 #[starknet::interface]
 pub trait IMargin<TContractState> {
     fn deposit(ref self: TContractState, token: ContractAddress, amount: TokenAmount);
     fn withdraw(ref self: TContractState, token: ContractAddress, amount: TokenAmount);
 
     // TODO: Add Ekubo data for swap
-    fn open_margin_position(ref self: TContractState, position_parameters: PositionParameters);
-    fn close_position(ref self: TContractState);
+    fn open_margin_position(
+        ref self: TContractState,
+        position_parameters: PositionParameters,
+        pool_key: PoolKey,
+        ekubo_limits: EkuboSlippageLimits,
+    );
+    fn close_position(
+        ref self: TContractState, pool_key: PoolKey, ekubo_limits: EkuboSlippageLimits,
+    );
 
-    fn liquidate(ref self: TContractState, user: ContractAddress);
+    fn liquidate(
+        ref self: TContractState,
+        user: ContractAddress,
+        pool_key: PoolKey,
+        ekubo_limits: EkuboSlippageLimits,
+    );
 }
 
 #[starknet::interface]

margin/src/margin.cairo

@@ -7,8 +7,16 @@ pub mod Margin {
         storage::{StoragePointerReadAccess, StoragePointerWriteAccess, StoragePathEntry, Map},
         ContractAddress, get_contract_address, get_caller_address,
     };
-    use margin::{interface::IMargin, types::{Position, TokenAmount, PositionParameters}};
+    use margin::{
+        interface::IMargin,
+        types::{Position, TokenAmount, PositionParameters, SwapData, EkuboSlippageLimits},
+    };
     use openzeppelin_token::erc20::interface::{IERC20Dispatcher};
+    use ekubo::{
+        interfaces::core::{ICoreDispatcher, ILocker, ICoreDispatcherTrait},
+        types::{keys::PoolKey, delta::Delta},
+        components::shared_locker::{consume_callback_data, handle_delta, call_core_with_callback},
+    };
 
     #[derive(starknet::Event, Drop)]
     struct Deposit {
@@ -34,11 +42,26 @@ pub mod Margin {
 
     #[storage]
     struct Storage {
+        ekubo_core: ICoreDispatcher,
         treasury_balances: Map<(ContractAddress, ContractAddress), TokenAmount>,
         pools: Map<ContractAddress, TokenAmount>,
         positions: Map<ContractAddress, Position>,
     }
 
+    #[constructor]
+    fn constructor(ref self: ContractState, ekubo_core: ICoreDispatcher) {
+        self.ekubo_core.write(ekubo_core);
+    }
+
+
+    #[generate_trait]
+    pub impl InternalImpl of InternalTrait {
+        fn swap(ref self: ContractState, swap_data: SwapData) -> Delta {
+            call_core_with_callback(self.ekubo_core.read(), @swap_data)
+        }
+    }
+
+
     #[abi(embed_v0)]
     impl Margin of IMargin<ContractState> {
         /// Deposits specified amount of ERC20 tokens into the contract's treasury
@@ -79,9 +102,37 @@ pub mod Margin {
             self.emit(Withdraw { withdrawer, token, amount });
         }
 
-        // TODO: Add Ekubo data for swap
-        fn open_margin_position(ref self: ContractState, position_parameters: PositionParameters) {}
-        fn close_position(ref self: ContractState) {}
-        fn liquidate(ref self: ContractState, user: ContractAddress) {}
+        fn open_margin_position(
+            ref self: ContractState,
+            position_parameters: PositionParameters,
+            pool_key: PoolKey,
+            ekubo_limits: EkuboSlippageLimits,
+        ) {}
+        fn close_position(
+            ref self: ContractState, pool_key: PoolKey, ekubo_limits: EkuboSlippageLimits,
+        ) {}
+        fn liquidate(
+            ref self: ContractState,
+            user: ContractAddress,
+            pool_key: PoolKey,
+            ekubo_limits: EkuboSlippageLimits,
+        ) {}
+    }
+
+
+    #[abi(embed_v0)]
+    impl Locker of ILocker<ContractState> {
+        fn locked(ref self: ContractState, id: u32, data: Span<felt252>) -> Span<felt252> {
+            let core = self.ekubo_core.read();
+            let SwapData { pool_key, params, caller } = consume_callback_data(core, data);
+            let delta = core.swap(pool_key, params);
+
+            handle_delta(core, pool_key.token0, delta.amount0, caller);
+            handle_delta(core, pool_key.token1, delta.amount1, caller);
+
+            let mut arr: Array<felt252> = ArrayTrait::new();
+            Serde::serialize(@delta, ref arr);
+            arr.span()
+        }
     }
 }

margin/src/types.cairo

@@ -1,4 +1,5 @@
 use starknet::ContractAddress;
+use ekubo::{interfaces::core::SwapParameters, types::keys::PoolKey};
 
 pub type TokenAmount = u256;
 pub type Timestamp = u128;
@@ -10,12 +11,25 @@ pub struct PositionParameters {
     pub amount: TokenAmount,
 }
 
-#[derive(Serde, starknet::Store)]
+#[derive(Serde, starknet::Store, Drop)]
 pub struct Position {
     pub initial_token: ContractAddress,
-    pub traded_token: ContractAddress,
+    pub debt_token: ContractAddress,
     pub traded_amount: TokenAmount,
     pub debt: TokenAmount,
     pub is_open: bool,
     pub open_time: Timestamp,
 }
+
+#[derive(Copy, Serde, Drop)]
+pub struct SwapData {
+    pub params: SwapParameters,
+    pub pool_key: PoolKey,
+    pub caller: ContractAddress,
+}
+
+#[derive(Copy, Drop, Serde)]
+pub struct EkuboSlippageLimits {
+    pub lower: u256,
+    pub upper: u256,
+}

margin/tests/constants.cairo

@@ -0,0 +1,23 @@
+pub const DEPOSIT_MOCK_USER: felt252 =
+    0x0038925b0bcf4dce081042ca26a96300d9e181b910328db54a6c89e5451503f5;
+pub const DEPOSIT_MOCK_USER_2: felt252 = 0x1234;
+pub const HYPOTHETICAL_OWNER_ADDR: felt252 =
+    0x059a943ca214c10234b9a3b61c558ac20c005127d183b86a99a8f3c60a08b4ff;
+
+pub mod tokens {
+    pub const ETH: felt252 = 0x49d36570d4e46f48e99674bd3fcc84644ddd6b96f7c741b1562b82f9e004dc7;
+    pub const USDC: felt252 = 0x053c91253bc9682c04929ca02ed00b3e423f6710d2ee7e0d5ebb06f3ecf368a8;
+}
+
+pub mod pool_key {
+    pub const FEE: u128 = 170141183460469235273462165868118016;
+    pub const TICK_SPACING: u128 = 1000;
+    pub const EXTENSION: felt252 = 0;
+}
+
+pub mod contracts {
+    pub const EKUBO_CORE_MAINNET: felt252 =
+        0x00000005dd3d2f4429af886cd1a3b08289dbcea99a294197e9eb43b0e0325b4b;
+    pub const EKUBO_CORE_SEPOLIA: felt252 =
+        0x0444a09d96389aa7148f1aada508e30b71299ffe650d9c97fdaae38cb9a23384;
+}

margin/tests/lib.cairo

@@ -5,3 +5,5 @@ mod utils;
 mod mocks {
     mod erc20_mock;
 }
+
+mod constants;

margin/tests/test_deposit.cairo

@@ -4,15 +4,15 @@ use snforge_std::cheatcodes::execution_info::caller_address::{
     start_cheat_caller_address, stop_cheat_caller_address,
 };
 use margin::interface::{IMarginDispatcherTrait};
-use super::utils::{
-    setup_test_suite, deploy_erc20_mock, setup_user, get_treasury_balance, get_pool_value,
+use super::{
+    utils::{
+        setup_test_suite, deploy_erc20_mock, setup_user, get_treasury_balance, get_pool_value,
+    },
+    constants::{
+        DEPOSIT_MOCK_USER, DEPOSIT_MOCK_USER_2, HYPOTHETICAL_OWNER_ADDR,
+    },
 };
 
-const DEPOSIT_MOCK_USER: felt252 =
-    0x0038925b0bcf4dce081042ca26a96300d9e181b910328db54a6c89e5451503f5;
-const DEPOSIT_MOCK_USER_2: felt252 = 0x1234;
-const HYPOTHETICAL_OWNER_ADDR: felt252 =
-    0x059a943ca214c10234b9a3b61c558ac20c005127d183b86a99a8f3c60a08b4ff;
 
 #[test]
 #[should_panic(expected: 'Amount is zero')]

margin/tests/utils.cairo

@@ -7,6 +7,7 @@ use snforge_std::cheatcodes::execution_info::caller_address::{
 use snforge_std::{declare, ContractClassTrait, DeclareResultTrait};
 use alexandria_math::fast_power::fast_power;
 use margin::types::TokenAmount;
+use super::constants::contracts::EKUBO_CORE_SEPOLIA;
 
 #[derive(Drop)]
 pub struct MarginTestSuite {
@@ -63,7 +64,7 @@ pub fn deploy_erc20_mock_2() -> ContractAddress {
 pub fn setup_test_suite(owner: ContractAddress, token_address: ContractAddress) -> MarginTestSuite {
     let contract = declare("Margin").unwrap().contract_class();
 
-    let (margin_contract, _) = contract.deploy(@array![]).unwrap();
+    let (margin_contract, _) = contract.deploy(@array![EKUBO_CORE_SEPOLIA]).unwrap();
 
     MarginTestSuite {
         margin: IMarginDispatcher { contract_address: margin_contract },