Merge pull request #80 from Kiwari-Labs/develop/ERC7818B

refactor: reduce abstract level keep it minimal

Author: MASDXI

.github/workflows/release.yaml

@@ -57,7 +57,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           cache: "yarn"
-          node-version: 18.x
+          node-version: 22.x
           architecture: x64
           registry-url: https://registry.npmjs.org/
 

README.md

@@ -16,56 +16,33 @@ Install via `yarn`
 yarn add --dev @kiwarilabs/contracts@stable
 ```
 
-## Usage
+## Example Usage
 
 ### ERC-7818
 
+> [!IMPORTANT]
+>  Some Layer 2 (L2) use precompiled contract or system contract for current block number instead of `block.number`.
+
 ```solidity
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {ERC20EXPBase} from "@kiwarilabs/contracts/tokens/ERC20/ERC20EXPBase.sol";
-import {ERC20BLSW} from "@kiwarilabs/contracts/tokens/ERC20/ERC20BLSW.sol";
+import {ERC7818} from "@kiwarilabs/contracts/tokens/ERC20/ERC20EXPBase.sol";
 
-contract ExpirableERC20 is ERC20BLSW {
-  constructor(
+contract MyToken is ERC7818 {
+    constructor(
         string memory _name,
         string memory _symbol,
         uint40 blocksPerEpoch_,
         uint8 windowSize_
-    ) ERC20BLSW(_name, _symbol, block.number, blocksPerEpoch_, windowSize_, false) {}
-
-    function _epochType() internal pure virtual override(ERC20EXPBase, ERC20BLSW) returns (EPOCH_TYPE) {
-        return super._epochType();
-    }
-
-    function _getEpoch(uint256 pointer) internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint256) {
-        return super._getEpoch(pointer);
-    }
-
-    function _getWindowRage(
-        uint256 pointer
-    ) internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint256 fromEpoch, uint256 toEpoch) {
-        return super._getWindowRage(pointer);
-    }
-
-    function _getWindowSize() internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint8) {
-        return super._getWindowSize();
-    }
+    ) ERC7818(_name, _symbol, block.number, blocksPerEpoch_, windowSize_, false) {}
 
-    function _getPointersInEpoch() internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint40) {
-        return super._getPointersInEpoch();
+    function epochType() internal pure virtual override returns (EPOCH_TYPE) {
+        return EPOCH_TYPE.BLOCKS_BASED;
     }
 
-    function _getPointersInWindow() internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint40) {
-        return super._getPointersInWindow();
-    }
-
-    /// @notice In some Layer 2 (L2) use pre-compiled/system-contract to get block height instead of block.number.
-    /// @dev Retrieve block.number as pointer in block-based lazy sliding window.
-    /// @return uint256 return the current block height.
-    function _pointerProvider() internal view virtual override(ERC20EXPBase, ERC20BLSW) returns (uint256) {
-        return super._pointerProvider();
+    function _pointerProvider() internal view virtual override returns (uint256) {
+        return block.number;
     }
 }
 ```
@@ -75,49 +52,55 @@ contract ExpirableERC20 is ERC20BLSW {
 #### Individual Expiration
 
 ``` Solidity
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {ERC7858BLSW} from "@kiwarilabs/contracts/tokens/ERC721/ERC7858BLSW.sol";
-import {ERC7858EXPBase} from "@kiwarilabs/contracts/tokens/ERC721/ERC7858EXPBase.sol";
+import {ERC7858} from "@kiwarilabs/contracts/tokens/ERC721/ERC7858.sol";
 
-// Expirable ERC721 with individual expiration
-contract ExpirableERC721 is ERC7858BLSW {
+contract MyToken is ERC7858 {
+    constructor (string memory name_, string memory symbol_) ERC7858(name_, symbol) {}
 
-    constructor (string memory name_, string memory symbol_) ERC7858BLSW(name_, symbol) {}
+    function expiryType() public pure override returns (EXPIRY_TYPE) {
+        return EXPIRY_TYPE.BLOCKS_BASED;
+    }
 
+    function _pointerProvider() internal view virtual override returns (uint256) {
+        return block.number;
+    }
 }
 ```
 
 #### Epoch Expiration
 
 ``` Solidity
-// SPDX-License-Identifier: Apache-2.0
+// SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
-import {ERC7858EpochBLSW} from "@kiwarilabs/contracts/tokens/ERC721/extensions/ERC7858EpochBLSW.sol";
-import {ERC7858EXPEpochBase} from "@kiwarilabs/contracts/tokens/ERC721/extensions/ERC7858EXPEpochBase.sol";
+import {ERC7858Epoch} from "@kiwarilabs/contracts/tokens/ERC721/extensions/ERC7858Epoch.sol";
 
-// Expirable ERC721 with epoch expiration
-contract ExpirableERC7858 is ERC7858EpochBLSW {
-    
+contract MyToken is ERC7858Epoch {
     constructor (
         string memory name_, 
         string memory symbol_, 
         uint256 initialBlockNumber_,
         uint40 blocksPerEpoch_,
-        uint8 windowSize_,
-        bool development_) 
-        ERC7858EpochBLSW(
+        uint8 windowSize_)
+        ERC7858Epoch(
             name_, 
             symbol_, 
             initialBlockNumber_,
             blocksPerEpoch_,
             windowSize_,
             development) {}
 
-}
+    function expiryType() public pure override returns (EXPIRY_TYPE) {
+        return EXPIRY_TYPE.BLOCKS_BASED;
+    }
 
+    function _pointerProvider() internal view virtual override returns (uint256) {
+        return block.number;
+    }
+}
 ```
 
 ## Contribute

contracts/abstracts/AbstractBLSW.sol

@@ -1,7 +1,7 @@
 {
   "private": false,
   "name": "@kiwarilabs/contracts",
-  "version": "1.0.2-rc2",
+  "version": "2.0.0-rc1",
   "license": "Apache-2.0",
   "author": "kiwari-labs <kiwarilabs@protonmail.com> (https://github.com/Kiwari-Labs)",
   "repository": {