chore: use relative import and add docs

axieinfinity · Jan 2, 2024 · adb78b0 · adb78b0
1 parent 0e00588
commit adb78b0
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 4 deletions.
diff --git a/remappings.txt b/remappings.txt
diff --git a/src/interfaces/IWRON.sol b/src/interfaces/IWRON.sol
@@ -2,15 +2,25 @@
 pragma solidity ^0.8.0;
 
 interface IWRON {
+  /**
+   * @dev Deposit RON and increase balance WRON tokens of sender.
+   */
   function deposit() external payable;
 
+  /// @dev See {IERC20-transfer}.
   function transfer(address to, uint256 value) external returns (bool);
 
+  /// @dev See {IERC20-transferFrom}.
   function transferFrom(address src, address dst, uint256 wad) external returns (bool);
 
+  /**
+   * @dev Withdraw RON and decrease balance WRON tokens of sender.
+   */
   function withdraw(uint256) external;
 
+  /// @dev See {IERC20-balanceOf}.
   function balanceOf(address) external view returns (uint256);
 
+  /// @dev See {IERC20-approve}.
   function approve(address guy, uint256 wad) external returns (bool);
 }
diff --git a/src/interfaces/IWRONHelper.sol b/src/interfaces/IWRONHelper.sol
@@ -2,9 +2,24 @@
 pragma solidity ^0.8.0;
 
 interface IWRONHelper {
+  /**
+   * @dev Returns WRON address.
+   */
   function WRON() external view returns (address);
 
+  /**
+   * @dev Deposit WRON and withdraw RON token.
+   *
+   * Requirements:
+   * - This contract must be approved `amount` WRON tokens by sender.
+   */
   function withdraw(uint256 amount) external;
 
+  /**
+   * @dev Deposit WRON and withdraw RON token to address `to`.
+   *
+   * Requirements:
+   * - This contract must be approved `amount` WRON tokens by sender.
+   */
   function withdrawTo(address payable to, uint256 amount) external;
 }
diff --git a/src/legacy/transfers/RONTransferHelper.sol b/src/legacy/transfers/RONTransferHelper.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
+import { Strings } from "../../../lib/openzeppelin-contracts/contracts/utils/Strings.sol";
 
 /**
  * @title RONTransferHelper

diff --git a/src/legacy/transfers/TransferFromHelper.sol b/src/legacy/transfers/TransferFromHelper.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
+import { Strings } from "../../../lib/openzeppelin-contracts/contracts/utils/Strings.sol";
 
 /**
  * @title TransferFromHelper

diff --git a/src/legacy/transfers/TransferHelper.sol b/src/legacy/transfers/TransferHelper.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import { Strings } from "@openzeppelin/contracts/utils/Strings.sol";
+import { Strings } from "../../../lib/openzeppelin-contracts/contracts/utils/Strings.sol";
 
 /**
  * @title TransferHelper