cleanup

Author: benesjan

noir-projects/noir-contracts/contracts/app/orderbook_contract/src/test/test.nr

@@ -1,4 +1,4 @@
-use crate::{Orderbook, test::utils::setup_orderbook_with_tokens};
+use crate::{Orderbook, test::utils::setup};
 use aztec::{
     protocol_types::{address::AztecAddress, traits::FromField},
     test::helpers::authwit::add_private_authwit_from_call_interface,
@@ -13,8 +13,7 @@ global FULFILL_ORDER_AUTHWIT_NONCE: Field = 2;
 
 #[test]
 unconstrained fn create_order_happy_path() {
-    let (mut env, orderbook_address, token0_address, token1_address, minter, maker) =
-        setup_orderbook_with_tokens(true);
+    let (mut env, orderbook_address, token0_address, token1_address, minter, maker) = setup(true);
 
     let token0 = Token::at(token0_address);
     let orderbook = Orderbook::at(orderbook_address);
@@ -46,8 +45,7 @@ unconstrained fn create_order_happy_path() {
 
 #[test]
 unconstrained fn full_flow() {
-    let (mut env, orderbook_address, token0_address, token1_address, minter, maker) =
-        setup_orderbook_with_tokens(true);
+    let (mut env, orderbook_address, token0_address, token1_address, minter, maker) = setup(true);
 
     let token0 = Token::at(token0_address);
     let token1 = Token::at(token1_address);
@@ -118,8 +116,7 @@ unconstrained fn full_flow() {
 
 #[test(should_fail_with = "ZERO_BID_AMOUNT")]
 unconstrained fn create_order_zero_bid_amount() {
-    let (mut env, orderbook_address, token0_address, token1_address, _, maker) =
-        setup_orderbook_with_tokens(false);
+    let (mut env, orderbook_address, token0_address, token1_address, _, maker) = setup(false);
 
     let orderbook = Orderbook::at(orderbook_address);
 
@@ -139,8 +136,7 @@ unconstrained fn create_order_zero_bid_amount() {
 
 #[test(should_fail_with = "ZERO_ASK_AMOUNT")]
 unconstrained fn create_order_zero_ask_amount() {
-    let (mut env, orderbook_address, token0_address, token1_address, _, maker) =
-        setup_orderbook_with_tokens(false);
+    let (mut env, orderbook_address, token0_address, token1_address, _, maker) = setup(false);
 
     let orderbook = Orderbook::at(orderbook_address);
 
@@ -160,8 +156,7 @@ unconstrained fn create_order_zero_ask_amount() {
 
 #[test(should_fail_with = "BID_TOKEN_IS_INVALID")]
 unconstrained fn create_order_invalid_bid_token() {
-    let (mut env, orderbook_address, _token0_address, token1_address, _, maker) =
-        setup_orderbook_with_tokens(false);
+    let (mut env, orderbook_address, _token0_address, token1_address, _, maker) = setup(false);
 
     let orderbook = Orderbook::at(orderbook_address);
 
@@ -181,8 +176,7 @@ unconstrained fn create_order_invalid_bid_token() {
 
 #[test(should_fail_with = "ASK_TOKEN_IS_INVALID")]
 unconstrained fn create_order_invalid_ask_token() {
-    let (mut env, orderbook_address, token0_address, _token1_address, _, maker) =
-        setup_orderbook_with_tokens(false);
+    let (mut env, orderbook_address, token0_address, _token1_address, _, maker) = setup(false);
 
     let orderbook = Orderbook::at(orderbook_address);
 
@@ -202,8 +196,7 @@ unconstrained fn create_order_invalid_ask_token() {
 
 #[test(should_fail_with = "SAME_TOKEN_TRADE")]
 unconstrained fn create_order_same_tokens() {
-    let (mut env, orderbook_address, token0_address, _token1_address, _, maker) =
-        setup_orderbook_with_tokens(false);
+    let (mut env, orderbook_address, token0_address, _token1_address, _, maker) = setup(false);
 
     let orderbook = Orderbook::at(orderbook_address);
 

noir-projects/noir-contracts/contracts/app/orderbook_contract/src/test/utils.nr

@@ -4,13 +4,27 @@ use aztec::{
 };
 use token::Token;
 
-// Utility function to setup two token contracts
+// Utility function to setup orderbook with two tokens
 // TODO(#16560): Make it possible to return a contract instance directly from setup func
-unconstrained fn setup_tokens(
-    env: &mut TestEnvironment,
-    admin: AztecAddress,
-) -> (AztecAddress, AztecAddress) {
-    // Deploy first token contract
+pub(crate) unconstrained fn setup(
+    with_account_contracts: bool,
+) -> (TestEnvironment, AztecAddress, AztecAddress, AztecAddress, AztecAddress, AztecAddress) {
+    let mut env = TestEnvironment::new();
+
+    // Setup accounts
+    let admin = if with_account_contracts {
+        env.create_contract_account()
+    } else {
+        env.create_light_account()
+    };
+
+    let maker = if with_account_contracts {
+        env.create_contract_account()
+    } else {
+        env.create_light_account()
+    };
+
+    // Deploy tokens
     let token0_initializer = Token::interface().constructor(
         admin,
         "Token00000000000000000000000000",
@@ -20,7 +34,6 @@ unconstrained fn setup_tokens(
     let token0_address =
         env.deploy("@token_contract/Token").with_public_initializer(admin, token0_initializer);
 
-    // Deploy second token contract
     let token1_initializer = Token::interface().constructor(
         admin,
         "Token11111111111111111111111111",
@@ -30,35 +43,13 @@ unconstrained fn setup_tokens(
     let token1_address =
         env.deploy("@token_contract/Token").with_public_initializer(admin, token1_initializer);
 
-    (token0_address, token1_address)
-}
-
-// Utility function to setup orderbook with two tokens
-pub(crate) unconstrained fn setup_orderbook_with_tokens(
-    with_account_contracts: bool,
-) -> (TestEnvironment, AztecAddress, AztecAddress, AztecAddress, AztecAddress, AztecAddress) {
-    let mut env = TestEnvironment::new();
-    let admin = if with_account_contracts {
-        env.create_contract_account()
-    } else {
-        env.create_light_account()
-    };
-
-    let maker = if with_account_contracts {
-        env.create_contract_account()
-    } else {
-        env.create_light_account()
-    };
-
-    let (token0_address, token1_address) = setup_tokens(&mut env, admin);
-
     // Deploy orderbook contract
     let orderbook_initializer = Orderbook::interface().constructor(token0_address, token1_address);
     let orderbook_address =
         env.deploy("Orderbook").with_public_initializer(admin, orderbook_initializer);
 
-    // Admin has minter role and since where this function is used we care about minter role and not about admin role
-    // we name the return value a minter.
+    // The admin has the minter role. Since we only care about the minting capability in the tests, we return the admin
+    // address as 'minter' rather than 'admin'.
     let minter = admin;
 
     (env, orderbook_address, token0_address, token1_address, minter, maker)