ajna-finance
diff --git a/‎.github/pull_request_template.md
+17-30 b/‎.github/pull_request_template.md
+17-30
diff --git a/‎.github/workflows/slither.yml
+6-7 b/‎.github/workflows/slither.yml
+6-7
diff --git a/‎Makefile
-3 b/‎Makefile
-3
diff --git a/‎README.md
+4-4 b/‎README.md
+4-4
diff --git a/‎src/ERC20Pool.sol
+13-11 b/‎src/ERC20Pool.sol
+13-11
diff --git a/‎src/ERC20PoolFactory.sol
+1-1 b/‎src/ERC20PoolFactory.sol
+1-1
diff --git a/‎src/ERC721Pool.sol
+15-15 b/‎src/ERC721Pool.sol
+15-15
diff --git a/‎src/ERC721PoolFactory.sol
+1-1 b/‎src/ERC721PoolFactory.sol
+1-1
@@ -1,37 +1,24 @@
+## Description
 
-<!---
-No need to add special tag
-src/ & non src/ changes you need the following (that apply):
--->
-# Description of change
-## High level
-* <DESCRIP_OF_CHANGE>
-  * <DESCRIP_OF_SUBCHANGE>
+<!-- Explain what was changed.  For example:
+_Updated rounding in `removeQuoteToken` to round to token precision._ -->
 
-<!---
-Add the `Status: Needs Auditor Approval` tags
-CHANGES IN /SRC DIR:
-- renaming (not retyping or resizing) of variables & methods
-- reordering and moving of functions in files
-- lite moving of functions accross files
-- comments
+## Purpose
 
-src/ changes you need the following (that apply):
--->
+<!-- Explain why the change was made, citing any issues where appropriate.  For example:
+_Resolves audit issue M-333: Removal of quote token may leave dust amounts._
+Or, if the change does not affect deployed contracts: _Resolve rounding issue with invariant E9 to handle tokens with less than 8 decimals._ -->
 
-# Description of bug or vulnerability and solution
-* <PARAGRAPH_EXP_OF_VULN_BUG>
-* <PARAGRAPH_EXP_OF_HOW_CHANGE_SOLVES_VULN_OR_BUG>
+## Impact
 
-# Contract size
-## Pre Change
-<PASTE_OUTPUT_HERE>
-## Post Change
-<PASTE_OUTPUT_HERE>
+<!-- State technical consequences of the change, whether beneficial or detrimental.  For example:
+_Small increase in `removeQuoteToken` gas cost._
+If the change does not affect deployed contracts, feel free to leave _none_. -->
 
-# Gas usage
-## Pre Change
-<PASTE_OUTPUT_HERE>
-## Post Change
-<PASTE_OUTPUT_HERE>
+## Tasks
 
+- [ ] Changes to protocol contracts are covered by unit tests executed by CI.
+- [ ] Protocol contract size limits have not been exceeded.
+- [ ] Gas consumption for impacted transactions have been compared with the target branch, and nontrivial changes cited in the _Impact_ section above.
+- [ ] Scope labels have been assigned as appropriate.
+- [ ] Invariant tests have been manually executed as appropriate for the nature of the change.
@@ -8,6 +8,11 @@ jobs:
         with:
           submodules: recursive
 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
       - name: Install and set solc version
         run: |
           pip install solc-select && solc-select install 0.8.18 && solc-select use 0.8.18
@@ -38,12 +43,6 @@ jobs:
         continue-on-error: true
         id: position-analyzer
 
-      - name: Analyze RewardsManager Contract
-        run: |
-          slither src/RewardsManager.sol
-        continue-on-error: true
-        id: rewards-analyzer
-
       - name: Analyze PoolInfoUtils Contract
         run: |
           slither src/PoolInfoUtils.sol
@@ -52,7 +51,7 @@ jobs:
 
       - name: Analyze Libraries
         run: |
-          slither src/libraries/external/.
+          slither src/libraries/external/
         continue-on-error: true
         id: libraries-analyzer
 
 
@@ -29,8 +29,6 @@ test-invariant-erc20                     :; forge t --mt invariant --nmc ${CONTR
 test-invariant-erc721                    :; forge t --mt invariant --nmc ${CONTRACT_EXCLUDES} --mc ERC721
 test-invariant-position-erc20            :; forge t --mt invariant --nmc ${CONTRACT_EXCLUDES} --mc ERC20PoolPosition 
 test-invariant-position-erc721           :; forge t --mt invariant --nmc ${CONTRACT_EXCLUDES} --mc ERC721PoolPosition
-test-invariant-rewards-erc20             :; forge t --mt invariant --nmc ${CONTRACT_EXCLUDES} --mc ERC20PoolRewards
-test-invariant-rewards-erc721            :; forge t --mt invariant --nmc ${CONTRACT_EXCLUDES} --mc ERC721PoolRewards
 test-invariant                           :; forge t --mt ${MT} --nmc RegressionTest
 test-invariant-erc20-precision           :; ./tests/forge/invariants/test-invariant-erc20-precision.sh
 test-invariant-erc721-precision          :; ./tests/forge/invariants/test-invariant-erc721-precision.sh
@@ -54,7 +52,6 @@ test-swap-load-erc20             :; FOUNDRY_INVARIANT_SHRINK_SEQUENCE=false RUST
 test-regression-all             : test-regression-erc20 test-regression-erc721 test-regression-prototech
 test-regression-erc20           :; forge t --mt test_regression --mc ERC20 --nmc "RealWorldRegression|Prototech"
 test-regression-erc721          :; forge t --mt test_regression --mc ERC721 --nmc "RealWorldRegression|Prototech"
-test-regression-rewards         :; forge t --mt test_regression --mc Rewards --nmc "RealWorldRegression|Prototech"
 test-regression-position        :; forge t --mt test_regression --mc Position --nmc "RealWorldRegression|Prototech"
 test-regression-prototech       :; forge t --mt test_regression --mc Prototech
 test-regression-rw              :; forge t --mt test_regression --mc RealWorldRegression
 
@@ -203,7 +203,7 @@ Record these addresses.  If Etherscan verification fails on the first try, copy
 Failing that, manual verification is possible.  Following steps show how to do this on Goerli (chainId 5), using addresses from the example output above.
 * Open `broadcast/5/run-latest.json` and find the _"libraries"_ section towards the end of the file.
 * Copy/paste the _libraries_ config into the _[profile.default]_ section of `foundry.toml`, replacing the `:` with an `=`.
-* Run the following commands, adjusting addresses as appropriate:
+* Run the following commands, adjusting addresses as appropriate.  _PoolInfoUtilsMulticall_ constructor takes the address of _PoolInfoUtils_. _PositionManager_ constructor takes the factory addresses.
     ```
     forge verify-contract --chain-id 5 --watch 0x14F2474fB5ea9DF82059053c4F85A8C803Ab10C9 ERC20PoolFactory --constructor-args $(cast abi-encode "constructor(address)" ${AJNA_TOKEN})
     forge verify-contract --chain-id 5 --watch 0xb0d1c875B240EE9f6C2c3284a31b10f1EC6De7d2 ERC721PoolFactory --constructor-args $(cast abi-encode "constructor(address)" ${AJNA_TOKEN})
@@ -221,15 +221,15 @@ Failing that, manual verification is possible.  Following steps show how to do t
 
 Validate the deployment by creating a pool.  Set relevant environment variables, and run the following:
 ```
-cast send ${ERC20_POOLFACTORY} "deployPool(address,address,uint256)(address)" \
+cast send ${AJNA_ERC20_POOLFACTORY} "deployPool(address,address,uint256)(address)" \
 	${WBTC_TOKEN} ${DAI_TOKEN} 50000000000000000 \
 	--from ${DEPLOY_ADDRESS} --keystore ${DEPLOY_KEY}
 ```
 
 Where did it deploy the pool?  Let's find out:
 ```
 export ERC20_NON_SUBSET_HASH=0x2263c4378b4920f0bef611a3ff22c506afa4745b3319c50b6d704a874990b8b2
-cast call ${ERC20_POOLFACTORY} "deployedPools(bytes32,address,address)(address)" \
+cast call ${AJNA_ERC20_POOLFACTORY} "deployedPools(bytes32,address,address)(address)" \
 	${ERC20_NON_SUBSET_HASH} ${WBTC_TOKEN} ${DAI_TOKEN}
 ```
 Record the pool address.
@@ -238,6 +238,6 @@ Run an approval to let the contract spend some of your quote token, and then add
 ```
 cast send ${DAI_TOKEN} "approve(address,uint256)" ${WBTC_DAI_POOL} 50000ether \
 	--from ${DEPLOY_ADDRESS} --keystore ${DEPLOY_KEY}
-cast send ${WBTC_DAI_POOL} "addQuoteToken(uint256,uint256)" 100ether 3232 \
+cast send ${WBTC_DAI_POOL} "addQuoteToken(uint256,uint256,uint256)" 100ether 3232 $(($(cast block -f timestamp) + 60)) \
 	--from ${DEPLOY_ADDRESS} --keystore ${DEPLOY_KEY}
 ```
@@ -221,13 +221,14 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
             limitIndex_
         );
 
-        emit RepayDebt(borrowerAddress_, result.quoteTokenToRepay, collateralAmountToPull_, result.newLup);
-
+        amountRepaid_        = result.quoteTokenToRepay;
         // update in memory pool state struct
         poolState.debt       = result.poolDebt;
         poolState.t0Debt     = result.t0PoolDebt;
         poolState.collateral = result.poolCollateral;
 
+        emit RepayDebt(borrowerAddress_, amountRepaid_, collateralAmountToPull_, result.newLup);
+
         // adjust t0Debt2ToCollateral ratio
         _updateT0Debt2ToCollateral(
             result.debtPreAction,
@@ -239,12 +240,12 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
         // update pool interest rate state
         _updateInterestState(poolState, result.newLup);
 
-        if (result.quoteTokenToRepay != 0) {
+        if (amountRepaid_ != 0) {
             // update pool balances t0 debt state
             poolBalances.t0Debt = poolState.t0Debt;
 
             // move amount to repay from sender to pool
-            _transferQuoteTokenFrom(msg.sender, result.quoteTokenToRepay);
+            _transferQuoteTokenFrom(msg.sender, amountRepaid_);
         }
         if (collateralAmountToPull_ != 0) {
             // update pool balances pledged collateral state
@@ -253,8 +254,6 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
             // move collateral from pool to address specified as collateral receiver
             _transferCollateral(collateralReceiver_, collateralAmountToPull_);
         }
-
-        amountRepaid_ = result.quoteTokenToRepay;
     }
 
     /*********************************/
@@ -345,7 +344,7 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
     function settle(
         address borrowerAddress_,
         uint256 maxDepth_
-    ) external override nonReentrant {
+    ) external override nonReentrant returns (uint256 collateralSettled_, bool isBorrowerSettled_) {
         PoolState memory poolState = _accruePoolInterest();
 
         SettleResult memory result = SettlerActions.settlePoolDebt(
@@ -363,6 +362,9 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
         );
 
         _updatePostSettleState(result, poolState);
+
+        collateralSettled_ = result.collateralSettled;
+        isBorrowerSettled_ = (result.debtPostAction == 0);
     }
 
     /**
@@ -401,19 +403,19 @@ contract ERC20Pool is FlashloanablePool, IERC20Pool {
 
         _updatePostTakeState(result, poolState);
 
-        _transferCollateral(callee_, result.collateralAmount);
+        collateralTaken_ = result.collateralAmount;
+
+        _transferCollateral(callee_, collateralTaken_);
 
         if (data_.length != 0) {
             IERC20Taker(callee_).atomicSwapCallback(
-                result.collateralAmount / collateralTokenScale,
+                collateralTaken_ / collateralTokenScale,
                 result.quoteTokenAmount / poolState.quoteTokenScale,
                 data_
             );
         }
 
         _transferQuoteTokenFrom(msg.sender, result.quoteTokenAmount);
-
-        collateralTaken_ = result.collateralAmount;
     }
 
     /**
 
@@ -75,7 +75,7 @@ contract ERC20PoolFactory is PoolDeployer, IERC20PoolFactory {
         deployedPools[ERC20_NON_SUBSET_HASH][collateral_][quote_] = pool_;
         deployedPoolsList.push(pool_);
 
-        emit PoolCreated(pool_);
+        emit PoolCreated(pool_, ERC20_NON_SUBSET_HASH);
 
         pool.initialize(interestRate_);
     }
 
@@ -236,13 +236,14 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
             limitIndex_
         );
 
-        emit RepayDebt(borrowerAddress_, result.quoteTokenToRepay, noOfNFTsToPull_, result.newLup);
-
+        amountRepaid_        = result.quoteTokenToRepay;
         // update in memory pool state struct
         poolState.debt       = result.poolDebt;
         poolState.t0Debt     = result.t0PoolDebt;
         poolState.collateral = result.poolCollateral;
 
+        emit RepayDebt(borrowerAddress_, amountRepaid_, noOfNFTsToPull_, result.newLup);
+
         // adjust t0Debt2ToCollateral ratio
         _updateT0Debt2ToCollateral(
             result.debtPreAction,
@@ -257,19 +258,17 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
         // update pool balances pledged collateral state
         poolBalances.pledgedCollateral = poolState.collateral;
 
-        if (result.quoteTokenToRepay != 0) {
+        if (amountRepaid_ != 0) {
             // update pool balances t0 debt state
             poolBalances.t0Debt = poolState.t0Debt;
 
             // move amount to repay from sender to pool
-            _transferQuoteTokenFrom(msg.sender, result.quoteTokenToRepay);
+            _transferQuoteTokenFrom(msg.sender, amountRepaid_);
         }
         if (noOfNFTsToPull_ != 0) {
             // move collateral from pool to address specified as collateral receiver
             _transferFromPoolToAddress(collateralReceiver_, borrowerTokenIds[msg.sender], noOfNFTsToPull_);
         }
-
-        amountRepaid_ = result.quoteTokenToRepay;
     }
 
     /*********************************/
@@ -344,7 +343,6 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
             // Total collateral in buckets meets the requested removal amount, noOfNFTsToRemove_
             _transferFromPoolToAddress(msg.sender, bucketTokenIds, noOfNFTsToRemove_);
         }
-
     }
 
     /**
@@ -394,7 +392,7 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
     function settle(
         address borrowerAddress_,
         uint256 maxDepth_
-    ) external nonReentrant override {
+    ) external nonReentrant override returns (uint256 collateralSettled_, bool isBorrowerSettled_) {
         PoolState memory poolState = _accruePoolInterest();
 
         SettleParams memory params = SettleParams({
@@ -417,6 +415,9 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
 
         // move token ids from borrower array to pool claimable array if any collateral used to settle bad debt
         _rebalanceTokens(params.borrower, result.collateralRemaining);
+
+        collateralSettled_ = result.collateralSettled;
+        isBorrowerSettled_ = (result.debtPostAction == 0);
     }
 
     /**
@@ -449,10 +450,11 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
         _updatePostTakeState(result, poolState);
 
         // transfer rounded collateral from pool to taker
+        collateralTaken_ = result.collateralAmount / 1e18;
         uint256[] memory tokensTaken = _transferFromPoolToAddress(
             callee_,
             borrowerTokenIds[borrowerAddress_],
-            result.collateralAmount / 1e18
+            collateralTaken_
         );
 
         uint256 totalQuoteTokenAmount = result.quoteTokenAmount + result.excessQuoteToken;
@@ -473,8 +475,6 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
 
         // transfer from pool to borrower the excess of quote tokens after rounding collateral auctioned
         if (result.excessQuoteToken != 0) _transferQuoteToken(borrowerAddress_, result.excessQuoteToken);
-
-        collateralTaken_ = result.collateralAmount / 1e18;
     }
 
     /**
@@ -615,13 +615,13 @@ contract ERC721Pool is FlashloanablePool, IERC721Pool {
     /*******************************/
 
     /// @inheritdoc IERC721PoolState
-    function totalBorrowerTokens(address borrower_) external view override returns(uint256) {
-        return borrowerTokenIds[borrower_].length;
+    function getBorrowerTokenIds(address borrower_) external view override returns(uint256[] memory) {
+        return borrowerTokenIds[borrower_];
     }
 
     /// @inheritdoc IERC721PoolState
-    function totalBucketTokens() external view override returns(uint256) {
-        return bucketTokenIds.length;
+    function getBucketTokenIds() external view override returns(uint256[] memory) {
+        return bucketTokenIds;
     }
 
 }
@@ -85,7 +85,7 @@ contract ERC721PoolFactory is PoolDeployer, IERC721PoolFactory {
         deployedPools[subsetHash][collateral_][quote_] = pool_;
         deployedPoolsList.push(pool_);
 
-        emit PoolCreated(pool_);
+        emit PoolCreated(pool_, subsetHash);
 
         pool.initialize(tokenIds_, interestRate_);
     }
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ contract ERC20PoolFactory is PoolDeployer, IERC20PoolFactory {`
`75`	`75`	`deployedPools[ERC20_NON_SUBSET_HASH][collateral_][quote_] = pool_;`
`76`	`76`	`deployedPoolsList.push(pool_);`
`77`	`77`
`78`		`- emit PoolCreated(pool_);`
	`78`	`+ emit PoolCreated(pool_, ERC20_NON_SUBSET_HASH);`
`79`	`79`
`80`	`80`	`pool.initialize(interestRate_);`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -85,7 +85,7 @@ contract ERC721PoolFactory is PoolDeployer, IERC721PoolFactory {`
`85`	`85`	`deployedPools[subsetHash][collateral_][quote_] = pool_;`
`86`	`86`	`deployedPoolsList.push(pool_);`
`87`	`87`
`88`		`- emit PoolCreated(pool_);`
	`88`	`+ emit PoolCreated(pool_, subsetHash);`
`89`	`89`
`90`	`90`	`pool.initialize(tokenIds_, interestRate_);`
`91`	`91`	`}`