all files / contracts/staking/ xSolaceMigrator.sol

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5×
4×
4×
3×
3×
2×
2×
 
 
 
 
 
 
 
 
 
 
 
 
 
44×
 
42×
 
 
 
 
 
 
 
 
 
 
 
 
 
43×
 
42×
 
42×
 
 
 
 
 
 
 
 
 
 
 
 
 
84×
84×
84×
84×
 
 
 
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity 0.8.6;
 
import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
import "@openzeppelin/contracts/token/ERC20/extensions/draft-ERC20Permit.sol";
import "@openzeppelin/contracts/utils/Address.sol";
import "@openzeppelin/contracts/security/ReentrancyGuard.sol";
import "./../interfaces/staking/IxSOLACEV1.sol";
import "./../interfaces/staking/IxsLocker.sol";
import "./../interfaces/staking/IxSolaceMigrator.sol";
 
 
/**
 * @title xSolace Migrator
 * @author solace.fi
 * @notice Helps migrate from [**xSOLACEV1**](./xSOLACEV1) to [**xsLocker**](./xsLocker).
 */
// solhint-disable-next-line contract-name-camelcase
contract xSolaceMigrator is IxSolaceMigrator, ReentrancyGuard {
 
    /***************************************
    VIEW FUNCTIONS
    ***************************************/
 
    /// @notice Address of the [**SOLACE**](./../SOLACE) contract.
    address public override solace;
    /// @notice Address of the [**xSOLACEV1**](./xSOLACEV1) contract.
    address public override xsolacev1;
    /// @notice Address of the [**xsLocker**](./xsLocker) contract.
    address public override xsLocker;
 
    /**
     * @notice Constructs the xSolaceMigrator contract.
     * @param solace_ Address of the [**SOLACE**](./../SOLACE) contract.
     * @param xsolacev1_ Address of the [**xSOLACEV1**](./xSOLACEV1) contract.
     * @param xsLocker_ Address of the [**xsLocker**](./xsLocker) contract.
     */
    constructor(address solace_, address xsolacev1_, address xsLocker_) {
        require(solace_ != address(0x0), "zero address solace");
        solace = solace_;
        require(xsolacev1_ != address(0x0), "zero address xsolace v1");
        xsolacev1 = xsolacev1_;
        require(xsLocker_ != address(0x0), "zero address xslocker");
        xsLocker = xsLocker_;
        IERC20(solace_).approve(xsLocker_, type(uint256).max);
    }
 
    /***************************************
    MUTATOR FUNCTIONS
    ***************************************/
 
    /**
     * @notice Migrate from the [**xSOLACEv1**](./xSOLACEV1) contract and create a new [**Lock**](./xsLocker).
     * @param amount The amount of [**xSOLACEv1**](./xSOLACEV1) to migrate.
     * @param lockEnd The timestamp that the lock will unlock.
     */
    function migrate(uint256 amount, uint256 lockEnd) external override nonReentrant {
        // pull xsolace
        SafeERC20.safeTransferFrom(IERC20(xsolacev1), msg.sender, address(this), amount);
        // accounting
        return _migrate(msg.sender, amount, lockEnd);
    }
 
    /**
     * @notice Migrate from the [**xSOLACEv1**](./xSOLACEV1) contract and create a new [**Lock**](./xsLocker).
     * @param amount The amount of [**xSOLACEv1**](./xSOLACEV1) to migrate.
     * @param lockEnd The timestamp that the lock will unlock.
     * @param deadline Time the transaction must go through before.
     * @param v secp256k1 signature
     * @param r secp256k1 signature
     * @param s secp256k1 signature
     */
    function migrateSigned(uint256 amount, uint256 lockEnd, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external override nonReentrant {
        // permit
        IERC20Permit(xsolacev1).permit(msg.sender, address(this), amount, deadline, v, r, s);
        // pull xsolace
        SafeERC20.safeTransferFrom(IERC20(xsolacev1), msg.sender, address(this), amount);
        // accounting
        _migrate(msg.sender, amount, lockEnd);
    }
 
    /***************************************
    INTERNAL FUNCTIONS
    ***************************************/
 
    /**
     * @notice Migrate from the [**xSOLACEv1**](./xSOLACEV1) contract and create a new [**Lock**](./xsLocker).
     * @param depositor The depositing user.
     * @param amount The deposit amount.
     * @param lockEnd The timestamp that the lock will unlock.
     */
    function _migrate(address depositor, uint256 amount, uint256 lockEnd) internal {
        IxSOLACEV1 xsolace = IxSOLACEV1(xsolacev1);
        uint256 amountSolace = xsolace.unstake(amount);
        IxsLocker locker = IxsLocker(xsLocker);
        locker.createLock(depositor, amountSolace, lockEnd);
    }
}