Instadapp/dsa-connectors
1
0
Fork 0
mirror of https://github.com/Instadapp/dsa-connectors.git synced 2024-07-29 22:37:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update comments

Browse Source
This commit is contained in:
Mubaris NK 2021-03-24 18:03:55 +05:30
parent dd22b68bf1
commit 5a8fa5fcc8
No known key found for this signature in database
GPG Key ID: 9AC09AD0F8D68561
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
contracts/connectors/makerdao/main.sol
View File

@ -8,7 +8,7 @@ import { VatLike, TokenJoinInterface } from "./interface.sol";
abstract contract MakerResolver is Helpers, Events { abstract contract MakerResolver is Helpers, Events {
/** /**
* @dev Open Vault * @dev Open Vault
* @notice Open a Maker Vault * @notice Open a MakerDAO Vault
* @param colType Type of Collateral.(eg: 'ETH-A') * @param colType Type of Collateral.(eg: 'ETH-A')
*/ */
function open(string calldata colType) external payable returns (string memory _eventName, bytes memory _eventParam) { 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 * @dev Close Vault
* @notice Close a Maker Vault * @notice Close a MakerDAO Vault
* @param vault Vault ID to close. * @param vault Vault ID to close.
*/ */
function close(uint256 vault) external payable returns (string memory _eventName, bytes memory _eventParam) { 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. * @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 vault Vault ID. (Use 0 for last opened vault)
* @param amt The amount of tokens to deposit. (For max: `uint256(-1)`) * @param amt The amount of tokens to deposit. (For max: `uint256(-1)`)
* @param getId ID to retrieve amt. * @param getId ID to retrieve amt.
@ -88,7 +88,7 @@ abstract contract MakerResolver is Helpers, Events {
/** /**
* @dev Withdraw ETH/ERC20_Token Collateral. * @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 vault Vault ID. (Use 0 for last opened vault)
* @param amt The amount of tokens to withdraw. (For max: `uint256(-1)`) * @param amt The amount of tokens to withdraw. (For max: `uint256(-1)`)
* @param getId ID to retrieve amt. * @param getId ID to retrieve amt.
@ -144,7 +144,7 @@ abstract contract MakerResolver is Helpers, Events {
/** /**
* @dev Borrow DAI. * @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 vault Vault ID. (Use 0 for last opened vault)
* @param amt The amount of DAI to borrow. * @param amt The amount of DAI to borrow.
* @param getId ID to retrieve amt. * @param getId ID to retrieve amt.
@ -193,7 +193,7 @@ abstract contract MakerResolver is Helpers, Events {
/** /**
* @dev Payback borrowed DAI. * @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 vault Vault ID. (Use 0 for last opened vault)
* @param amt The amount of DAI to payback. (For max: `uint256(-1)`) * @param amt The amount of DAI to payback. (For max: `uint256(-1)`)
* @param getId ID to retrieve amt. * @param getId ID to retrieve amt.

8
contracts/connectors/uniswap/main.sol
View File

@ -7,7 +7,7 @@ import { Events } from "./events.sol";
abstract contract UniswapResolver is Helpers, Events { abstract contract UniswapResolver is Helpers, Events {
/** /**
* @dev Deposit Liquidity. * @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 tokenA The address of token A.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param amtA The amount of A tokens to deposit. * @param amtA The amount of A tokens to deposit.
@ -42,7 +42,7 @@ abstract contract UniswapResolver is Helpers, Events {
/** /**
* @dev Withdraw Liquidity. * @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 tokenA The address of token A.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param tokenB The address of token B.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param uniAmt The amount of pool tokens to withdraw. * @param uniAmt The amount of pool tokens to withdraw.
@ -79,7 +79,7 @@ abstract contract UniswapResolver is Helpers, Events {
/** /**
* @dev Buy ETH/ERC20_Token. * @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 buyAddr The address of the token to buy.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param buyAmt The amount of tokens to buy. * @param buyAmt The amount of tokens to buy.
@ -130,7 +130,7 @@ abstract contract UniswapResolver is Helpers, Events {
/** /**
* @dev Sell ETH/ERC20_Token. * @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 buyAddr The address of the token to buy.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE) * @param sellAddr The address of the token to sell.(For ETH: 0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE)
* @param sellAmt The amount of the token to sell. * @param sellAmt The amount of the token to sell.