From 51564982d4589e2d3eef043ff90a07836b0aa787 Mon Sep 17 00:00:00 2001 From: 0xChqrles Date: Sat, 28 Sep 2024 12:14:22 +0200 Subject: [PATCH] minor improvements --- .../src/contracts/ramps/revolut/revolut.cairo | 4 +- .../ramps/revolut/revolut_test.cairo | 81 +++++++++---------- contracts/src/tests/constants.cairo | 4 + 3 files changed, 44 insertions(+), 45 deletions(-) diff --git a/contracts/src/contracts/ramps/revolut/revolut.cairo b/contracts/src/contracts/ramps/revolut/revolut.cairo index 958ca70..377ac05 100644 --- a/contracts/src/contracts/ramps/revolut/revolut.cairo +++ b/contracts/src/contracts/ramps/revolut/revolut.cairo @@ -35,8 +35,8 @@ pub mod RevolutRamp { // Constants // - const LOCK_DURATION_STEP: u64 = 900; // 15min - const MINIMUM_LOCK_DURATION: u64 = 3600; // 1h + pub const LOCK_DURATION_STEP: u64 = 900; // 15min + pub const MINIMUM_LOCK_DURATION: u64 = 3600; // 1h // // Storage diff --git a/contracts/src/contracts/ramps/revolut/revolut_test.cairo b/contracts/src/contracts/ramps/revolut/revolut_test.cairo index a642637..d28724b 100644 --- a/contracts/src/contracts/ramps/revolut/revolut_test.cairo +++ b/contracts/src/contracts/ramps/revolut/revolut_test.cairo @@ -8,7 +8,7 @@ use snforge_std::{ }; use zkramp::contracts::ramps::revolut::interface::{ZKRampABIDispatcher, ZKRampABIDispatcherTrait, LiquidityKey}; use zkramp::contracts::ramps::revolut::revolut::RevolutRamp::{ - Event, LiquidityAdded, LiquidityLocked, LiquidityShareRequested + Event, LiquidityAdded, LiquidityLocked, LiquidityShareRequested, MINIMUM_LOCK_DURATION }; use zkramp::tests::constants; use zkramp::tests::utils; @@ -379,7 +379,7 @@ fn test_retrieve_liquidity_with_expired_requests() { #[should_panic(expected: 'Caller is the owner')] fn test_initiate_liquidity_withdraw_from_owner() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); + let liquidity_owner = constants::CALLER(); let offchain_id = constants::REVOLUT_ID(); let amount = 42; let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id }; @@ -392,7 +392,7 @@ fn test_initiate_liquidity_withdraw_from_owner() { revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // initiate liquidity withdraw revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, :amount, :offchain_id); @@ -402,8 +402,8 @@ fn test_initiate_liquidity_withdraw_from_owner() { #[should_panic(expected: 'Amount cannot be null')] fn test_initiate_liquidity_withdraw_zero_amount() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer = constants::CALLER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer = constants::OTHER(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer = constants::REVOLUT_ID2(); let amount = 42; @@ -417,7 +417,7 @@ fn test_initiate_liquidity_withdraw_zero_amount() { revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // register offchain ID withdrawer start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer); @@ -431,8 +431,8 @@ fn test_initiate_liquidity_withdraw_zero_amount() { #[should_panic(expected: 'Liquidity is not available')] fn test_initiate_liquidity_withdraw_locked() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer = constants::CALLER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer = constants::OTHER(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer = constants::REVOLUT_ID2(); let amount = 42; @@ -446,7 +446,7 @@ fn test_initiate_liquidity_withdraw_locked() { revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // locks liquidity revolut_ramp.initiate_liquidity_retrieval(:liquidity_key); @@ -463,8 +463,8 @@ fn test_initiate_liquidity_withdraw_locked() { #[should_panic(expected: 'Caller is not registered')] fn test_initiate_liquidity_withdraw_with_unregistered_offchain_id() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer = constants::CALLER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer = constants::OTHER(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer = constants::REVOLUT_ID2(); let amount = 42; @@ -478,7 +478,7 @@ fn test_initiate_liquidity_withdraw_with_unregistered_offchain_id() { revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // initiate liquidity withdraw start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer); @@ -489,80 +489,79 @@ fn test_initiate_liquidity_withdraw_with_unregistered_offchain_id() { #[should_panic(expected: 'Not enough liquidity')] fn test_initiate_liquidity_withdraw_without_enough_liquidity() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer = constants::CALLER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer = constants::OTHER(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer = constants::REVOLUT_ID2(); - let amount1 = 42; - let amount2 = 75; + let amount = 42; let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id }; // fund the account - fund_and_approve(token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, amount: amount1); + fund_and_approve(token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, :amount); // register offchain ID owner start_cheat_caller_address(revolut_ramp.contract_address, liquidity_owner); revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount1, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // register offchain ID withdrawer start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer); revolut_ramp.register(offchain_id: offchain_id_withdrawer); // initiate liquidity withdraw - revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount2, offchain_id: offchain_id_withdrawer); + revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount + 1, offchain_id: offchain_id_withdrawer); } #[test] #[should_panic(expected: 'Not enough liquidity')] fn test_initiate_liquidity_withdraw_without_enough_available_liquidity() { let (revolut_ramp, erc20) = setup(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer1 = constants::CALLER(); - let liquidity_withdrawer2 = constants::SPENDER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer1 = constants::OTHER(); + let liquidity_withdrawer2 = constants::OTHER2(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer1 = constants::REVOLUT_ID2(); let offchain_id_withdrawer2 = constants::REVOLUT_ID3(); - let amount1 = 42; - let amount2 = 75; + let amount = 42; let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id }; // fund the account - fund_and_approve(token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, amount: amount2); + fund_and_approve(token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, :amount); // register offchain ID owner start_cheat_caller_address(revolut_ramp.contract_address, liquidity_owner); revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount2, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // register offchain ID withdrawer 1 start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer1); revolut_ramp.register(offchain_id: offchain_id_withdrawer1); // initiate liquidity withdraw - revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount1, offchain_id: offchain_id_withdrawer1); + revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: 1, offchain_id: offchain_id_withdrawer1); - assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount2 - amount1); - assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount2); + // assert state before + assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount - 1); + assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount); // register offchain ID withdrawer 2 start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer2); revolut_ramp.register(offchain_id: offchain_id_withdrawer2); // initiate liquidity withdraw - revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount1, offchain_id: offchain_id_withdrawer2); + revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, :amount, offchain_id: offchain_id_withdrawer2); } #[test] fn test_initiate_liquidity_withdraw() { let (revolut_ramp, erc20) = setup(); let mut spy = spy_events(); - let liquidity_owner = constants::OTHER(); - let liquidity_withdrawer = constants::CALLER(); + let liquidity_owner = constants::CALLER(); + let liquidity_withdrawer = constants::OTHER(); let offchain_id = constants::REVOLUT_ID(); let offchain_id_withdrawer = constants::REVOLUT_ID2(); let amount = 42; @@ -576,7 +575,7 @@ fn test_initiate_liquidity_withdraw() { revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount, :offchain_id); + revolut_ramp.add_liquidity(:amount, :offchain_id); // assert state before assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount); @@ -599,7 +598,6 @@ fn test_initiate_liquidity_withdraw() { spy .assert_emitted( @array![ - (revolut_ramp.contract_address, Event::LiquidityAdded(LiquidityAdded { liquidity_key, amount })), ( revolut_ramp.contract_address, Event::LiquidityShareRequested( @@ -608,7 +606,7 @@ fn test_initiate_liquidity_withdraw() { amount, liquidity_key, offchain_id: offchain_id_withdrawer, - expiration_date: 3600 + expiration_date: MINIMUM_LOCK_DURATION } ) ) @@ -629,14 +627,16 @@ fn test_initiate_liquidity_withdraw_twice() { let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id }; // fund the account - fund_and_approve(token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, amount: amount2); + fund_and_approve( + token: erc20, recipient: liquidity_owner, spender: revolut_ramp.contract_address, amount: amount1 + amount2 + ); // register offchain ID owner start_cheat_caller_address(revolut_ramp.contract_address, liquidity_owner); revolut_ramp.register(:offchain_id); // add liquidity - revolut_ramp.add_liquidity(amount: amount2, :offchain_id); + revolut_ramp.add_liquidity(amount: amount1 + amount2, :offchain_id); // register offchain ID withdrawer start_cheat_caller_address(revolut_ramp.contract_address, liquidity_withdrawer); @@ -644,12 +644,7 @@ fn test_initiate_liquidity_withdraw_twice() { // initiate liquidity withdraw revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount1, offchain_id: offchain_id_withdrawer); - - assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount2 - amount1); - assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount2); - - // initiate a second liquidity withdraw - revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount1, offchain_id: offchain_id_withdrawer); + revolut_ramp.initiate_liquidity_withdrawal(:liquidity_key, amount: amount2, offchain_id: offchain_id_withdrawer); } // #[test] diff --git a/contracts/src/tests/constants.cairo b/contracts/src/tests/constants.cairo index 5435f15..1f37d83 100644 --- a/contracts/src/tests/constants.cairo +++ b/contracts/src/tests/constants.cairo @@ -39,6 +39,10 @@ pub fn OTHER() -> ContractAddress { contract_address_const::<'other'>() } +pub fn OTHER2() -> ContractAddress { + contract_address_const::<'other2'>() +} + pub const SUPPLY: u256 = 1_000_000_000_000_000_000; // 1 ETH