zkCRA PR into merge-create-loan

.gitignore

@@ -17,6 +17,7 @@ coverage
 # IDE
 .idea
 .vscode
+.vs
 
 # Build
 build

contracts/contexts/access-control/entry/renounce-role.sol

@@ -12,7 +12,8 @@ contract ent_renounceRole_AccessControl_v1 is
 {
     /**
      * @notice Grants an address a new role.
-     *
+     * @param role the role to revoke for the account
+     * @param account the address of the respective account to revoke
      * Requirements:
      *  - Sender must be role admin.
      */

contracts/escrow/dapps/DappMods.sol

@@ -8,6 +8,10 @@ import {
 } from "../../settings/platform/libraries/PlatformSettingsLib.sol";
 
 abstract contract DappMods {
+    /**
+     * @notice it checks if the caller to a respective loan escrow is the borrower
+     * @param loanID uint256 of the respective loan escrow
+     */
     modifier onlyBorrower(uint256 loanID) {
         require(
             msg.sender == LibLoans.loan(loanID).borrower,
@@ -16,6 +20,10 @@ abstract contract DappMods {
         _;
     }
 
+    /**
+     * @notice checks if the respective loan escrow is secure
+     * @param loanID uint256 of the respective loan escrow
+     */
     modifier onlySecured(uint256 loanID) {
         require(
             LibLoans.loan(loanID).collateralRatio >=

contracts/escrow/dapps/libraries/LibUniswap.sol

@@ -22,6 +22,7 @@ library LibUniswap {
      * @param path An array of token addresses.
      * @param sourceAmount amount of source token to swap.
      * @param minDestination The minimum amount of output tokens that must be received for the transaction not to revert.
+     * @return amounts is the resulting number of tokens swapped for
      */
     function swap(
         address[] memory path,

contracts/escrow/escrow/ILoansEscrow.sol

@@ -4,12 +4,30 @@ pragma solidity ^0.8.0;
 interface ILoansEscrow {
     function init() external;
 
+    /**
+     * @notice it calls a dapp like YearnFinance at a target contract address with specified calldata
+     * @param dappAddress address of the target contract address
+     * @param dappData encoded abi of the function in our contract we want to call
+     * @return the called data in bytes
+     */
     function callDapp(address dappAddress, bytes calldata dappData)
         external
         returns (bytes memory);
 
+    /**
+     * @notice it approves the spender to spend a maximum amount of a respective token from a token address
+     * @param token address of the respective ERC20 token to approve for the spender
+     * @param spender address of the respective spender who is approved by the token contract
+     */
     function setTokenAllowance(address token, address spender) external;
 
+    /**
+     * @notice it allows user to claim their escrow tokens
+     * @dev only the owner (TellerDiamond) can make this call on behalf of the users
+     * @param token address of the respective token contract to claim tokens from
+     * @param to address where the tokens should be transferred to
+     * @param amount uint256 amount of tokens to be claimed
+     */
     function claimToken(
         address token,
         address to,

contracts/escrow/escrow/LoansEscrow_V1.sol

@@ -33,6 +33,12 @@ contract LoansEscrow_V1 is ILoansEscrow {
         owner = msg.sender;
     }
 
+    /**
+     * @notice it calls a dapp like YearnFinance at a target contract address with specified calldata
+     * @param dappAddress address of the target contract address
+     * @param dappData encoded abi of the function in our contract we want to call
+     * @return resData_ the called data in
+     */
     function callDapp(address dappAddress, bytes calldata dappData)
         external
         override
@@ -46,6 +52,11 @@ contract LoansEscrow_V1 is ILoansEscrow {
         );
     }
 
+    /**
+     * @notice it approves the spender to spend a maximum amount of a respective token from a token address
+     * @param token address of the respective ERC20 token to approve for the spender
+     * @param spender address of the respective spender who is approved by the token contract
+     */
     function setTokenAllowance(address token, address spender)
         external
         override
@@ -54,6 +65,13 @@ contract LoansEscrow_V1 is ILoansEscrow {
         IERC20(token).approve(spender, type(uint256).max);
     }
 
+    /**
+     * @notice it allows user to claim their escrow tokens
+     * @dev only the owner (TellerDiamond) can make this call on behalf of their users
+     * @param token address of the respective token contract to claim tokens from
+     * @param to address where the tokens should be transferred to
+     * @param amount uint256 amount of tokens to be claimed
+     */
     function claimToken(
         address token,
         address to,

contracts/escrow/libraries/LibEscrow.sol

@@ -25,6 +25,11 @@ library LibEscrow {
         e_ = s().loanEscrows[loanID];
     }
 
+    /**
+     * @notice It returns a list of tokens owned by a loan escrow
+     * @param loanID uint256 index used to return our token list
+     * @return t_ which is a list of tokens
+     */
     function getEscrowTokens(uint256 loanID)
         internal
         view
@@ -33,6 +38,12 @@ library LibEscrow {
         t_ = s().escrowTokens[loanID];
     }
 
+    /**
+     * @notice It returns the balance of a respective token in a loan escrow
+     * @param loanID uint256 index used to point to our loan escrow
+     * @param token address of respective token to give us the balance of in our loan escrow
+     * @return uint256 balance of respective token returned in an escrow loan
+     */
     function balanceOf(uint256 loanID, address token)
         internal
         view

contracts/lending/LendingFacet.sol

@@ -89,7 +89,7 @@ contract LendingFacet is RolesMods, ReentryMods, PausableMods {
     }
 
     /**
-     * @notice Initialized a new lending pool for {asset}
+     * @notice It initializes a new lending pool for the respective token
      * @param asset Token address to initialize the lending pool for.
      */
     function initLendingPool(address asset)

contracts/lending/ttoken/ITToken.sol

@@ -17,7 +17,7 @@ import {
  */
 abstract contract ITToken is ERC20Upgradeable, RolesFacet {
     /**
-     * @notice This event is emitted when an user deposits tokens into the pool.
+     * @notice This event is emitted when a user deposits tokens into the pool.
      */
     event Mint(
         address indexed sender,
@@ -26,7 +26,7 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
     );
 
     /**
-     * @notice This event is emitted when an user withdraws tokens from the pool.
+     * @notice This event is emitted when a user withdraws tokens from the pool.
      */
     event Redeem(
         address indexed sender,
@@ -36,12 +36,14 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
 
     /**
      * @notice The token that is the underlying assets for this Teller token.
+     * @return ERC20 token
      */
     function underlying() external view virtual returns (ERC20);
 
     /**
      * @notice The balance of an {account} denoted in underlying value.
      * @param account Address to calculate the underlying balance.
+     * @return balance_ the balance of the account
      */
     function balanceOfUnderlying(address account)
         external
@@ -55,16 +57,16 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
     function exchangeRate() external virtual returns (uint256 rate_);
 
     /**
-     * @notice Redeem supplied Teller token underlying value.
-     * @return totalSupply_ The total value of the underlying token managed by the LP.
+     * @notice It calculates the total supply of the underlying asset.
+     * @return totalSupply_ the total supply denoted in the underlying asset.
      */
     function totalUnderlyingSupply()
         external
         virtual
         returns (uint256 totalSupply_);
 
     /**
-     * @notice It calculates the market state values across a given markets.
+     * @notice It calculates the market state values across a given market.
      * @notice Returns values that represent the global state across the market.
      * @return totalSupplied Total amount of the underlying asset supplied.
      * @return totalBorrowed Total amount borrowed through loans.
@@ -93,7 +95,7 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
 
     /**
      * @notice It validates whether supply to debt (StD) ratio is valid including the loan amount.
-     * @param newLoanAmount the new loan amount to consider o the StD ratio.
+     * @param newLoanAmount the new loan amount to consider the StD ratio.
      * @return ratio_ Whether debt ratio for lending pool is valid.
      */
     function debtRatioFor(uint256 newLoanAmount)
@@ -104,7 +106,7 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
     /**
      * @notice Called by the Teller Diamond contract when a loan has been taken out and requires funds.
      * @param recipient The account to send the funds to.
-     * @param amount Funds requested to fulfil the loan.
+     * @param amount Funds requested to fulfill the loan.
      */
     function fundLoan(address recipient, uint256 amount) external virtual;
 
@@ -118,6 +120,7 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
     /**
      * @notice Increase account supply of specified token amount.
      * @param amount The amount of underlying tokens to use to mint.
+     * @return mintAmount_ the amount minted of the specified token
      */
     function mint(uint256 amount)
         external
@@ -157,13 +160,20 @@ abstract contract ITToken is ERC20Upgradeable, RolesFacet {
 
     /**
      * @notice Gets the strategy used for balancing funds.
+     * @return address of the strategy contract
      */
     function getStrategy() external view virtual returns (address);
 
     /**
      * @notice Sets the restricted state of the platform.
+     * @param state boolean value that resembles the platform's state
      */
     function restrict(bool state) external virtual;
 
+    /**
+     * @notice it initializes the Teller Token
+     * @param admin address of the admin to the respective Teller Token
+     * @param underlying address of the ERC20 token
+     */
     function initialize(address admin, address underlying) external virtual;
 }

contracts/lending/ttoken/TToken_V1.sol

@@ -34,7 +34,6 @@ import "./storage.sol" as Storage;
 
 /**
  * @notice This contract represents a lending pool for an asset within Teller protocol.
- *
  * @author [email protected]
  */
 contract TToken_V1 is ITToken {
@@ -59,12 +58,17 @@ contract TToken_V1 is ITToken {
 
     /* Public Functions */
 
+    /**
+     * @notice it returns the decimal places of the respective TToken
+     * @return decimals of the token
+     */
     function decimals() public view override returns (uint8) {
         return s().decimals;
     }
 
     /**
      * @notice The token that is the underlying assets for this Teller token.
+     * @return ERC20 token that is the underl
      */
     function underlying() public view override returns (ERC20) {
         return s().underlying;
@@ -73,6 +77,7 @@ contract TToken_V1 is ITToken {
     /**
      * @notice The balance of an {account} denoted in underlying value.
      * @param account Address to calculate the underlying balance.
+     * @return balance_ the balance of the account
      */
     function balanceOfUnderlying(address account)
         public
@@ -149,7 +154,7 @@ contract TToken_V1 is ITToken {
 
     /**
      * @notice It validates whether supply to debt (StD) ratio is valid including the loan amount.
-     * @param newLoanAmount the new loan amount to consider o the StD ratio.
+     * @param newLoanAmount the new loan amount to consider the StD ratio.
      * @return ratio_ Whether debt ratio for lending pool is valid.
      */
     function debtRatioFor(uint256 newLoanAmount)
@@ -354,13 +359,15 @@ contract TToken_V1 is ITToken {
 
     /**
      * @notice Gets the strategy used for balancing funds.
+     * @return address of the strategy contract
      */
     function getStrategy() external view override returns (address) {
         return s().strategy;
     }
 
     /**
      * @notice Sets the restricted state of the platform.
+     * @param state boolean value that resembles the platform's state
      */
     function restrict(bool state)
         public
@@ -371,7 +378,9 @@ contract TToken_V1 is ITToken {
     }
 
     /**
-     * @notice Initializes the Teller token
+     * @notice it initializes the Teller Token
+     * @param admin address of the admin to the respective Teller Token
+     * @param underlying address of the ERC20 token
      */
     function initialize(address admin, address underlying)
         external
@@ -401,7 +410,10 @@ contract TToken_V1 is ITToken {
     }
 
     /**
-     * @dev
+     * @notice it retrieves the value of the underlying token
+     * @param amount the amount of tokens to calculate the value of
+     * @param rate the exchangeRate() to divide with the amount * exchange_rate_factor
+     * @return value_ the underlying value of the token amount
      */
     function _valueOfUnderlying(uint256 amount, uint256 rate)
         internal
@@ -412,7 +424,8 @@ contract TToken_V1 is ITToken {
     }
 
     /**
-     * @dev
+     * @notice it retrives the value in the underlying tokens
+     *
      */
     function _valueInUnderlying(uint256 amount, uint256 rate)
         internal

contracts/lending/ttoken/storage.sol

@@ -15,6 +15,9 @@ struct Store {
 
 bytes32 constant POSITION = keccak256("ttoken.storage.position");
 
+/**
+ * @notice it saves the Store struct in a hashed slot
+ */
 function store() pure returns (Store storage s_) {
     bytes32 position = POSITION;
     assembly {

contracts/lending/ttoken/strategies/ITTokenStrategy.sol

@@ -7,9 +7,22 @@ interface ITTokenStrategy {
         address indexed sender
     );
 
+    /**
+     * @notice it returns the total supply of an underlying asset in a Teller token.
+     * @return uint256 the underlying supply
+     */
     function totalUnderlyingSupply() external returns (uint256);
 
+    /**
+     * @notice it rebalances the underlying asset held by the Teller Token.
+     *
+     */
     function rebalance() external;
 
+    /**
+     * @notice it withdraws amount of tokens in a pool
+     * @param amount amount to withdraw
+     */
+
     function withdraw(uint256 amount) external;
 }

contracts/lending/ttoken/strategies/TTokenStrategy.sol

@@ -5,6 +5,10 @@ import { ERC165 } from "@openzeppelin/contracts/utils/introspection/ERC165.sol";
 import { ITTokenStrategy } from "./ITTokenStrategy.sol";
 
 abstract contract TTokenStrategy is ITTokenStrategy, ERC165 {
+    /**
+     * @notice it checks if interface is supported according to the ERC165 standard
+     * @param interfaceId Id of the interface in question
+     */
     function supportsInterface(bytes4 interfaceId)
         public
         view