feat: Add return value for migrated token amount

maple-labs · Jun 26, 2024 · 82ad429 · 82ad429
1 parent d00bfcd
commit 82ad429
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/contracts/Migrator.sol b/contracts/Migrator.sol
@@ -29,16 +29,18 @@ contract Migrator is IMigrator {
         tokenSplitScalar = scalar_;
     }
 
-    function migrate(uint256 amount_) external override {
-        migrate(msg.sender, amount_);
+    function migrate(uint256 amount_) external override returns (uint256 migratedAmount_) {
+        migratedAmount_ = migrate(msg.sender, amount_);
     }
 
-    function migrate(address owner_, uint256 amount_) public override {
+    function migrate(address owner_, uint256 amount_) public override returns (uint256 migratedAmount_) {
         require(active,                "M:M:INACTIVE");
         require(amount_ != uint256(0), "M:M:ZERO_AMOUNT");
 
+        migratedAmount_ = amount_ * tokenSplitScalar;
+
         require(ERC20Helper.transferFrom(oldToken, owner_, address(this), amount_), "M:M:TRANSFER_FROM_FAILED");
-        require(ERC20Helper.transfer(newToken, owner_, amount_ * tokenSplitScalar), "M:M:TRANSFER_FAILED");
+        require(ERC20Helper.transfer(newToken, owner_, migratedAmount_),            "M:M:TRANSFER_FAILED");
     }
 
     function setActive(bool active_) external override {

diff --git a/contracts/interfaces/IMigrator.sol b/contracts/interfaces/IMigrator.sol
@@ -29,16 +29,18 @@ interface IMigrator {
 
     /**
      *  @dev   Exchange the oldToken for the same amount of newToken.
-     *  @param amount_ The amount of oldToken to swap for newToken.
+     *  @param  amount_         The amount of oldToken to swap for newToken.
+     *  @return migratedAmount_ The amount of newToken received.
      */
-    function migrate(uint256 amount_) external;
+    function migrate(uint256 amount_) external returns (uint256 migratedAmount_);
 
     /**
      *  @dev   Exchange the oldToken for the same amount of newToken.
-     *  @param owner_ The address of the owner of the oldToken.
-     *  @param amount_ The amount of oldToken to swap for newToken.
+     *  @param  owner_          The address of the owner of the oldToken.
+     *  @param  amount_         The amount of oldToken to swap for newToken.
+     *  @return migratedAmount_ The amount of newToken received.
      */
-    function migrate(address owner_, uint256 amount_) external;
+    function migrate(address owner_, uint256 amount_) external returns (uint256 migratedAmount_);
 
     /**
      *  @dev   Set the migrator to active or inactive.