Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Test/ get available liquidity #107

Closed
wants to merge 1 commit into from
Closed

Test/ get available liquidity #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions contracts/src/contracts/ramps/revolut/revolut.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ pub mod RevolutRamp {
#[storage]
struct Storage {
#[substorage(v0)]
ownable: OwnableComponent::Storage,
pub ownable: OwnableComponent::Storage,
#[substorage(v0)]
registry: RegistryComponent::Storage,
pub registry: RegistryComponent::Storage,
#[substorage(v0)]
escrow: EscrowComponent::Storage,
pub escrow: EscrowComponent::Storage,
token: ContractAddress,
// liquidity_key -> amount
liquidity: Map::<LiquidityKey, u256>,
Expand Down Expand Up @@ -150,7 +150,7 @@ pub mod RevolutRamp {
// initialize owner
self.ownable.initializer(:owner);

self.token.write(token);
self.initializer(:token);
}

//
Expand Down Expand Up @@ -348,6 +348,10 @@ pub mod RevolutRamp {

#[generate_trait]
pub impl InternalImpl of InternalTrait {
fn initializer(ref self: ContractState, token: ContractAddress) {
self.token.write(token);
}

fn _get_available_liquidity(self: @ContractState, liquidity_key: LiquidityKey) -> u256 {
let mut amount = self.liquidity.read(liquidity_key);
let current_timestamp = get_block_timestamp();
Expand Down
185 changes: 174 additions & 11 deletions contracts/src/contracts/ramps/revolut/revolut_test.cairo
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ use snforge_std::{
EventSpyAssertionsTrait, spy_events, declare, DeclareResultTrait, ContractClassTrait, start_cheat_caller_address,
stop_cheat_caller_address, test_address, start_cheat_block_timestamp_global
};
use zkramp::components::registry::interface::IRegistry;
use zkramp::contracts::ramps::revolut::interface::{
ZKRampABIDispatcher, ZKRampABIDispatcherTrait, LiquidityKey, LiquidityShareRequest
ZKRampABIDispatcher, ZKRampABIDispatcherTrait, LiquidityKey, LiquidityShareRequest, IZKRampLiquidity
};
use zkramp::contracts::ramps::revolut::revolut::RevolutRamp::{
Event, LiquidityAdded, LiquidityRetrieved, LiquidityLocked, LiquidityShareRequested, LiquidityShareWithdrawn,
Expand Down Expand Up @@ -1402,29 +1403,191 @@ fn test_available_liquidity_with_withdrawn_requests() {
assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount - requested_amount);
}

// #[test]
#[test]
fn test__get_available_liquidity_empty() {
panic!("Not implemented yet");
let state = RevolutRamp::contract_state_for_testing();
let liquidity_owner = constants::CALLER();
let offchain_id = constants::REVOLUT_ID();
let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id };

// assert no liquidity available
assert_eq!(state._get_available_liquidity(:liquidity_key), 0);
}

// #[test]
#[test]
fn test__get_available_liquidity_without_requests() {
panic!("Not implemented yet");
let (_, erc20) = setup();
let mut revolut_ramp = RevolutRamp::contract_state_for_testing();
let liquidity_owner = constants::CALLER();
let offchain_id = constants::REVOLUT_ID();
let amount = 42;
let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id };
let contract_address = test_address();

// initialize ramp state
revolut_ramp.initializer(token: erc20.contract_address);

// fund the account
fund_and_approve(token: erc20, recipient: liquidity_owner, spender: contract_address, :amount);

// register offchain ID
start_cheat_caller_address(contract_address, liquidity_owner);
revolut_ramp.registry.register(:offchain_id);

// add liquidity
revolut_ramp.add_liquidity(:amount, :offchain_id);

// assert liquidity is available
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount);
}

// #[test]
#[test]
fn test__get_available_liquidity_with_expired_requests() {
panic!("Not implemented yet");
let (_, erc20) = setup();
let mut revolut_ramp = RevolutRamp::contract_state_for_testing();
let contract_address = test_address();

// off-ramper
let liquidity_owner = constants::CALLER();
let offchain_id = constants::REVOLUT_ID();
let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id };
let amount = 100;

// on-ramper
let withdrawer = constants::OTHER();
let withdrawer_offchain_id = constants::REVOLUT_ID2();
let requested_amount = 42;

// initialize ramp state
revolut_ramp.initializer(token: erc20.contract_address);

// fund the account
fund_and_approve(token: erc20, recipient: liquidity_owner, spender: contract_address, amount: amount);

// register offchain ID
start_cheat_caller_address(contract_address, liquidity_owner);
revolut_ramp.register(:offchain_id);

// add liquidity
revolut_ramp.add_liquidity(:amount, :offchain_id);

// withdrawer initiates withdrawal
start_cheat_caller_address(contract_address, withdrawer);
revolut_ramp.register(offchain_id: withdrawer_offchain_id);
revolut_ramp
.initiate_liquidity_withdrawal(:liquidity_key, amount: requested_amount, offchain_id: withdrawer_offchain_id);

// assert state before expiration
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount - requested_amount);

// offer expires
start_cheat_block_timestamp_global(MINIMUM_LOCK_DURATION);

// assert state after expiration
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp.available_liquidity(:liquidity_key), amount);
}

// #[test]
#[test]
fn test__get_available_liquidity_with_pending_requests() {
panic!("Not implemented yet");
let (_, erc20) = setup();
let mut revolut_ramp = RevolutRamp::contract_state_for_testing();
let contract_address = test_address();

// off-ramper
let liquidity_owner = constants::CALLER();
let offchain_id = constants::REVOLUT_ID();
let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id };
let amount = 100;

// on-ramper
let withdrawer = constants::OTHER();
let withdrawer_offchain_id = constants::REVOLUT_ID2();
let requested_amount = 42;

// initialize ramp state
revolut_ramp.initializer(token: erc20.contract_address);

// fund the account
fund_and_approve(token: erc20, recipient: liquidity_owner, spender: contract_address, amount: amount);

// register offchain ID
start_cheat_caller_address(contract_address, liquidity_owner);
revolut_ramp.register(:offchain_id);

// add liquidity
revolut_ramp.add_liquidity(:amount, :offchain_id);

// assert state before withdrawal initiated
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount);

// withdrawer initiates withdrawal
start_cheat_caller_address(contract_address, withdrawer);
revolut_ramp.register(offchain_id: withdrawer_offchain_id);
revolut_ramp
.initiate_liquidity_withdrawal(:liquidity_key, amount: requested_amount, offchain_id: withdrawer_offchain_id);

// assert state after withdrawal initiated
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount - requested_amount);

// offer almost expires
start_cheat_block_timestamp_global(MINIMUM_LOCK_DURATION - 1);

// assert state when offer is close to expiration
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount - requested_amount);
}

// #[test]
#[test]
fn test__get_available_liquidity_with_withdrawn_requests() {
panic!("Not implemented yet");
let (_, erc20) = setup();
let mut revolut_ramp = RevolutRamp::contract_state_for_testing();
let contract_address = test_address();

// off-ramper
let liquidity_owner = constants::CALLER();
let offchain_id = constants::REVOLUT_ID();
let liquidity_key = LiquidityKey { owner: liquidity_owner, offchain_id };
let amount = 100;

// on-ramper
let withdrawer = constants::OTHER();
let withdrawer_offchain_id = constants::REVOLUT_ID2();
let requested_amount = 42;
let proof = constants::PROOF();

// initialize ramp state
revolut_ramp.initializer(token: erc20.contract_address);

// fund the account
fund_and_approve(token: erc20, recipient: liquidity_owner, spender: contract_address, amount: amount);

// register offchain ID
start_cheat_caller_address(contract_address, liquidity_owner);
revolut_ramp.register(:offchain_id);

// add liquidity
revolut_ramp.add_liquidity(:amount, :offchain_id);

// withdrawer initiates withdrawal
start_cheat_caller_address(contract_address, withdrawer);
revolut_ramp.register(offchain_id: withdrawer_offchain_id);
revolut_ramp
.initiate_liquidity_withdrawal(:liquidity_key, amount: requested_amount, offchain_id: withdrawer_offchain_id);

// assert state before withdrawal
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount);
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount - requested_amount);

// withdrawers withdraws liquidity
revolut_ramp.withdraw_liquidity(:liquidity_key, offchain_id: withdrawer_offchain_id, :proof);

// assert state after withdrawal
assert_eq!(revolut_ramp.all_liquidity(:liquidity_key), amount - requested_amount);
assert_eq!(revolut_ramp._get_available_liquidity(:liquidity_key), amount - requested_amount);
}

//
Expand Down
Loading