From 5a8fa5fcc8dddbf15e80985e512387030a909f0f Mon Sep 17 00:00:00 2001 From: Mubaris NK Date: Wed, 24 Mar 2021 18:03:55 +0530 Subject: [PATCH] Update comments --- contracts/connectors/makerdao/main.sol | 12 ++++++------ contracts/connectors/uniswap/main.sol | 8 ++++---- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/contracts/connectors/makerdao/main.sol b/contracts/connectors/makerdao/main.sol index d7465af4..3673b7ac 100644 --- a/contracts/connectors/makerdao/main.sol +++ b/contracts/connectors/makerdao/main.sol @@ -8,7 +8,7 @@ import { VatLike, TokenJoinInterface } from "./interface.sol"; abstract contract MakerResolver is Helpers, Events { /** * @dev Open Vault - * @notice Open a Maker Vault + * @notice Open a MakerDAO Vault * @param colType Type of Collateral.(eg: 'ETH-A') */ function open(string calldata colType) external payable returns (string memory _eventName, bytes memory _eventParam) { @@ -22,7 +22,7 @@ abstract contract MakerResolver is Helpers, Events { /** * @dev Close Vault - * @notice Close a Maker Vault + * @notice Close a MakerDAO Vault * @param vault Vault ID to close. */ function close(uint256 vault) external payable returns (string memory _eventName, bytes memory _eventParam) { @@ -41,7 +41,7 @@ abstract contract MakerResolver is Helpers, Events { /** * @dev Deposit ETH/ERC20_Token Collateral. - * @notice Deposit collateral to a Maker vault + * @notice Deposit collateral to a MakerDAO vault * @param vault Vault ID. (Use 0 for last opened vault) * @param amt The amount of tokens to deposit. (For max: `uint256(-1)`) * @param getId ID to retrieve amt. @@ -88,7 +88,7 @@ abstract contract MakerResolver is Helpers, Events { /** * @dev Withdraw ETH/ERC20_Token Collateral. - * @notice Withdraw collateral from a Maker vault + * @notice Withdraw collateral from a MakerDAO vault * @param vault Vault ID. (Use 0 for last opened vault) * @param amt The amount of tokens to withdraw. (For max: `uint256(-1)`) * @param getId ID to retrieve amt. @@ -144,7 +144,7 @@ abstract contract MakerResolver is Helpers, Events { /** * @dev Borrow DAI. - * @notice Borrow DAI using a Maker vault + * @notice Borrow DAI using a MakerDAO vault * @param vault Vault ID. (Use 0 for last opened vault) * @param amt The amount of DAI to borrow. * @param getId ID to retrieve amt. @@ -193,7 +193,7 @@ abstract contract MakerResolver is Helpers, Events { /** * @dev Payback borrowed DAI. - * @notice Payback DAI debt owed by a Maker vault + * @notice Payback DAI debt owed by a MakerDAO vault * @param vault Vault ID. (Use 0 for last opened vault) * @param amt The amount of DAI to payback. (For max: `uint256(-1)`) * @param getId ID to retrieve amt. diff --git a/contracts/connectors/uniswap/main.sol b/contracts/connectors/uniswap/main.sol index 55e1155a..efcbcf07 100644 --- a/contracts/connectors/uniswap/main.sol +++ b/contracts/connectors/uniswap/main.sol @@ -7,7 +7,7 @@ import { Events } from "./events.sol"; abstract contract UniswapResolver is Helpers, Events { /** * @dev Deposit Liquidity. - * @notice Deposit Liquidity to a Uniswap pool. + * @notice Deposit Liquidity to a Uniswap v2 pool. * @param tokenA The address of token A.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param amtA The amount of A tokens to deposit. @@ -42,7 +42,7 @@ abstract contract UniswapResolver is Helpers, Events { /** * @dev Withdraw Liquidity. - * @notice Withdraw Liquidity from a Uniswap pool. + * @notice Withdraw Liquidity from a Uniswap v2 pool. * @param tokenA The address of token A.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param uniAmt The amount of pool tokens to withdraw. @@ -79,7 +79,7 @@ abstract contract UniswapResolver is Helpers, Events { /** * @dev Buy ETH/ERC20_Token. - * @notice Buy a token using a Uniswap pool + * @notice Buy a token using a Uniswap v2 * @param buyAddr The address of the token to buy.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param buyAmt The amount of tokens to buy. @@ -130,7 +130,7 @@ abstract contract UniswapResolver is Helpers, Events { /** * @dev Sell ETH/ERC20_Token. - * @notice Sell a token using a Uniswap pool + * @notice Sell a token using a Uniswap v2 * @param buyAddr The address of the token to buy.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param sellAmt The amount of the token to sell.