feat(payments): implement trade inner methods (#9)

Author: MohammadNassar1

src/errors.cairo

@@ -1,8 +1,16 @@
+pub const INVALID_AMOUNT_RATIO: felt252 = 'INVALID_AMOUNT_RATIO';
+pub const INVALID_AMOUNT_TOO_LARGE: felt252 = 'INVALID_AMOUNT_TOO_LARGE';
+pub const INVALID_DOWNCAST_AFTER_DIVISION: felt252 = 'INVALID_DOWNCAST_AFTER_DIVISION';
 pub const INVALID_HIGH_FEE: felt252 = 'INVALID_HIGH_FEE';
 pub const INVALID_HIGH_FEE_LIMIT: felt252 = 'INVALID_HIGH_FEE_LIMIT';
+pub const INVALID_STARK_SIGNATURE: felt252 = 'INVALID_STARK_SIGNATURE';
+pub const INVALID_TOKEN_PAIR: felt252 = 'INVALID_TOKEN_PAIR';
+pub const INVALID_TRADE_SAME_USER: felt252 = 'INVALID_TRADE_SAME_USER';
 pub const INVALID_ZERO_ADDRESS: felt252 = 'INVALID_ZERO_ADDRESS';
-pub const ORDER_ALREADY_CANCELED: felt252 = 'ORDER_ALREADY_CANCELED';
-pub const ORDER_WAS_FULFILLED: felt252 = 'ORDER_WAS_FULFILLED';
+pub const INVALID_ZERO_AMOUNT_RATIO: felt252 = 'INVALID_ZERO_AMOUNT_RATIO';
+pub const INVALID_ZERO_TOKEN: felt252 = 'INVALID_ZERO_TOKEN';
+pub const ORDER_EXPIRED: felt252 = 'ORDER_EXPIRED';
 pub const TOKEN_ALREADY_REGISTERED: felt252 = 'TOKEN_ALREADY_REGISTERED';
 pub const TOKEN_NOT_REGISTERED: felt252 = 'TOKEN_NOT_REGISTERED';
 pub const TRANSFER_FAILED: felt252 = 'TRANSFER_FAILED';
+pub const UNALLOWED_ADDRESS: felt252 = 'UNALLOWED_ADDRESS';

src/interface.cairo

@@ -2,31 +2,23 @@ use starknet::ContractAddress;
 use starkware_utils::signature::stark::{HashType, Signature};
 use crate::order::Order;
 
-#[derive(Copy, Drop, Debug, Serde, PartialEq, starknet::Store)]
-pub enum FulfilledStatus {
-    #[default]
-    PartialFulfilled: u128,
-    Fulfilled: u128,
-    Canceled: u128,
-}
-
 #[starknet::interface]
 pub trait IPayments<TContractState> {
     fn trade(
         ref self: TContractState,
-        order_1: Order,
-        order_2: Order,
-        signature_1: Signature,
-        signature_2: Signature,
-        actual_sell_amount: u128,
-        actual_buy_amount: u128,
+        order_a: Order,
+        order_b: Order,
+        signature_a: Signature,
+        signature_b: Signature,
+        order_a_actual_sell_amount: u128,
+        order_a_actual_buy_amount: u128,
     );
 
     fn register_token(ref self: TContractState, token: ContractAddress);
     fn remove_token(ref self: TContractState, token: ContractAddress);
     fn is_token_registered(self: @TContractState, token: ContractAddress) -> bool;
 
-    fn cancel_orders(ref self: TContractState, order_hashes: Span<HashType>);
+    fn cancel_orders(ref self: TContractState, orders: Span<Order>);
 
     // Setters:
 
@@ -40,5 +32,5 @@ pub trait IPayments<TContractState> {
     fn get_fee(self: @TContractState) -> u128;
     fn get_fee_recipient(self: @TContractState) -> ContractAddress;
 
-    fn get_order_fulfillment(self: @TContractState, order_hash: HashType) -> FulfilledStatus;
+    fn get_order_fulfillment(self: @TContractState, order_hash: HashType) -> u128;
 }

src/lib.cairo

@@ -6,3 +6,4 @@ pub mod payments;
 
 #[cfg(test)]
 pub mod tests;
+pub(crate) mod utils;

src/order.cairo

@@ -2,41 +2,31 @@ use core::hash::{Hash, HashStateExTrait, HashStateTrait};
 use core::poseidon::PoseidonTrait;
 use openzeppelin::utils::snip12::StructHash;
 use starknet::ContractAddress;
-use starkware_utils::signature::stark::{HashType, PublicKey};
+use starkware_utils::signature::stark::HashType;
 use starkware_utils::time::time::Timestamp;
 
 #[derive(Drop, Serde, Copy)]
 pub struct Order {
     pub salt: felt252,
     pub expiry: Timestamp,
-    pub owner: ContractAddress,
-    pub public_key: PublicKey,
+    pub user: ContractAddress,
     pub sell_token: ContractAddress,
     pub buy_token: ContractAddress,
     pub sell_amount: u128,
     pub buy_amount: u128,
-    // Addresses the user is willing to trade with. Empty means any address
+    // Addresses the user is willing to trade with. Empty span means any address.
     pub allowed_addresses: Span<ContractAddress>,
 }
 
 pub impl HashOrderImpl<S, +HashStateTrait<S>, +Drop<S>> of Hash<Order, S> {
     fn update_state(mut state: S, value: Order) -> S {
         let Order {
-            salt,
-            expiry,
-            owner,
-            public_key,
-            sell_token,
-            buy_token,
-            sell_amount,
-            buy_amount,
-            allowed_addresses,
+            salt, expiry, user, sell_token, buy_token, sell_amount, buy_amount, allowed_addresses,
         } = value;
         state = state
             .update_with(salt)
             .update_with(expiry)
-            .update_with(owner)
-            .update_with(public_key)
+            .update_with(user)
             .update_with(sell_token)
             .update_with(buy_token)
             .update_with(sell_amount)
@@ -55,8 +45,7 @@ pub impl HashOrderImpl<S, +HashStateTrait<S>, +Drop<S>> of Hash<Order, S> {
 ///   "\"Order\"(
 ///    \"salt\":\"felt\",
 ///    \"expiry\":\"Timestamp\",
-///    \"owner\":\"ContractAddress\",
-///    \"public_key\":\"PublicKey\",
+///    \"user\":\"ContractAddress\",
 ///    \"sell_token\":\"ContractAddress\",
 ///    \"buy_token\":\"ContractAddress\",
 ///    \"sell_amount\":\"u128\",
@@ -68,7 +57,7 @@ pub impl HashOrderImpl<S, +HashStateTrait<S>, +Drop<S>> of Hash<Order, S> {
 ///    )
 /// );
 
-const ORDER_TYPE_HASH: HashType = 0x110a09f78c9cd3ca416d13d90e38007ba8bde2f44ae77b5fd037cb9bfb68117;
+const ORDER_TYPE_HASH: HashType = 0x2d9dc4d67a6cc048d96cd39c037575fa17fc4f4ba67fa9307cd08d3aac3943b;
 
 impl StructHashImpl of StructHash<Order> {
     fn hash_struct(self: @Order) -> HashType {
@@ -85,7 +74,7 @@ mod tests {
     #[test]
     fn test_order_type_hash() {
         let expected = selector!(
-            "\"Order\"(\"salt\":\"felt\",\"expiry\":\"Timestamp\",\"owner\":\"ContractAddress\",\"public_key\":\"PublicKey\",\"sell_token\":\"ContractAddress\",\"buy_token\":\"ContractAddress\",\"sell_amount\":\"u128\",\"buy_amount\":\"u128\",\"allowed_addresses\":\"Span<ContractAddress>\")\"Timestamp\"(\"seconds\":\"u64\")",
+            "\"Order\"(\"salt\":\"felt\",\"expiry\":\"Timestamp\",\"user\":\"ContractAddress\",\"sell_token\":\"ContractAddress\",\"buy_token\":\"ContractAddress\",\"sell_amount\":\"u128\",\"buy_amount\":\"u128\",\"allowed_addresses\":\"Span<ContractAddress>\")\"Timestamp\"(\"seconds\":\"u64\")",
         );
         assert_eq!(ORDER_TYPE_HASH.into_base_16_string(), expected.into_base_16_string());
     }