@etherisc/gif-next 0.0.2-f1e0c66-773 → 0.0.2-f1e6957-384

package/contracts/shared/InitializableCustom.sol

@@ -1,177 +0,0 @@
-// SPDX-License-Identifier: MIT
-
-pragma solidity ^0.8.20;
-
-/**
- * @dev This is copy of OpenZeppelin's Contracts (last updated v5.0.0) (proxy/utils/Initializable.sol)
- * Changes:
- * 1. name is InitializableCustom
- * 2. no longer abstract
- * 3. have $._initializeOwner
- * 4. have constructor where sets _initializeOwner 
- * 5. initializer() in addition checks for _initializeOwner
- * 6. reinitializer() is deleted
- */
-abstract contract InitializableCustom {
-    /**
-     * @dev Storage of the initializable contract.
-     *
-     * It's implemented on a custom ERC-7201 namespace to reduce the risk of storage collisions
-     * when using with upgradeable contracts.
-     *
-     * @custom:storage-location erc7201:openzeppelin.storage.Initializable
-     */
-    struct InitializableCustomStorage {
-        /**
-         * @dev Indicates that the contract has been initialized.
-         */
-        uint64 _initialized;
-        /**
-         * @dev Indicates that the contract is in the process of being initialized.
-         */
-        bool _initializing;
-        /**
-         * @dev Indicates address that can call function with initializer() modifier.
-         */
-        address _initializeOwner;
-    }
-
-    // keccak256(abi.encode(uint256(keccak256("openzeppelin.storage.InitializableCustom")) - 1)) & ~bytes32(uint256(0xff))
-    bytes32 private constant INITIALIZABLE_CUSTOM_STORAGE = 0x46cd1d813423aaf613c34c7f348d15b2b5e71215e9145b09467e257ea2805a00;
-
-    /**
-     * @dev The contract is already initialized.
-     */
-    error InvalidInitialization();
-
-    /**
-     * @dev The contract initialization function caller is not authorized.
-     */
-    error InvalidInitializationCaller();
-
-    /**
-     * @dev The contract is not initializing.
-     */
-    error NotInitializing();
-
-    /**
-     * @dev Triggered when the contract has been initialized or reinitialized.
-     */
-    event Initialized(uint64 version);
-
-    /**
-     * @dev A modifier that defines a protected initializer function that can be invoked at most once. In its scope,
-     * `onlyInitializing` functions can be used to initialize parent contracts.
-     *
-     * Similar to `reinitializer(1)`, except that in the context of a constructor an `initializer` may be invoked any
-     * number of times. This behavior in the constructor can be useful during testing and is not expected to be used in
-     * production.
-     *
-     * Emits an {Initialized} event.
-     */
-    modifier initializer() virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if($._initializeOwner != msg.sender) {
-            revert InvalidInitializationCaller();
-        }
-
-        // Cache values to avoid duplicated sloads
-        bool isTopLevelCall = !$._initializing;
-        uint64 initialized = $._initialized;
-
-        // Allowed calls:
-        // - initialSetup: the contract is not in the initializing state and no previous version was
-        //                 initialized
-        // - construction: the contract is initialized at version 1 (no reininitialization) and the
-        //                 current contract is just being deployed
-        bool initialSetup = initialized == 0 && isTopLevelCall;
-        bool construction = initialized == 1 && address(this).code.length == 0;
-
-        if (!initialSetup && !construction) {
-            revert InvalidInitialization();
-        }
-        $._initialized = 1;
-        if (isTopLevelCall) {
-            $._initializing = true;
-        }
-        _;
-        if (isTopLevelCall) {
-            $._initializing = false;
-            emit Initialized(1);
-        }
-    }
-
-    /**
-     * @dev Modifier to protect an initialization function so that it can only be invoked by functions with the
-     * {initializer} and {reinitializer} modifiers, directly or indirectly.
-     */
-    modifier onlyInitializing() {
-        _checkInitializing();
-        _;
-    }
-
-    /**
-     * @dev Constructor sets the caller of protected initializer function.
-    */
-    constructor() {
-        // solhint-disable-previous-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-        $._initializeOwner = msg.sender;
-    }
-
-    /**
-     * @dev Reverts if the contract is not in an initializing state. See {onlyInitializing}.
-     */
-    function _checkInitializing() internal view virtual {
-        if (!_isInitializing()) {
-            revert NotInitializing();
-        }
-    }
-
-    /**
-     * @dev Locks the contract, preventing any future reinitialization. This cannot be part of an initializer call.
-     * Calling this in the constructor of a contract will prevent that contract from being initialized or reinitialized
-     * to any version. It is recommended to use this to lock implementation contracts that are designed to be called
-     * through proxies.
-     *
-     * Emits an {Initialized} event the first time it is successfully executed.
-     */
-    function _disableInitializers() internal virtual {
-        // solhint-disable-next-line var-name-mixedcase
-        InitializableCustomStorage storage $ = _getInitializableCustomStorage();
-
-        if ($._initializing) {
-            revert InvalidInitialization();
-        }
-        if ($._initialized != type(uint64).max) {
-            $._initialized = type(uint64).max;
-            emit Initialized(type(uint64).max);
-        }
-    }
-
-    /**
-     * @dev Returns the highest version that has been initialized. See {reinitializer}.
-     */
-    function _getInitializedVersion() internal view returns (uint64) {
-        return _getInitializableCustomStorage()._initialized;
-    }
-
-    /**
-     * @dev Returns `true` if the contract is currently initializing. See {onlyInitializing}.
-     */
-    function _isInitializing() internal view returns (bool) {
-        return _getInitializableCustomStorage()._initializing;
-    }
-
-    /**
-     * @dev Returns a pointer to the storage namespace.
-     */
-    // solhint-disable-next-line var-name-mixedcase
-    function _getInitializableCustomStorage() private pure returns (InitializableCustomStorage storage $) {
-        assembly {
-            $.slot := INITIALIZABLE_CUSTOM_STORAGE
-        }
-    }
-}

package/contracts/shared/KeyValueStore.sol

@@ -1,131 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {Blocknumber, blockBlocknumber, zeroBlocknumber} from "../type/Blocknumber.sol";
-import {Key32, KeyId, Key32Lib} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType} from "../type/ObjectType.sol";
-import {StateId, ACTIVE, KEEP_STATE} from "../type/StateId.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-
-import {Lifecycle} from "./Lifecycle.sol";
-import {IKeyValueStore} from "./IKeyValueStore.sol";
-
-abstract contract KeyValueStore is
-    Lifecycle, 
-    IKeyValueStore
-{
-
-    mapping(Key32 key32 => Value value) private _value;
-
-    function _create(
-        Key32 key32, 
-        bytes memory data
-    )
-        internal
-    {
-        ObjectType objectType = key32.toObjectType();
-        if (objectType.eqz()) {
-            revert ErrorKeyValueStoreTypeUndefined(objectType);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        if (metadata.state.gtz()) {
-            revert ErrorKeyValueStoreAlreadyCreated(key32, objectType);
-        }
-
-        if(!hasLifecycle(objectType)) {
-            revert ErrorKeyValueStoreNoLifecycle(objectType);
-        }
-
-        Blocknumber blocknumber = blockBlocknumber();
-        StateId initialState = getInitialState(objectType);
-
-        // set metadata
-        metadata.objectType = objectType;
-        metadata.state = initialState;
-        metadata.updatedIn = blocknumber;
-        metadata.createdIn = blocknumber;
-
-        // set data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoCreated(key32.toObjectType(), key32.toKeyId(), initialState, msg.sender, tx.origin);
-    }
-
-
-    function _update(
-        Key32 key32, 
-        bytes memory data,
-        StateId state
-    ) 
-        internal
-    {
-        // update state
-        Blocknumber lastUpdatedIn = _updateState(key32, state);
-
-        // update data
-        _value[key32].data = data;
-
-        // solhint-disable-next-line avoid-tx-origin
-        emit LogInfoUpdated(key32.toObjectType(), key32.toKeyId(), state, msg.sender, tx.origin, lastUpdatedIn);
-    }
-
-
-    function _updateState(
-        Key32 key32, 
-        StateId state
-    )
-        internal
-        returns (Blocknumber lastUpdatedIn)
-    {
-        if (state.eqz()) {
-            revert ErrorKeyValueStoreStateZero(key32);
-        }
-
-        Metadata storage metadata = _value[key32].metadata;
-        StateId stateOld = metadata.state;
-        lastUpdatedIn = metadata.updatedIn;
-
-        if (stateOld.eqz()) {
-            revert ErrorKeyValueStoreNotExisting(key32);
-        }
-
-        // update state 
-        if(state != KEEP_STATE()) {
-            checkTransition(metadata.objectType, stateOld, state);
-            metadata.state = state;
-
-            // solhint-disable-next-line avoid-tx-origin
-            emit LogStateUpdated(key32.toObjectType(), key32.toKeyId(), stateOld, state, msg.sender, tx.origin, lastUpdatedIn);
-        }
-
-        // update metadata
-        metadata.updatedIn = blockBlocknumber();
-    }
-
-    function exists(Key32 key32) public view returns (bool) {
-        return _value[key32].metadata.state.gtz();
-    }
-
-    function get(Key32 key32) public view returns (Value memory value) {
-        return _value[key32];
-    }
-
-    function getMetadata(Key32 key32) public view returns (Metadata memory metadata) {
-        return _value[key32].metadata;
-    }
-
-    function getData(Key32 key32) public view returns (bytes memory data) {
-        return _value[key32].data;
-    }
-
-    function getState(Key32 key32) public view returns (StateId state) {
-        return _value[key32].metadata.state;
-    }
-
-    function toKey32(ObjectType objectType, KeyId id) external pure override returns(Key32) {
-        return Key32Lib.toKey32(objectType, id);
-    }
-}

package/contracts/staking/StakeManagerLib.sol

@@ -1,231 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
-
-import {Amount, AmountLib} from "../type/Amount.sol";
-import {Component} from "../shared/Component.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
-import {IRegistryService} from "../registry/IRegistryService.sol";
-import {IStaking} from "./IStaking.sol";
-import {Key32} from "../type/Key32.sol";
-import {NftId} from "../type/NftId.sol";
-import {ObjectType, INSTANCE, PROTOCOL, TARGET} from "../type/ObjectType.sol";
-import {Seconds, SecondsLib} from "../type/Seconds.sol";
-import {StakingReader} from "./StakingReader.sol";
-import {StakingStore} from "./StakingStore.sol";
-import {Timestamp, TimestampLib} from "../type/Timestamp.sol";
-import {UFixed, UFixedLib} from "../type/UFixed.sol";
-
-
-library StakeManagerLib {
-
-    function stake(
-        IRegistry registry,
-        StakingReader stakingReader,
-        StakingStore stakingStore,
-        NftId stakeNftId,
-        Amount stakeAmount
-    )
-        external
-        returns (Amount stakeBalance)
-    {
-        // check that target is active for staking
-        (
-            UFixed rewardRate,
-            Seconds lockingPeriod
-        ) = checkStakeParameters(
-            stakingReader, 
-            stakeNftId);        
-
-        // calculate new rewards (if any)
-        (
-            Amount rewardIncrementAmount, 
-            Amount currentTotalDipAmount
-        ) = calculateRewardIncrease(
-            stakingReader, 
-            stakeNftId,
-            rewardRate);
-
-        stakeBalance = currentTotalDipAmount + stakeAmount;
-
-        // TODO check that additional dip, rewards and rewards increment 
-        // are still ok with max target staking amount
-        NftId targetNftId = registry.getObjectInfo(stakeNftId).parentNftId;
-
-        stakingStore.restakeRewards(
-            stakeNftId, 
-            targetNftId, 
-            rewardIncrementAmount);
-
-        stakingStore.increaseStake(
-            stakeNftId, 
-            targetNftId, 
-            stakeAmount);
-
-        // update locked until with target locking period
-        stakingStore.update(
-            stakeNftId, 
-            IStaking.StakeInfo({
-                lockedUntil: TimestampLib.blockTimestamp().addSeconds(
-                    lockingPeriod)}));
-
-    }
-
-    function checkCreateParameters(
-        StakingReader stakingReader,
-        NftId targetNftId, 
-        Amount dipAmount
-    )
-        external
-        view
-        returns (
-            Timestamp lockedUntil
-        )
-    {
-        Seconds lockingPeriod = checkTarget(stakingReader, targetNftId);
-        checkDipAmount(stakingReader, targetNftId, dipAmount);
-
-        Timestamp currentTime = TimestampLib.blockTimestamp();
-        lockedUntil = currentTime.addSeconds(lockingPeriod);
-    }
-
-
-    function checkStakeParameters(
-        StakingReader stakingReader,
-        NftId stakeNftId
-    )
-        public
-        view
-        returns (
-            UFixed rewardRate,
-            Seconds lockingPeriod
-        )
-    {
-        NftId targetNftId = stakingReader.getTargetNftId(stakeNftId);
-
-        // only accept stakes for active targets
-        if (!stakingReader.isActive(targetNftId)) {
-            revert IStaking.ErrorStakingTargetNotActive(targetNftId);
-        }
-
-        IStaking.TargetInfo memory info = stakingReader.getTargetInfo(targetNftId);
-        rewardRate = info.rewardRate;
-        lockingPeriod = info.lockingPeriod;
-    }
-
-
-    function checkTarget(
-        StakingReader stakingReader,
-        NftId targetNftId
-    )
-        public
-        view
-        returns (Seconds lockingPeriod)
-    {
-        // target nft id must be registered
-        if (!stakingReader.isTarget(targetNftId)) {
-            revert IStaking.ErrorStakingNotTarget(targetNftId);
-        }
-
-        // only accept stakes for active targets
-        if (!stakingReader.isActive(targetNftId)) {
-            revert IStaking.ErrorStakingTargetNotActive(targetNftId);
-        }
-
-        lockingPeriod = stakingReader.getTargetInfo(targetNftId).lockingPeriod;
-    }
-
-
-    function checkDipAmount(
-        StakingReader stakingReader,
-        NftId targetNftId, 
-        Amount dipAmount
-    )
-        public 
-        pure 
-    {
-        // check stake amount > 0
-        if (dipAmount.eqz()) {
-            revert IStaking.ErrorStakingStakeAmountZero(targetNftId);
-        }
-
-        // 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,
-        UFixed rewardRate
-    )
-        public
-        view
-        returns (
-            Amount rewardIncreaseAmount,
-            Amount totalDipAmount
-        )
-    {
-        (
-            Amount stakeAmount,
-            Amount rewardAmount,
-            Timestamp lastUpdatedAt
-        ) = stakingReader.getStakeBalances(stakeNftId);
-
-        Seconds duration = SecondsLib.toSeconds(
-            block.timestamp - lastUpdatedAt.toInt());
-        
-        rewardIncreaseAmount = calculateRewardAmount(
-            rewardRate,
-            duration,
-            stakeAmount);
-
-        totalDipAmount = stakeAmount + rewardAmount + rewardIncreaseAmount;
-    }
-
-
-    function calculateRewardAmount(
-        UFixed rewardRate,
-        Seconds duration, 
-        Amount stakeAmount
-    )
-        public 
-        pure 
-        returns(
-            Amount rewardAmount
-        )
-    {
-        UFixed rewardRateFraction = getYearFraction(duration) * rewardRate;
-        rewardAmount = stakeAmount.multiplyWith(rewardRateFraction);
-    }
-
-
-    function getYearFraction(Seconds duration) public pure returns (UFixed yearFraction) {
-        return UFixedLib.toUFixed(duration.toInt()) / UFixedLib.toUFixed(SecondsLib.oneYear().toInt());
-    }
-
-}

package/contracts/staking/StakingLifecycle.sol

@@ -1,23 +0,0 @@
-// SPDX-License-Identifier: Apache-2.0
-pragma solidity ^0.8.20;
-
-import {TARGET, COMPONENT, STAKE} from "../type/ObjectType.sol";
-import {INITIAL} from "../type/StateId.sol";
-import {Lifecycle} from "../shared/Lifecycle.sol";
-
-contract StakingLifecycle is
-    Lifecycle
-{
-    constructor() {
-        _setupLifecycle();
-    }
-
-    function _setupLifecycle()
-        internal
-        override
-    {
-        setInitialState(TARGET(), INITIAL());
-        setInitialState(COMPONENT(), INITIAL());
-        setInitialState(STAKE(), INITIAL());
-    }
-}