FuelLabs · supiket · Jan 9, 2023 · Dec 2, 2022 · Dec 3, 2022 · Dec 3, 2022
diff --git a/AMM/.gitignore b/AMM/.gitignore
@@ -2,3 +2,6 @@ target
 project/contracts/AMM-contract/out
 project/contracts/exchange-contract/out
 project/contracts/exchange-contract/tests/artifacts/malicious-implementation/out
+project/scripts/atomic-add-liquidity/out
+project/scripts/swap-exact-input/out
+project/scripts/swap-exact-output/out
diff --git a/AMM/Cargo.toml b/AMM/Cargo.toml
@@ -3,4 +3,7 @@ resolver = "2"
 members = [
     "./project/contracts/AMM-contract",
     "./project/contracts/exchange-contract",
+    "./project/scripts/atomic-add-liquidity",
+    "./project/scripts/swap-exact-input",
+    "./project/scripts/swap-exact-output",
 ]
diff --git a/AMM/Forc.toml b/AMM/Forc.toml
@@ -3,4 +3,7 @@ members = [
   "./project/contracts/AMM-contract",
   "./project/contracts/exchange-contract",
   "./project/contracts/exchange-contract/tests/artifacts/malicious-implementation",
+  "./project/scripts/atomic-add-liquidity",
+  "./project/scripts/swap-exact-input",
+  "./project/scripts/swap-exact-output",
 ]
diff --git a/AMM/README.md b/AMM/README.md
@@ -29,19 +29,29 @@ The contracts are designed to
 ```
 AMM/
 ├── project/
-|   └── contracts/
+|   ├── contracts/
 |   |   ├── AMM-contract/
-|   |   |   ├── src/main.sw
-|   |   |   └── tests/harness.rs
 |   |   └── exchange-contract/
-|   |       ├── src/main.sw
-|   |       └── tests/harness.rs
-|   └── libraries/
-|       └── src/interface.sw
+|   ├── scripts/
+|   |   ├── atomic-add-liquidity/
+|   |   ├── swap-exact-input/
+|   |   └── swap-exact-output/
+|   ├── libraries/
+|   |   └── src/interface.sw
+|   └── test-utils/
+|       └── src/lib.rs
 ├── README.md
 └── SPECIFICATION.md
 ```
 
+All contracts and scripts have the structure:
+
+```
+contract or script/
+├── src/main.sw
+└── tests/harness.rs
+```
+
 ## Running the project
 
 ### User Interface

diff --git a/AMM/SPECIFICATION.md b/AMM/SPECIFICATION.md
@@ -1,88 +1,87 @@
 Table of Contents
 - [Overview](#overview)
 - [Use Cases](#use-cases)
-    - [Actions that users are able to perform](#actions-that-users-are-able-to-perform)
-        - [AMM Contract](#amm)
-            - [Core Functionality](#core-functionality)
-                - [`initialize()`](#initialize)
-                - [`add_pool()`](#add_pool)
-            - [State Checks](#state-checks)
-                - [`pool()`](#pool)
-        - [Exchange Contract](#exchange)
-            - [Core Functionality](#core-functionality-1)
-                - [`constructor()`](#constructor)
-                - [`deposit()`](#deposit)
-                - [`add_liquidity()`](#add_liquidity)
-                - [`remove_liquidity()`](#remove_liquidity)
-                - [`withdraw()`](#withdraw)
-                - [`swap_exact_input()`](#swap_exact_input)
-                - [`swap_exact_output()`](#swap_exact_output)
-            - [Previews](#previews)
-                - [`preview_add_liquidity()`](#preview_add_liquidity)
-                - [`preview_swap_exact_input()`](#preview_swap_exact_input)
-                - [`preview_swap_exact_output()`](#preview_swap_exact_output)
-            - [State Checks](#state-checks-1)
-                - [`balance()`](#balance)
-                - [`pool_info()`](#pool_info)
+    - [AMM Contract](#amm-contract)
+        - [Core Functionality](#core-functionality)
+            - [`initialize()`](#initialize)
+            - [`add_pool()`](#add_pool)
+        - [State Checks](#state-checks)
+            - [`pool()`](#pool)
+    - [Exchange Contract](#exchange-contract)
+        - [Core Functionality](#core-functionality-1)
+            - [`constructor()`](#constructor)
+            - [`deposit()`](#deposit)
+            - [`add_liquidity()`](#add_liquidity)
+            - [`remove_liquidity()`](#remove_liquidity)
+            - [`withdraw()`](#withdraw)
+            - [`swap_exact_input()`](#swap_exact_input)
+            - [`swap_exact_output()`](#swap_exact_output)
+        - [Previews](#previews)
+             - [`preview_add_liquidity()`](#preview_add_liquidity)
+            - [`preview_swap_exact_input()`](#preview_swap_exact_input)
+            - [`preview_swap_exact_output()`](#preview_swap_exact_output)
+        - [State Checks](#state-checks-1)
+            - [`balance()`](#balance)
+            - [`pool_info()`](#pool_info)
+    - [Scripts](#scripts)
+        - [Atomic Add Liquidity](#atomic-add-liquidity)
+        - [Swap Exact Input](#swap-exact-input)
+        - [Swap Exact Output](#swap-exact-output)
 - [Sequence Diagram](#sequence-diagram)
 
 # Overview
 
 This document provides an overview of the application.
 
-It outlines the use cases, i.e., desirable functionality, in addition to requirements for the smart contracts.
+It outlines the use cases, i.e., desirable functionality, in addition to requirements for the smart contracts and scripts.
 
 # Use Cases
 
 This section contains general information about the functionality of the application and thus does not touch upon any technical aspects.
 
 If you are interested in a functional overview then this is the section for you.
 
-## Actions that users are able to perform
+## AMM Contract
 
-This sub-section details what a user is able to do, e.g., click a button and "x, y, z" happens.
+### Core Functionality 
 
-### AMM Contract
-
-#### Core Functionality 
-
-##### `initialize()`
+#### `initialize()`
 
 1. Specifies the legitimate exchange contract implementation that the AMM will operate with (this is a safety mechanism against adding malicious exchange contract implementations to the AMM)
     1. Requires bytecode root of the desired exchange contract implementation
 
-##### `add_pool()`
+#### `add_pool()`
 1. Adds the liquidity pool for the specified asset pair
     1. If the AMM is initialized
     2. Requires the identifiers of the two assets
     3. Requires the exchange contract identifier that is also the identifier of the liquidity pool asset for the given pair 
         1. If the exchange contract is legitimate, i.e., the bytecode root matches
         2. If the exchange contract defines the pool for the specified asset pair
 
-#### State Checks
+### State Checks
 
-##### `pool()`
+#### `pool()`
 
 1. Returns the exchange contract identifier for an asset pair
     1. Requires the identifiers of the two assets
 
-### Exchange Contract
+## Exchange Contract
 
-#### Core Functionality 
+### Core Functionality 
 
-##### `constructor()`
+#### `constructor()`
 
 1. Allows specifying the asset pair that the liquidity pool in the exchange contract will consist of
     1. If the asset pair for the exchange contract has not already been set 
     2. Requires two different asset identifiers
 
-##### `deposit()`
+#### `deposit()`
 
 1. Deposits an asset into the contract
     1. If the asset pair of the pool is set 
     2. Requires any amount of either asset in the pair
 
-##### `add_liquidity()`
+#### `add_liquidity()`
 
 1. Allows adding liquidity to the pool by using up at least one asset's deposited amount
     1. If the asset pair of the pool is set
@@ -93,7 +92,7 @@ This sub-section details what a user is able to do, e.g., click a button and "x,
     5. Requires the desired liquidity amount
     6. Requires a deadline (block height limit)
 
-##### `remove_liquidity()`
+#### `remove_liquidity()`
 
 1. Allows removing liquidity from the pool
     1. If the asset pair of the pool is set
@@ -102,14 +101,14 @@ This sub-section details what a user is able to do, e.g., click a button and "x,
     4. Requires the minimum amounts of both assets to receive after burning
     5. Requires a deadline (block height limit)
 
-##### `withdraw()`
+#### `withdraw()`
 
 1. Allows withdrawing previously deposited assets without using them to add liquidity 
     1. If the asset pair of the pool is set
     2. If the deposited amount of the asset is sufficient
     3. Requires an amount of either asset to withdraw
 
-##### `swap_exact_input()`
+#### `swap_exact_input()`
 
 1. Allows selling an exact amount of an asset for the other asset 
     1. If the asset pair of the pool is set
@@ -122,7 +121,7 @@ This sub-section details what a user is able to do, e.g., click a button and "x,
     7. Requires a deadline (block height limit)
 
 
-##### `swap_exact_output()`
+#### `swap_exact_output()`
 
 1. Allows selling an asset for an exact amount of the other asset 
     1. If the asset pair of the pool is set
@@ -135,41 +134,65 @@ This sub-section details what a user is able to do, e.g., click a button and "x,
         > **NOTE** This is a safety mechanism against excessive slippage. The [`preview_swap_exact_output()`](#preview_swap_exact_output) function can be used to calculate a reasonable maximum input amount.    
     8. Requires a deadline (block height limit)
 
-#### Previews
+### Previews
 
-##### `preview_add_liquidity()`
+#### `preview_add_liquidity()`
 
 1. Returns the amount of the other asset to input and the liquidity asset amount to receive after an add liquidity operation
     1. If the asset pair of the pool is set 
     2. Requires the amount of an asset to input to [`add_liquidity`](#add_liquidity) 
         > **NOTE** If any liquidity in the contract already exists, than the amount of the other asset is calculated based on the ratio of the assets. Otherwise, the ratio is assumed to be 1.   
 
-##### `preview_swap_exact_input()`
+#### `preview_swap_exact_input()`
 
 1. Returns the minimum output amount to receive after a [`swap_exact_input`](#swap_exact_input) and whether the output asset reserves are sufficient for the swap
     1. If the asset pair of the pool is set 
     2. Requires an exact amount of either asset to sell
 
-##### `preview_swap_exact_output()`
+#### `preview_swap_exact_output()`
 
 1. Returns the maximum input amount for a [`swap_exact_output`](#swap_exact_output) and whether the input asset reserves are sufficient for the swap
     1. If the asset pair of the pool is set
     2. If the output asset reserves are sufficient for the swap
     3. Requires an exact amount of either asset to buy
 
-#### State Checks
+### State Checks
 
-##### `balance()`
+#### `balance()`
 
 1. Returns the asset balance of the sender in the contract 
     1. If the asset pair of the pool is set
     2. Requires the asset identifier to return the balance for
 
-##### `pool_info()`
+#### `pool_info()`
 
 1. Returns the pool info, i.e., the identifiers and amounts of assets and the liquidity pool asset amount 
     1. If the asset pair of the pool is set
 
-## Sequence Diagram
+## Scripts
+
+### `atomic-add-liquidity`
+
+1. Deposits pool assets and adds liquidity
+    1. If desired liquidity is more than 0
+    2. If [`deposit`](#deposit) and [`add_liquidity`](#add_liquidity) conditions are met
+
+### `swap-exact-input`
+
+1. Swaps assets along a route by specifying exact input for each swap
+    1. If the route has at least 2 assets
+    2. If the AMM has a pool for each subsequent asset pair in route
+    3. If the bought amount of the last asset is more than the optional minimum output amount 
+    4. If [`swap_exact_input`](#swap_exact_input) conditions are met
+
+### `swap-exact-output`
+
+1. Swaps assets along a route by specifying exact output for each swap
+    1. If the route has at least 2 assets
+    3. If the AMM has a pool for each subsequent asset pair in route
+    3. If the sold amount of the first asset is less than the specified maximum input amount 
+    4. If [`swap_exact_output`](#swap_exact_output) conditions are met
+
+# Sequence Diagram
 
 ![AMM Sequence Diagram](.docs/amm-sequence-diagram.png)
diff --git a/AMM/project/contracts/AMM-contract/Cargo.toml b/AMM/project/contracts/AMM-contract/Cargo.toml
@@ -6,7 +6,8 @@ edition = "2021"
 license = "Apache-2.0"
 
 [dependencies]
-fuels = { version = "0.33.0", features = ["fuel-core-lib"] }
+fuels = { git = "https://github.com/FuelLabs/fuels-rs.git", features = ["fuel-core-lib"] }
+test-utils = { path = "../../test-utils" }
 tokio = { version = "1.21.0", features = ["rt", "macros"] }
 
 [[test]]

diff --git a/AMM/project/contracts/AMM-contract/src/main.sw b/AMM/project/contracts/AMM-contract/src/main.sw
@@ -32,7 +32,8 @@ impl AMM for Contract {
 
         let exchange_contract = abi(Exchange, pool.into());
         let pool_info = exchange_contract.pool_info();
-        let pair_matches_exchange_pair = (pool_info.asset_a == asset_pair.0 && pool_info.asset_b == asset_pair.1) || (pool_info.asset_a == asset_pair.1 && pool_info.asset_b == asset_pair.0);
+        let pair = pool_info.reserves;
+        let pair_matches_exchange_pair = (pair.a.id == asset_pair.0 && pair.b.id == asset_pair.1) || (pair.a.id == asset_pair.1 && pair.b.id == asset_pair.0);
 
         require(pair_matches_exchange_pair, InitError::PairDoesNotDefinePool);