@etherisc/gif-next 0.0.2-f18fb8b-243 → 0.0.2-f1f3b2c-994

package/contracts/shared/IPolicyHolder.sol

@@ -9,37 +9,27 @@ import {ClaimId} from "../type/ClaimId.sol";
 import {IRegistryLinked} from "../shared/IRegistryLinked.sol";
 import {NftId} from "../type/NftId.sol";
 import {PayoutId} from "../type/PayoutId.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
-/// @dev generic interface for contracts that need to hold policies and receive payouts
-/// GIF will notify policy holder contracts for policy creation and payout execution
+/// @dev Generic interface for contracts that need to hold policies and receive payouts.
+/// The framework notifies policy holder contracts for policy creation/expiry, claim confirmation and payout execution
 interface IPolicyHolder is
     IERC165,
     IERC721Receiver,
     IRegistryLinked
 {
 
-    /// @dev callback function that will be called after successful policy activation
-    /// active policies may open claims under the activated policy
-    function policyActivated(NftId policyNftId) external;
+    /// @dev Callback function that will be called after successful policy activation.
+    /// Active policies may open claims under the activated policy.
+    function policyActivated(NftId policyNftId, Timestamp activatedAt) external;
 
-    /// @dev callback function to indicate the specified policy has expired
-    /// expired policies may no longer open claims
-    /// it is optional for products to notifiy policy holder of expired claims
-    function policyExpired(NftId policyNftId) external;
+    /// @dev Callback function to indicate the specified policy has expired.
+    /// expired policies no longer accept new claims.
+    function policyExpired(NftId policyNftId, Timestamp expiredAt) external;
 
-    /// @dev request for a payout by the requesting policy
-    /// the contract implements its use case specific handling for such requests.
-    /// eg. creation of a pending payout, a corresponding claim against one of the policies held by the IPolicyHolder
-    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external;
-
-    /// @dev callback function to notify the confirmation of the specified claim
-    /// active policies may open claims under the activated policy
+    /// @dev Callback function to notify the confirmation of the specified claim.
     function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external;
 
-    /// @dev callback function that will be called after a successful payout
-    function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external;
-
-    /// @dev determines policy and claim specific beneficiary address
-    /// returned address will override GIF default where the policy nft holder is treated as beneficiary
-    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external view returns (address beneficiary);
+    /// @dev Callback function to notify the successful payout.
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external;
 }

package/contracts/shared/IService.sol

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
 
 import {IRegisterable} from "./IRegisterable.sol";
-import {IVersionable} from "./IVersionable.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType} from "../type/ObjectType.sol";
 import {RoleId} from "../type/RoleId.sol";
 

package/contracts/shared/{ERC165.sol → InitializableERC165.sol}

@@ -4,20 +4,20 @@ pragma solidity ^0.8.20;
 import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
-contract ERC165 is
+contract InitializableERC165 is
     Initializable,
     IERC165
 {
     mapping(bytes4 => bool) private _isSupported;
 
     // @dev initializes with support for ERC165
-    function initializeERC165() public onlyInitializing() {
+    function _initializeERC165() internal onlyInitializing() {
         _isSupported[type(IERC165).interfaceId] = true;
     }
 
     // @dev register support for provided interfaceId
     // includes initialization for ERC165_ID if not yet done
-    function registerInterface(bytes4 interfaceId) public onlyInitializing() {
+    function _registerInterface(bytes4 interfaceId) internal onlyInitializing() {
         _isSupported[interfaceId] = true;
     }
 

package/contracts/shared/InstanceLinkedComponent.sol

@@ -6,6 +6,7 @@ import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessMana
 import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
 import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 
+import {Amount} from "../type/Amount.sol";
 import {Component} from "./Component.sol";
 import {IComponentService} from "./IComponentService.sol";
 import {IInstanceLinkedComponent} from "./IInstanceLinkedComponent.sol";
@@ -36,6 +37,7 @@ abstract contract InstanceLinkedComponent is
         IInstance _instance; // instance for this component
         InstanceReader _instanceReader; // instance reader for this component
         IAuthorization _initialAuthorization;
+        IComponentService _componentService;
     }
 
     function lock() external onlyOwner {
@@ -58,6 +60,17 @@ abstract contract InstanceLinkedComponent is
         return _getInstanceLinkedComponentStorage()._initialAuthorization;
     }
 
+    /// @inheritdoc IInstanceLinkedComponent
+    function withdrawFees(Amount amount)
+        external
+        virtual
+        onlyOwner()
+        restricted()
+        returns (Amount withdrawnAmount)
+    {
+        return _withdrawFees(amount);
+    }
+
     function _getInstanceLinkedComponentStorage() private pure returns (InstanceLinkedComponentStorage storage $) {
         assembly {
             $.slot := INSTANCE_LINKED_COMPONENT_LOCATION_V1
@@ -83,14 +96,13 @@ abstract contract InstanceLinkedComponent is
         // set and check linked instance
         InstanceLinkedComponentStorage storage $ = _getInstanceLinkedComponentStorage();
         $._instance = IInstance(
-            IRegistry(registry).getObjectInfo(
-                instanceNftId).objectAddress);
+            IRegistry(registry).getObjectAddress(instanceNftId));
 
         if(!$._instance.supportsInterface(type(IInstance).interfaceId)) {
             revert ErrorComponentNotInstance(instanceNftId);
         }
 
-        initializeComponent(
+        _initializeComponent(
             $._instance.authority(), 
             registry, 
             instanceNftId, 
@@ -105,9 +117,10 @@ abstract contract InstanceLinkedComponent is
         // set component state
         $._instanceReader = $._instance.getInstanceReader();
         $._initialAuthorization = authorization;
+        $._componentService = IComponentService(_getServiceAddress(COMPONENT())); 
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IInstanceLinkedComponent).interfaceId);
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IInstanceLinkedComponent).interfaceId);
     }
 
     /// @dev for instance linked components the wallet address stored in the instance store.
@@ -118,7 +131,7 @@ abstract contract InstanceLinkedComponent is
 
 
     function _getComponentInfo() internal virtual override view returns (IComponents.ComponentInfo memory info) {
-        NftId componentNftId = getRegistry().getNftId(address(this));
+        NftId componentNftId = getRegistry().getNftIdForAddress(address(this));
 
         // if registered, attempt to return component info via instance reader
         if (componentNftId.gtz()) {
@@ -141,6 +154,13 @@ abstract contract InstanceLinkedComponent is
         return _getInstanceLinkedComponentStorage()._instanceReader;
     }
 
+    function _withdrawFees(Amount amount)
+        internal
+        returns (Amount withdrawnAmount)
+    {
+        return _getInstanceLinkedComponentStorage()._componentService.withdrawFees(amount);
+    }
+
 
     /// @dev returns the service address for the specified domain
     /// gets address via lookup from registry using the major version form the linked instance

package/contracts/shared/KeyValueStore.sol

@@ -94,7 +94,7 @@ abstract contract KeyValueStore is
 
         // update state 
         if(state != KEEP_STATE()) {
-            checkTransition(metadata.objectType, stateOld, state);
+            checkTransition(stateOld, metadata.objectType, stateOld, state);
             metadata.state = state;
 
             // solhint-disable-next-line avoid-tx-origin

package/contracts/shared/Lifecycle.sol

@@ -49,6 +49,7 @@ abstract contract Lifecycle is
     }
 
     function checkTransition(
+        StateId stateId,
         ObjectType objectType,
         StateId fromId,
         StateId toId
@@ -58,12 +59,22 @@ abstract contract Lifecycle is
     {
         // revert if no life cycle support
         if (_initialState[objectType].eqz()) {
-            revert ErrorNoLifecycle(objectType);
+            revert ErrorNoLifecycle(address(this), objectType);
         }
 
+        // revert if current state is not `from` state
+        if(stateId != fromId) {
+            revert ErrorFromStateMissmatch(address(this), objectType, stateId, fromId);
+        }
+        // TODO consider assert instead of error -> each child must check only for valid transitions
         // enforce valid state transition
         if (!_isValidTransition[objectType][fromId][toId]) {
-            revert ErrorInvalidStateTransition(objectType, fromId, toId);
+            revert ErrorInvalidStateTransition(
+                address(this),
+                objectType, 
+                fromId, 
+                toId
+            );
         }
     }
 

package/contracts/shared/{NftIdSetManager.sol → NftIdSet.sol}

@@ -4,7 +4,7 @@ pragma solidity ^0.8.20;
 import {LibNftIdSet} from "../type/NftIdSet.sol";
 import {NftId} from "../type/NftId.sol";
 
-contract NftIdSetManager {
+contract NftIdSet {
 
     error ErrorNftIdSetManagerNotOwner(address owner, address sender);
     error ErrorNftIdSetManagerOwnerAlreadySet(address owner);

package/contracts/shared/NftOwnable.sol

@@ -1,13 +1,13 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {ERC165} from "./ERC165.sol";
+import {InitializableERC165} from "./InitializableERC165.sol";
 import {INftOwnable} from "./INftOwnable.sol";
 import {NftId} from "../type/NftId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
 
 contract NftOwnable is
-    ERC165,
+    InitializableERC165,
     RegistryLinked,
     INftOwnable
 {
@@ -30,16 +30,16 @@ contract NftOwnable is
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function initializeNftOwnable(
+    function _initializeNftOwnable(
         address initialOwner,
         address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-        initializeERC165();
+        _initializeRegistryLinked(registryAddress);
+        _initializeERC165();
 
         if(initialOwner == address(0)) {
             revert ErrorNftOwnableInitialOwnerZero();
@@ -93,7 +93,7 @@ contract NftOwnable is
             revert ErrorNftOwnableContractNotRegistered(nftOwnableAddress);
         }
 
-        $._nftId = getRegistry().getNftId(nftOwnableAddress);
+        $._nftId = getRegistry().getNftIdForAddress(nftOwnableAddress);
 
         return $._nftId;
     }

package/contracts/shared/PolicyHolder.sol

@@ -1,74 +1,50 @@
 // SPDX-License-Identifier: Apache-2.0
 pragma solidity ^0.8.20;
 
-import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
 import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
-import {Initializable} from "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol"; 
 
 import {Amount} from "../type/Amount.sol";
 import {ClaimId} from "../type/ClaimId.sol";
-import {ERC165} from "./ERC165.sol";
+import {InitializableERC165} from "./InitializableERC165.sol";
 import {IPolicyHolder} from "./IPolicyHolder.sol";
 import {NftId} from "../type/NftId.sol";
 import {PayoutId, PayoutIdLib} from "../type/PayoutId.sol";
 import {RegistryLinked} from "./RegistryLinked.sol";
-import {IRegistry} from "../registry/IRegistry.sol";
+import {Timestamp} from "../type/Timestamp.sol";
 
 /// @dev template implementation for IPolicyHolder
 contract PolicyHolder is
-    ERC165,
-    RegistryLinked, // TODO need upgradeable version
+    InitializableERC165,
+    RegistryLinked,
     IPolicyHolder
 {
-    // keccak256(abi.encode(uint256(keccak256("etherisc.storage.PolicyHolder")) - 1)) & ~bytes32(uint256(0xff));
-    // TODO fix address
-    bytes32 public constant POLICY_HOLDER_STORAGE_LOCATION_V1 = 0x07ebcf49758b6ed3af50fa146bec0abe157c0218fe65dc0874c286e9d5da4f00;
+    // TODO add modifier to protect callback functions from unauthorized access
+    // callbacks must only be allowed from the policy and claim services
+    // will need a release parameter to fetch the right service addresses for the modifiers
 
-    struct PolicyHolderStorage {
-        mapping(NftId policyId => mapping(PayoutId payoutId => address beneficiary)) _beneficiary;
-        address _beneficiaryDefault;
-    }
-
-    function initializePolicyHolder(
-        address registryAddress,
-        address beneficiaryDefault
+    function _initializePolicyHolder(
+        address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegistryLinked(registryAddress);
-
-        _getPolicyHolderStorage()._beneficiaryDefault = beneficiaryDefault;
-
-        registerInterface(type(IPolicyHolder).interfaceId);
+        _initializeRegistryLinked(registryAddress);
+        _initializeERC165();
+        _registerInterface(type(IPolicyHolder).interfaceId);
     }
 
     /// @dev empty default implementation
-    function requestPayout(NftId requestingPolicyNftId, Amount requestedPayoutAmount) external { }
+    function policyActivated(NftId policyNftId, Timestamp activatedAt) external virtual {}
 
     /// @dev empty default implementation
-    function policyActivated(NftId policyNftId) external {}
+    function policyExpired(NftId policyNftId, Timestamp expiredAt) external virtual {}
 
     /// @dev empty default implementation
-    function policyExpired(NftId policyNftId) external {}
+    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external virtual {}
 
     /// @dev empty default implementation
-    function claimConfirmed(NftId policyNftId, ClaimId claimId, Amount amount) external {}
-
-    /// @dev empty default implementation
-    function payoutExecuted(NftId policyNftId, PayoutId payoutId, address beneficiary, Amount amount) external {}
-
-    /// @dev returns payout specific beneficiary
-    /// when no such beneficiary is defined the policy specific beneficiary is returned
-    function getBeneficiary(NftId policyNftId, PayoutId payoutId) external virtual view returns (address beneficiary) {
-        beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId];
-
-        // fallback to claim independent beneficiary
-        if(beneficiary == address(0) && payoutId.gtz()) {
-            beneficiary = _getPolicyHolderStorage()._beneficiary[policyNftId][PayoutIdLib.zero()];
-        }
-    }
+    function payoutExecuted(NftId policyNftId, PayoutId payoutId, Amount amount, address beneficiary) external virtual {}
 
     //--- IERC165 functions ---------------// 
     function onERC721Received(
@@ -83,20 +59,4 @@ contract PolicyHolder is
     {
         return IERC721Receiver.onERC721Received.selector;
     }
-
-    /// @dev sets policy specific beneficiary (used when no payout specific beneficiary is defined)
-    function _setBeneficiary(NftId policyNftId, address beneficiary) internal {
-        _setBeneficiary(policyNftId, PayoutIdLib.zero(), beneficiary);
-    }
-
-    /// @dev sets policy and claim specific beneficiary
-    function _setBeneficiary(NftId policyNftId, PayoutId payoutId, address beneficiary) internal {
-        _getPolicyHolderStorage()._beneficiary[policyNftId][payoutId] = beneficiary;
-    }
-
-    function _getPolicyHolderStorage() private pure returns (PolicyHolderStorage storage $) {
-        assembly {
-            $.slot := POLICY_HOLDER_STORAGE_LOCATION_V1
-        }
-    }
 }

package/contracts/shared/Registerable.sol

@@ -24,7 +24,7 @@ contract Registerable is
         bytes _data;
     }
 
-    function initializeRegisterable(
+    function _initializeRegisterable(
         address registryAddress,
         NftId parentNftId,
         ObjectType objectType,
@@ -32,11 +32,11 @@ contract Registerable is
         address initialOwner,
         bytes memory registryData // writeonly data that will saved in the object info record of the registry
     )
-        public
+        internal
         virtual
-        onlyInitializing
+        onlyInitializing()
     {
-        initializeNftOwnable(
+        _initializeNftOwnable(
             initialOwner,
             registryAddress);
 

package/contracts/shared/RegistryLinked.sol

@@ -10,14 +10,15 @@ contract RegistryLinked is
     IRegistryLinked
 {
 
+    // priorize simplicity and size over using standard upgradeability structs
     IRegistry private _registry;
 
     /// @dev initialization for upgradable contracts
     // used in _initializeRegisterable
-    function initializeRegistryLinked(
+    function _initializeRegistryLinked(
         address registryAddress
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {

package/contracts/shared/Service.sol

@@ -3,16 +3,16 @@ pragma solidity ^0.8.20;
 
 import {AccessManagedUpgradeable} from "@openzeppelin/contracts-upgradeable/access/manager/AccessManagedUpgradeable.sol";
 import {IAccessManaged} from "@openzeppelin/contracts/access/manager/IAccessManaged.sol";
+import {ReentrancyGuardUpgradeable} from "@openzeppelin/contracts-upgradeable/utils/ReentrancyGuardUpgradeable.sol";
 
 import {IRegistry} from "../registry/IRegistry.sol";
 import {IService} from "./IService.sol";
-import {IVersionable} from "./IVersionable.sol";
-import {NftId} from "../type/NftId.sol";
+import {IVersionable} from "../upgradeability/IVersionable.sol";
 import {ObjectType, REGISTRY, SERVICE} from "../type/ObjectType.sol";
 import {Registerable} from "./Registerable.sol";
 import {RoleId, RoleIdLib} from "../type/RoleId.sol";
-import {Version, VersionPart, VersionLib, VersionPartLib} from "../type/Version.sol";
-import {Versionable} from "./Versionable.sol";
+import {Version, VersionLib, VersionPartLib} from "../type/Version.sol";
+import {Versionable} from "../upgradeability/Versionable.sol";
 
 
 /// @dev service base contract
@@ -20,28 +20,23 @@ abstract contract Service is
     Registerable,
     Versionable,
     AccessManagedUpgradeable,
+    ReentrancyGuardUpgradeable,
     IService
 {
 
     uint8 private constant GIF_MAJOR_VERSION = 3;
 
 
-    function initializeService(
+    function _initializeService(
         address registry, 
         address authority, // real authority for registry service adress(0) for other services
         address initialOwner
     )
-        public
+        internal
         virtual
         onlyInitializing()
     {
-        initializeRegisterable(
-            registry, 
-            IRegistry(registry).getNftId(), 
-            SERVICE(), 
-            false, // is interceptor
-            initialOwner, 
-            ""); // data
+        __ReentrancyGuard_init();
 
         // externally provided authority
         if(authority != address(0)) {
@@ -53,8 +48,17 @@ abstract contract Service is
             __AccessManaged_init(IAccessManaged(registryServiceAddress).authority());
         }
 
-        registerInterface(type(IAccessManaged).interfaceId);
-        registerInterface(type(IService).interfaceId);
+        _initializeRegisterable(
+            registry, 
+            IRegistry(registry).getNftId(), 
+            SERVICE(), 
+            false, // is interceptor
+            initialOwner, 
+            ""); // data
+
+
+        _registerInterface(type(IAccessManaged).interfaceId);
+        _registerInterface(type(IService).interfaceId);
     }
 
     function getDomain() external virtual pure returns(ObjectType serviceDomain) {

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());
+        }
     }
 }