Description

All types should have both serde traits (i.e. Serialize and Deserialize) - as per C-SERDE.

Tasks

• Implement Serialize for Account
• Implement Deserialize for Account
• Implement Serialize for Order
• Implement Deserialize for Order
• Implement Serialize for Book
• Implement Deserialize for Book

Description

Currently, modifying account holdings are painful to interact with from a user's perspective.

Tasks

• Define add_balance
• Define take_balance
• Define add_holding
• Define take_holding

Reproduction

let acct: Account = Account::new(1, "John Doe".to_string(), 0, HashMap::new());
let res: Result<(), AccountError> = acct.add_balance(1);
assert_eq!(res, Ok(()));

Actual Behaviour

Assert fails, as Account::add_balance returns AccountError::BalanceOutOfBounds.

Expected Behaviour

Assert succeeds, as Account::add_balance returns Ok(()).

Tasks

• Invert conditions in bounds checks for add_balance
• Invert conditions in bounds checks for add_holding

Description

Implement the actual order book data type. This will involve the actual matching engine implementation also.

Tasks

• Define book module
• Define Book type
• Define error types
• Define constructor for Book type
• Define getters/setters
• Define operations
  • Submit
  • Cancel
• Write tests

Description

Accounts represent traders' balances and holdings.

Tasks

• Define the account module
• Define the Account type
• Define constructor
• Define getters and setters
• Write tests

Description

Tasks

• Define orders module
• Define OrderType type
• Define Order type
• Define constructor
• Define getters/setters
• Write tests

Reproduction

let acct: Account = Account::new(1, "John Doe".to_string(), 0, HashMap::new());
let res: Result<(), AccountError> = acct.add_holding("MSFT".to_string(), 1);
assert_eq!(res, Ok(()));

Actual Behaviour

Assert fails, as Account::add_holding returns AccountError::AssetNotFound.

Expected Behaviour

Assert succeeds, as Account::add_holding returns Ok(()).

Tasks

• Handle case of new key submitted to Account::add_holding

Description

As described in #9, the new testing scheme is much more structured than the current ad-hoc names the unit tests are given.

The new naming scheme should be:

test_[function]_[test_case]

E.g.

test_submit_bid_lesser_lesser

Would target test case 1 (as defined in #9).

Tasks

• Rename test_submit_equal_orders
• Rename test_submit_price_mismatch_nocross
• Rename test_submit_price_mismatch_cross

Description

The getters in the account module require consistent naming, compliant with C-GETTER.

Tasks

• Rename all getters for Account type to remove get_ prefix
• Rename set_holdings to set_holding

Description

This is a tracking issue for unit testing of the limit order book implementation, i.e. the book::Book type.

Once this issue is completed, the matching engine should have basic combinatorial test coverage.

Tasks

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17
• 18

Description

Currently, master is failing automated testing!

This is because cargo clippy is upset with the current project state.

Tasks

• Resolve all linting issues