@etherisc/gif-next 0.0.2-7d58318-324 → 0.0.2-7dad245-860

package/contracts/shared/TokenHandler.sol

@@ -1,6 +1,7 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
+import {AccessManaged} from "@openzeppelin/contracts/access/manager/AccessManaged.sol";
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
@@ -9,50 +10,130 @@ import {Amount} from "../type/Amount.sol";
 /// @dev token specific transfer helper
 /// a default token contract is provided via contract constructor
 /// relies internally on oz SafeERC20.safeTransferFrom
-contract TokenHandler {
+contract TokenHandler is AccessManaged {
+    error ErrorTokenHandlerAmountIsZero();
+    error ErrorTokenHandlerBalanceTooLow(address token, address from, uint256 balance, uint256 expectedBalance);
+    error ErrorTokenHandlerAllowanceTooSmall(address token, address from, address spender, uint256 allowance, uint256 expectedAllowance);
+    error ErrorTokenHandlerRecipientWalletsMustBeDistinct(address to, address to2, address to3);
+    
+    event LogTokenHandlerTokenTransfer(address token, address from, address to, uint256 amountTransferred);
+
     IERC20Metadata private _token;
 
-    constructor(address token) {
+    constructor(address token, address initialAuthority) AccessManaged(initialAuthority) {
         _token = IERC20Metadata(token);
     }
 
-    /// @dev transfer amount default tokens 
-    function transfer(
+    /// @dev returns the default token defined for this TokenHandler
+    function getToken()
+        external
+        view 
+        returns (IERC20Metadata)
+    {
+        return _token;
+    }
+    
+    /// @dev collect tokens from outside of the gif and transfer them to one wallet within the scope of gif.
+    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
+    function collectTokens(
         address from,
         address to,
         Amount amount
     )
         external
+        restricted()
     {
-        SafeERC20.safeTransferFrom(
-            _token, 
-            from, 
-            to, 
-            amount.toInt());
+        _transfer(from, to, amount, true);
     }
 
-    /// @dev transfer amount of the specified token
-    function safeTransferFrom(
-        address token,
+    /// @dev collect tokens from outside of the gif and transfer them to three distinct wallets within the scope of gif
+    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
+    function collectTokensToThreeRecipients( 
+        address from,
+        address to,
+        Amount amount,
+        address to2,
+        Amount amount2,
+        address to3,
+        Amount amount3
+    )
+        external
+        restricted()
+    {
+        if (to == to2 || to == to3 || to2 == to3) {
+            revert ErrorTokenHandlerRecipientWalletsMustBeDistinct(to, to2, to3);
+        }
+
+        _checkPreconditions(from, amount + amount2 + amount3);
+
+        if (amount.gtz()) {
+            _transfer(from, to, amount, false);
+        }
+        if (amount2.gtz()) {
+            _transfer(from, to2, amount2, false);
+        }
+        if (amount3.gtz()) {
+            _transfer(from, to3, amount3, false);
+        }
+    }
+
+    /// @dev distribute tokens from a wallet within the scope of gif to an external address.
+    /// This method also checks balance and allowance and makes sure the amount is greater than zero.
+    function distributeTokens(
         address from,
         address to,
         Amount amount
     )
         external
+        restricted()
+    {
+        _transfer(from, to, amount, true);
+    }
+
+    function _transfer(
+        address from,
+        address to,
+        Amount amount,
+        bool checkPreconditions
+    )
+        internal
     {
+        if (checkPreconditions) {
+            // check amount > 0, balance >= amount and allowance >= amount
+            _checkPreconditions(from, amount);
+        }
+
+        // transfer the tokens
+        emit LogTokenHandlerTokenTransfer(address(_token), from, to, amount.toInt());
         SafeERC20.safeTransferFrom(
-            IERC20Metadata(token), 
+            _token, 
             from, 
             to, 
             amount.toInt());
     }
 
-    /// @dev returns the default token defined for this TokenHandler
-    function getToken()
-        external
-        view 
-        returns (IERC20Metadata)
+    function _checkPreconditions(
+        address from,
+        Amount amount
+    ) 
+        internal
+        view
     {
-        return _token;
+        // amount must be greater than zero
+        if (amount.eqz()) {
+            revert ErrorTokenHandlerAmountIsZero();
+        }
+
+        // balance must be >= amount
+        uint256 balance = _token.balanceOf(from);
+        if (balance < amount.toInt()) {
+            revert ErrorTokenHandlerBalanceTooLow(address(_token), from, balance, amount.toInt());
+        }
+
+        // allowance must be >= amount
+        uint256 allowance = _token.allowance(from, address(this));
+        if (allowance < amount.toInt()) {
+            revert ErrorTokenHandlerAllowanceTooSmall(address(_token), from, address(this), allowance, amount.toInt());
+        }
     }
 }

package/contracts/shared/TokenHandlerDeployerLib.sol

@@ -0,0 +1,12 @@
+// SPDX-License-Identifier: Apache-2.0
+pragma solidity ^0.8.20;
+
+import {TokenHandler} from "./TokenHandler.sol";
+
+library TokenHandlerDeployerLib {
+
+    function deployTokenHandler(address token, address authority) public returns (TokenHandler) {
+        return new TokenHandler(address(token), authority);
+    }
+
+}

package/contracts/staking/StakeManagerLib.sol

@@ -153,31 +153,6 @@ library StakeManagerLib {
         // TODO add check for target specific max dip amount (min stake + tvl * stake rate + buffer)
     }
 
-
-    function checkDipBalanceAndAllowance(
-        IERC20Metadata dip, 
-        address owner, 
-        address tokenHandlerAddress, 
-        Amount dipAmount
-    )
-        public
-        view
-    {
-        // check balance
-        uint256 amount = dipAmount.toInt();
-        uint256 dipBalance = dip.balanceOf(owner);
-        if (dipBalance < amount) {
-            revert IStaking.ErrorStakingDipBalanceInsufficient(owner, amount, dipBalance);
-        }
-
-        // check allowance
-        uint256 dipAllowance = dip.allowance(owner, tokenHandlerAddress);
-        if (dipAllowance < amount) {
-            revert IStaking.ErrorStakingDipAllowanceInsufficient(owner, tokenHandlerAddress, amount, dipAllowance);
-        }
-    }
-
-
     function calculateRewardIncrease(
         StakingReader stakingReader,
         NftId stakeNftId,

package/contracts/staking/Staking.sol

@@ -18,6 +18,7 @@ import {StakingStore} from "./StakingStore.sol";
 import {TargetManagerLib} from "./TargetManagerLib.sol";
 import {Timestamp} from "../type/Timestamp.sol";
 import {TokenHandler} from "../shared/TokenHandler.sol";
+import {TokenHandlerDeployerLib} from "../shared/TokenHandlerDeployerLib.sol";
 import {TokenRegistry} from "../registry/TokenRegistry.sol";
 import {UFixed} from "../type/UFixed.sol";
 import {Version, VersionLib} from "../type/Version.sol";
@@ -300,7 +301,7 @@ contract Staking is
         StakingStorage storage $ = _getStakingStorage();
 
         // TODO implement
-   }
+    }
 
 
     function updateRewards(NftId stakeNftId)
@@ -377,16 +378,7 @@ contract Staking is
         external
         restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            from, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(from, stakingWallet, dipAmount);
+        getTokenHandler().collectTokens(from, getWallet(), dipAmount);
     }
 
 
@@ -394,16 +386,7 @@ contract Staking is
         external
         restricted() // only staking service
     {
-        TokenHandler tokenHandler = getTokenHandler();
-        address stakingWallet = getWallet();
-
-        StakeManagerLib.checkDipBalanceAndAllowance(
-            getToken(), 
-            stakingWallet, 
-            address(tokenHandler), 
-            dipAmount);
-
-        tokenHandler.transfer(stakingWallet, to, dipAmount);
+        getTokenHandler().distributeTokens(getWallet(), to, dipAmount);
     }
 
 
@@ -500,7 +483,7 @@ contract Staking is
         $._store = StakingStore(stakingStoreAddress);
         $._reader = StakingStore(stakingStoreAddress).getStakingReader();
         $._tokenRegistry = TokenRegistry(tokenRegistryAddress);
-        $._tokenHandler = new TokenHandler(address(getToken()));
+        $._tokenHandler = TokenHandlerDeployerLib.deployTokenHandler(dipTokenAddress, authority);
 
         registerInterface(type(IStaking).interfaceId);
     }

package/contracts/staking/StakingService.sol

@@ -122,11 +122,10 @@ contract StakingService is
 
         // transfer withdrawal amount to target owner
         address instanceOwner = getRegistry().ownerOf(instanceNftId);
+        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
         $._staking.transferDipAmount(
             instanceOwner,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesDecreased(instanceNftId, instanceOwner, dipAmount, newBalance);
     }
 
 
@@ -169,12 +168,12 @@ contract StakingService is
             targetNftId,
             dipAmount);
 
+        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
+
         // collect staked dip by staking
         $._staking.collectDipAmount(
             stakeOwner,
             dipAmount);
-
-        emit LogStakingServiceStakeCreated(stakeNftId, targetNftId, stakeOwner, dipAmount);
     }
 
 
@@ -197,12 +196,11 @@ contract StakingService is
 
         // collect staked dip by staking
         if (dipAmount.gtz()) {
+            emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
             $._staking.collectDipAmount(
                 stakeOwner,
                 dipAmount);
         }
-
-        emit LogStakingServiceStakeIncreased(stakeNftId, stakeOwner, dipAmount, stakeBalance);
     }
 
 
@@ -247,11 +245,10 @@ contract StakingService is
         address stakeOwner = msg.sender;
 
         Amount rewardsClaimedAmount = $._staking.claimRewards(stakeNftId);
+        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
         $._staking.transferDipAmount(
             stakeOwner,
             rewardsClaimedAmount);
-
-        emit LogStakingServiceRewardsClaimed(stakeNftId, stakeOwner, rewardsClaimedAmount);
     }
 
 
@@ -270,11 +267,10 @@ contract StakingService is
         ) = $._staking.unstake(stakeNftId);
 
         Amount totalAmount = unstakedAmount + rewardsClaimedAmount;
+        emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
         $._staking.transferDipAmount(
             stakeOwner,
             totalAmount);
-
-        emit LogStakingServiceUnstaked(stakeNftId, stakeOwner, totalAmount);
     }
 
 
@@ -389,12 +385,12 @@ contract StakingService is
         StakingServiceStorage storage $ = _getStakingServiceStorage();
         newBalance = $._staking.refillRewardReserves(targetNftId, dipAmount);
 
+        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
+
         // collect reward dip from provider
         $._staking.collectDipAmount(
             rewardProvider,
             dipAmount);
-
-        emit LogStakingServiceRewardReservesIncreased(targetNftId, rewardProvider, dipAmount, newBalance);
     }
 
 

package/contracts/type/Amount.sol

@@ -12,13 +12,15 @@ using {
     nqAmount as !=,
     ltAmount as <,
     gtAmount as >,
+    AmountLib.add,
     AmountLib.eq,
     AmountLib.eqz,
     AmountLib.gtz,
+    AmountLib.gt,
+    AmountLib.gte,
+    AmountLib.multiplyWith,
     AmountLib.toInt,
-    AmountLib.add,
-    AmountLib.toUFixed,
-    AmountLib.multiplyWith
+    AmountLib.toUFixed
 } for Amount global;
 
 function addAmount(Amount a, Amount b) pure returns (Amount) {
@@ -77,16 +79,21 @@ library AmountLib {
         return Amount.unwrap(amount1) == Amount.unwrap(amount2);
     }
 
-    /// @dev return true if amount a1 is smaller than a2
+    /// @dev return true if amount a1 is less than a2
     function lt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) < Amount.unwrap(a2);
     }
 
-    /// @dev return true if amount a1 is larger than a2
+    /// @dev return true if amount a1 is greater than a2
     function gt(Amount a1, Amount a2) public pure returns (bool) {
         return Amount.unwrap(a1) > Amount.unwrap(a2);
     }
 
+    /// @dev return true if amount a1 is greater or equal than a2
+    function gte(Amount a1, Amount a2) public pure returns (bool) {
+        return Amount.unwrap(a1) >= Amount.unwrap(a2);
+    }
+
     /// @dev return minimum of a1 and a2.
     function min(Amount a1, Amount a2) public pure returns (Amount) {
         if (Amount.unwrap(a1) < Amount.unwrap(a2)) {

package/contracts/type/Blocknumber.sol

@@ -11,8 +11,14 @@ using {
     eqBlocknumber as ==,
     neBlocknumber as !=,
     BlocknumberLib.toInt,
+    BlocknumberLib.eq,
+    BlocknumberLib.ne,
     BlocknumberLib.eqz,
-    BlocknumberLib.gtz
+    BlocknumberLib.gtz,
+    BlocknumberLib.gt,
+    BlocknumberLib.gte,
+    BlocknumberLib.lt,
+    BlocknumberLib.lte
 } for Blocknumber global;
 
 /// @dev return true if Blocknumber a is greater than Blocknumber b

package/contracts/type/Referral.sol

@@ -12,6 +12,7 @@ type ReferralStatus is uint8;
 using {
     eqReferralId as ==, 
     neReferralId as !=,
+    ReferralLib.eqz,
     ReferralLib.toKey32
 } for ReferralId global;
 

package/contracts/type/Seconds.sol

@@ -6,9 +6,11 @@ type Seconds is uint40;
 using {
     SecondsEq as ==,
     SecondsGt as >,
+    SecondsAdd as +,
     SecondsLib.eqz,
     SecondsLib.gtz,
-    SecondsLib.toInt
+    SecondsLib.toInt,
+    SecondsLib.add
 } for Seconds global;
 
 function SecondsEq(Seconds duration1, Seconds duration2) pure returns (bool) {
@@ -19,6 +21,11 @@ function SecondsGt(Seconds duration1, Seconds duration2) pure returns (bool) {
     return SecondsLib.gt(duration1, duration2);
 }
 
+function SecondsAdd(Seconds duration1, Seconds duration2) pure returns (Seconds) {
+    return SecondsLib.add(duration1, duration2);
+}
+
+
 library SecondsLib {
 
     error ErrorSecondsLibDurationTooBig(uint256 duration);
@@ -70,6 +77,11 @@ library SecondsLib {
         return Seconds.unwrap(duration1) > Seconds.unwrap(duration2);
     }
 
+    /// @dev return add duration1 and duration2
+    function add(Seconds duration1, Seconds duration2) public pure returns (Seconds) {
+        return Seconds.wrap(Seconds.unwrap(duration1) + Seconds.unwrap(duration2));
+    }
+
     function toInt(Seconds duration) public pure returns (uint256) {
         return uint256(uint40(Seconds.unwrap(duration)));
     }

package/contracts/type/Timestamp.sol

@@ -12,6 +12,12 @@ using {
     lteTimestamp as <=,
     eqTimestamp as ==,
     neTimestamp as !=,
+    TimestampLib.eq,
+    TimestampLib.ne,
+    TimestampLib.gt,
+    TimestampLib.gte,
+    TimestampLib.lt,
+    TimestampLib.lte,
     TimestampLib.gtz,
     TimestampLib.eqz,
     TimestampLib.addSeconds,
@@ -50,7 +56,7 @@ function neTimestamp(Timestamp a, Timestamp b) pure returns (bool) {
 
 /// @dev Converts the uint256 to a Timestamp.
 function toTimestamp(uint256 timestamp) pure returns (Timestamp) {
-    return Timestamp.wrap(uint40(timestamp));
+    return TimestampLib.toTimestamp(timestamp);
 }
 
 // TODO move to TimestampLib and rename to zero()
@@ -72,6 +78,10 @@ library TimestampLib {
     function blockTimestamp() public view returns (Timestamp) {
         return Timestamp.wrap(uint40(block.timestamp));
     }
+
+    function toTimestamp(uint256 timestamp) public pure returns (Timestamp) {
+        return Timestamp.wrap(uint40(timestamp));
+    }
     
     /// @dev return true if Timestamp a is after Timestamp b
     function gt(Timestamp a, Timestamp b) public pure returns (bool isAfter) {

package/contracts/type/UFixed.sol

@@ -15,9 +15,10 @@ using {
     lteUFixed as <=,
     eqUFixed as ==,
     neUFixed as !=,
+    UFixedLib.gt,
+    UFixedLib.gtz,
     UFixedLib.toInt,
-    UFixedLib.toInt1000,
-    UFixedLib.gtz
+    UFixedLib.toInt1000
 } for UFixed global;
 
 // TODO move to UFixedLib and rename to zero()
@@ -30,7 +31,9 @@ function addUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 }
 
 function subUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(a >= b, "ERROR:UFM-010:NEGATIVE_RESULT");
+    if (a < b) {
+        revert UFixedLib.UFixedLibNegativeResult();
+    }
     return UFixed.wrap(UFixed.unwrap(a) - UFixed.unwrap(b));
 }
 
@@ -40,8 +43,10 @@ function mulUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 }
 
 function divUFixed(UFixed a, UFixed b) pure returns (UFixed) {
-    require(UFixed.unwrap(b) > 0, "ERROR:UFM-020:DIVISOR_ZERO");
-
+    if (UFixed.unwrap(b) == 0) {
+        revert UFixedLib.UFixedLibDivisionByZero();
+    }
+    
     return
         UFixed.wrap(MathLib.mulDiv(UFixed.unwrap(a), 10 ** 18, UFixed.unwrap(b)));
 }
@@ -89,6 +94,8 @@ function deltaUFixed(UFixed a, UFixed b) pure returns (UFixed) {
 /// @dev copied from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.3/contracts/utils/math/Math.sol
 library MathLib {
 
+    error MathLigMulDivOverflow();
+
     enum Rounding {
         Down, // Toward negative infinity
         Up, // Toward infinity
@@ -122,8 +129,10 @@ library MathLib {
             }
 
             // Make sure the result is less than 2^256. Also prevents denominator == 0.
-            require(denominator > prod1, "Math: mulDiv overflow");
-
+            if (denominator <= prod1) {
+                revert MathLigMulDivOverflow();
+            }
+            
             ///////////////////////////////////////////////
             // 512 by 256 division.
             ///////////////////////////////////////////////
@@ -195,6 +204,12 @@ library MathLib {
 }
 
 library UFixedLib {
+    error UFixedLibNegativeResult();
+    error UFixedLibDivisionByZero();
+
+    error UFixedLibExponentTooSmall(int8 exp);
+    error UFixedLibExponentTooLarge(int8 exp);
+
     int8 public constant EXP = 18;
     uint256 public constant MULTIPLIER = 10 ** uint256(int256(EXP));
     uint256 public constant MULTIPLIER_HALF = MULTIPLIER / 2;
@@ -221,9 +236,13 @@ library UFixedLib {
 
     /// @dev Converts the uint256 to a UFixed with given exponent.
     function toUFixed(uint256 a, int8 exp) public pure returns (UFixed) {
-        require(EXP + exp >= 0, "ERROR:FM-010:EXPONENT_TOO_SMALL");
-        require(EXP + exp <= 64, "ERROR:FM-011:EXPONENT_TOO_LARGE");
-
+        if (EXP + exp < 0) {
+            revert UFixedLibExponentTooSmall(exp);
+        }
+        if (EXP + exp > 64) {
+            revert UFixedLibExponentTooLarge(exp);
+        }
+        
         return UFixed.wrap(a * 10 ** uint8(EXP + exp));
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etherisc/gif-next",
-  "version": "0.0.2-7d58318-324",
+  "version": "0.0.2-7dad245-860",
   "description": "This is the repository for the next version of the Generic Insurance Framework (GIF) smart contracts. ",
   "main": "index.js",
   "scripts": {

package/artifacts/contracts/product/IProductService.sol/IProductService.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/e90d260d136f1141b593b63f31d8f134.json"
-}

package/artifacts/contracts/product/ProductService.sol/ProductService.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/e90d260d136f1141b593b63f31d8f134.json"
-}

package/artifacts/contracts/product/ProductServiceManager.sol/ProductServiceManager.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/e90d260d136f1141b593b63f31d8f134.json"
-}

package/artifacts/contracts/shared/ERC165.sol/ERC165.dbg.json

@@ -1,4 +0,0 @@
-{
-  "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/e90d260d136f1141b593b63f31d8f134.json"
-}