feat: update contract

2 years ago · d7acf1f7f8
parent 94f8daa091
commit d7acf1f7f8
7 changed files with 527 additions and 98 deletions
--- a/.prettierignore
+++ b/.prettierignore
@ -3,3 +3,4 @@ artifacts
 cache
 coverage*
 gasReporterOutput.json
+typechain-types
--- a/.prettierrc
+++ b/.prettierrc
@ -1,3 +1,3 @@
 {
-  "printWidth": 120
+
 }
--- a/README.md
+++ b/README.md
@ -1,10 +1,9 @@
 # Contract Info

 - RPC : https://galileo.web3q.io:8545
- ChainId : 3334 
+- ChainId : 3334
 - Git3 Contract Address: 0x981cf56258Af8B6470642cBf1f991980cAa5DBf3

-
 # Sample Hardhat Project

 This project demonstrates a basic Hardhat use case. It comes with a sample contract, a test for that contract, and a script that deploys that contract.
--- a/contracts/Git3.sol
+++ b/contracts/Git3.sol
@ -5,98 +5,107 @@ import "hardhat/console.sol";
 import "./IFileOperator.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";
 import "git3-evm-large-storage/contracts/LargeStorageManager.sol";
+
 // import "evm-large-storage/contracts/W3RC3.sol";

 contract Git3 is LargeStorageManager {
+    struct refInfo {
+        bytes20 hash;
+        uint96 index;
+    }

-  struct refInfo {
-    bytes20 hash;
-    uint96 index; 
-  }
-
-  struct refData {
-    bytes20 hash;
-    string name;
-  }
-
-  mapping (string => refInfo) public nameToRefInfo; // dev => {hash: 0x1234..., index: 1 }
-  string[] public refs;  // [main, dev, test, staging]
-
-  function _convertRefInfo(refInfo memory info) internal view returns(refData memory res){
-    res.hash = info.hash;
-    res.name = refs[info.index];
-  }
-
-  constructor() LargeStorageManager(0) {
-  }
-
-  function download(bytes memory path) external view returns (bytes memory, bool) {
-    return _get(keccak256(path));
-  }
-
-  function upload(bytes memory path, bytes calldata data) external payable {
-    _putChunkFromCalldata(keccak256(path), 0, data,msg.value);
-  }
-
-  function uploadChunk(bytes memory path,uint256 chunkId,  bytes calldata data) external payable {
-    _putChunkFromCalldata(keccak256(path), chunkId, data,msg.value);
-  }
+    struct refData {
+        bytes20 hash;
+        string name;
+    }

-  function remove(bytes memory path) external {
-    // The actually process of remove will remove all the chunks
-    _remove(keccak256(path),0);
-  }
+    mapping(string => refInfo) public nameToRefInfo; // dev => {hash: 0x1234..., index: 1 }
+    string[] public refs; // [main, dev, test, staging]

-  function size(bytes memory name) external view returns (uint256,uint256){
-    return _size(keccak256(name));
-  }
+    function _convertRefInfo(
+        refInfo memory info
+    ) internal view returns (refData memory res) {
+        res.hash = info.hash;
+        res.name = refs[info.index];
+    }

-  function countChunks(bytes memory path)external view returns (uint256){
-    return _countChunks(keccak256(path));
-  }
+    constructor() LargeStorageManager(0) {}

-  function listRefs() public view returns (refData[] memory list) {
-    list = new refData[](refs.length);
-    for (uint index = 0; index < refs.length; index++) {
-      list[index] = _convertRefInfo(nameToRefInfo[refs[index]]);
+    function download(
+        bytes memory path
+    ) external view returns (bytes memory, bool) {
+        return _get(keccak256(path));
    }
-  }

-  function setRef(string memory name, bytes20 refHash) public {
-     // only execute `sload` once to reduce gas consumption
-    refInfo memory srs;
-    srs = nameToRefInfo[name];
-    uint256 refsLen = refs.length;
+    function upload(bytes memory path, bytes calldata data) external payable {
+        _putChunkFromCalldata(keccak256(path), 0, data, msg.value);
+    }

-    if (srs.hash == bytes20(0)) {
-      // store refHash for the first time
-      require(refsLen <= uint256(uint96(int96(-1))),"Refs exceed valid length");
+    function uploadChunk(
+        bytes memory path,
+        uint256 chunkId,
+        bytes calldata data
+    ) external payable {
+        _putChunkFromCalldata(keccak256(path), chunkId, data, msg.value);
+    }

-      nameToRefInfo[name].hash = refHash;
-      nameToRefInfo[name].index = uint96(refsLen);
+    function remove(bytes memory path) external {
+        // The actually process of remove will remove all the chunks
+        _remove(keccak256(path), 0);
+    }

-      refs.push(name);
+    function size(bytes memory name) external view returns (uint256, uint256) {
+        return _size(keccak256(name));
+    }

-    }else{
-      // only update refHash 
-      nameToRefInfo[name].hash = refHash;
+    function countChunks(bytes memory path) external view returns (uint256) {
+        return _countChunks(keccak256(path));
    }
-  }

-  function delRef(string memory name) public {
-    // only execute `sload` once to reduce gas consumption
-    refInfo memory srs;
-    srs = nameToRefInfo[name];
-    uint256 refsLen = refs.length;
+    function listRefs() public view returns (refData[] memory list) {
+        list = new refData[](refs.length);
+        for (uint index = 0; index < refs.length; index++) {
+            list[index] = _convertRefInfo(nameToRefInfo[refs[index]]);
+        }
+    }

-    require(srs.hash != bytes20(0),"The name of reference does not exist");
-    require(srs.index < refsLen,"System Error: Invalid index");
+    function setRef(string memory name, bytes20 refHash) public {
+        // only execute `sload` once to reduce gas consumption
+        refInfo memory srs;
+        srs = nameToRefInfo[name];
+        uint256 refsLen = refs.length;
+
+        if (srs.hash == bytes20(0)) {
+            // store refHash for the first time
+            require(
+                refsLen <= uint256(uint96(int96(-1))),
+                "Refs exceed valid length"
+            );
+
+            nameToRefInfo[name].hash = refHash;
+            nameToRefInfo[name].index = uint96(refsLen);
+
+            refs.push(name);
+        } else {
+            // only update refHash
+            nameToRefInfo[name].hash = refHash;
+        }
+    }

-    if (srs.index < refsLen-1){
-      refs[srs.index] = refs[refsLen - 1];
-      nameToRefInfo[refs[refsLen - 1]].index = srs.index;
+    function delRef(string memory name) public {
+        // only execute `sload` once to reduce gas consumption
+        refInfo memory srs;
+        srs = nameToRefInfo[name];
+        uint256 refsLen = refs.length;
+
+        require(srs.hash != bytes20(0), "The name of reference does not exist");
+        require(srs.index < refsLen, "System Error: Invalid index");
+
+        if (srs.index < refsLen - 1) {
+            refs[srs.index] = refs[refsLen - 1];
+            nameToRefInfo[refs[refsLen - 1]].index = srs.index;
+        }
+        refs.pop();
+        delete nameToRefInfo[name];
    }
-    refs.pop();
-    delete nameToRefInfo[name];
-  }
-}
+}
--- a/contracts/IFileOperator.sol
+++ b/contracts/IFileOperator.sol
@ -21,17 +21,32 @@ interface IFileOperator {
        bytes memory data
    ) external payable;

-    function readChunk(bytes memory name, uint256 chunkId) external view returns (bytes memory, bool);
+    function readChunk(
+        bytes memory name,
+        uint256 chunkId
+    ) external view returns (bytes memory, bool);

-    function chunkSize(bytes memory name, uint256 chunkId) external view returns (uint256, bool);
+    function chunkSize(
+        bytes memory name,
+        uint256 chunkId
+    ) external view returns (uint256, bool);

-    function removeChunk(bytes memory name, uint256 chunkId) external returns (bool);
+    function removeChunk(
+        bytes memory name,
+        uint256 chunkId
+    ) external returns (bool);

-    function truncate(bytes memory name, uint256 chunkId) external returns (uint256);
+    function truncate(
+        bytes memory name,
+        uint256 chunkId
+    ) external returns (uint256);

    function refund() external;

    function destruct() external;

-    function getChunkHash(bytes memory name, uint256 chunkId) external view returns (bytes32);
+    function getChunkHash(
+        bytes memory name,
+        uint256 chunkId
+    ) external view returns (bytes32);
 }
--- a/package-lock.json
+++ b/package-lock.json
@ -17,7 +17,9 @@
        "@nomicfoundation/hardhat-toolbox": "^2.0.0",
        "dotenv": "^16.0.3",
        "hardhat": "^2.12.4",
-        "prettier": "2.8.1"
+        "prettier": "2.8.1",
+        "prettier-check": "^2.0.0",
+        "prettier-plugin-solidity": "^1.0.0-beta.18"
      }
    },
    "node_modules/@cspotcode/source-map-support": {
@ -1737,7 +1739,6 @@
      "resolved": "https://registry.npmjs.org/@solidity-parser/parser/-/parser-0.14.5.tgz",
      "integrity": "sha512-6dKnHZn7fg/iQATVEzqyUOyEidbn05q7YA2mQ9hC0MMXhhV3/JrsxmFSYZAcr7j1yUP700LLhTruvJ3MiQmjJg==",
      "dev": true,
-      "peer": true,
      "dependencies": {
        "antlr4ts": "^0.5.0-alpha.4"
      }
@ -2155,8 +2156,7 @@
      "version": "0.5.0-alpha.4",
      "resolved": "https://registry.npmjs.org/antlr4ts/-/antlr4ts-0.5.0-alpha.4.tgz",
      "integrity": "sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==",
-      "dev": true,
-      "peer": true
+      "dev": true
    },
    "node_modules/anymatch": {
      "version": "3.1.3",
@ -3054,6 +3054,33 @@
      "dev": true,
      "peer": true
    },
+    "node_modules/cross-spawn": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz",
+      "integrity": "sha512-pTgQJ5KC0d2hcY8eyL1IzlBPYjTkyH72XRZPnLyKus2mBfNjQs3klqbJU2VILqZryAZUt9JOb3h/mWMy23/f5A==",
+      "dev": true,
+      "dependencies": {
+        "lru-cache": "^4.0.1",
+        "shebang-command": "^1.2.0",
+        "which": "^1.2.9"
+      }
+    },
+    "node_modules/cross-spawn/node_modules/lru-cache": {
+      "version": "4.1.5",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz",
+      "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==",
+      "dev": true,
+      "dependencies": {
+        "pseudomap": "^1.0.2",
+        "yallist": "^2.1.2"
+      }
+    },
+    "node_modules/cross-spawn/node_modules/yallist": {
+      "version": "2.1.2",
+      "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz",
+      "integrity": "sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==",
+      "dev": true
+    },
    "node_modules/crypt": {
      "version": "0.0.2",
      "resolved": "https://registry.npmjs.org/crypt/-/crypt-0.0.2.tgz",
@ -4251,6 +4278,24 @@
        "safe-buffer": "^5.1.1"
      }
    },
+    "node_modules/execa": {
+      "version": "0.6.3",
+      "resolved": "https://registry.npmjs.org/execa/-/execa-0.6.3.tgz",
+      "integrity": "sha512-/teX3MDLFBdYUhRk8WCBYboIMUmqeizu0m9Z3YF3JWrbEh/SlZg00vLJSaAGWw3wrZ9tE0buNw79eaAPYhUuvg==",
+      "dev": true,
+      "dependencies": {
+        "cross-spawn": "^5.0.1",
+        "get-stream": "^3.0.0",
+        "is-stream": "^1.1.0",
+        "npm-run-path": "^2.0.0",
+        "p-finally": "^1.0.0",
+        "signal-exit": "^3.0.0",
+        "strip-eof": "^1.0.0"
+      },
+      "engines": {
+        "node": ">=4"
+      }
+    },
    "node_modules/extend": {
      "version": "3.0.2",
      "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz",
@ -4538,6 +4583,15 @@
        "node": ">=4"
      }
    },
+    "node_modules/get-stream": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz",
+      "integrity": "sha512-GlhdIUuVakc8SJ6kK0zAFbiGzRFzNnY4jUuEbV9UROo4Y+0Ny4fjvcZFVTeDA4odpFyOQzaw6hXukJSq/f28sQ==",
+      "dev": true,
+      "engines": {
+        "node": ">=4"
+      }
+    },
    "node_modules/get-symbol-description": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz",
@ -5357,6 +5411,15 @@
        "url": "https://github.com/sponsors/ljharb"
      }
    },
+    "node_modules/is-stream": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz",
+      "integrity": "sha512-uQPm8kcs47jx38atAcWTVxyltQYoPT68y9aWYdV6yWXSyW8mzSat0TL6CiWdZeCdF3KrAvpVtnHbTv4RN+rqdQ==",
+      "dev": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
    "node_modules/is-string": {
      "version": "1.0.7",
      "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz",
@ -5432,8 +5495,7 @@
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
      "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==",
-      "dev": true,
-      "peer": true
+      "dev": true
    },
    "node_modules/isstream": {
      "version": "0.1.2",
@ -6216,6 +6278,18 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/npm-run-path": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz",
+      "integrity": "sha512-lJxZYlT4DW/bRUtFh1MQIWqmLwQfAxnqWG4HhEdjMlkrJYnJn0Jrr2u3mgxqaWsdiBc76TYkTG/mhrnYTuzfHw==",
+      "dev": true,
+      "dependencies": {
+        "path-key": "^2.0.0"
+      },
+      "engines": {
+        "node": ">=4"
+      }
+    },
    "node_modules/number-to-bn": {
      "version": "1.7.0",
      "resolved": "https://registry.npmjs.org/number-to-bn/-/number-to-bn-1.7.0.tgz",
@ -6361,6 +6435,15 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/p-finally": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz",
+      "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==",
+      "dev": true,
+      "engines": {
+        "node": ">=4"
+      }
+    },
    "node_modules/p-limit": {
      "version": "1.3.0",
      "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz",
@ -6434,6 +6517,15 @@
        "node": ">=0.10.0"
      }
    },
+    "node_modules/path-key": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz",
+      "integrity": "sha512-fEHGKCSmUSDPv4uoj8AlD+joPlq3peND+HRYyxFz4KPw4z926S/b8rIuFs2FYJg3BwsxJf6A9/3eIdLaYC+9Dw==",
+      "dev": true,
+      "engines": {
+        "node": ">=4"
+      }
+    },
    "node_modules/path-parse": {
      "version": "1.0.7",
      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
@ -6530,6 +6622,97 @@
        "url": "https://github.com/prettier/prettier?sponsor=1"
      }
    },
+    "node_modules/prettier-check": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/prettier-check/-/prettier-check-2.0.0.tgz",
+      "integrity": "sha512-HZG53XQTJ9Cyi5hi1VFVVFxdlhITJybpZAch3ib9KqI05VUxV+F5Hip0GhSWRItrlDzVyqjSoDQ9KqIn7AHYyw==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "execa": "^0.6.0"
+      },
+      "bin": {
+        "prettier-check": "cli.js"
+      },
+      "engines": {
+        "node": ">=4"
+      },
+      "peerDependencies": {
+        "prettier": "x.x.x"
+      }
+    },
+    "node_modules/prettier-plugin-solidity": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/prettier-plugin-solidity/-/prettier-plugin-solidity-1.0.0.tgz",
+      "integrity": "sha512-gRJCeZ7imbWtNYN2SudjJoPmka5r6jcd2cSTV6FC3pVCtY6LFZbeQQjpKufUEp88hXBAAnkOTOh7TA5xwj9M3A==",
+      "dev": true,
+      "license": "MIT",
+      "dependencies": {
+        "@solidity-parser/parser": "^0.14.5",
+        "emoji-regex": "^10.2.1",
+        "escape-string-regexp": "^4.0.0",
+        "semver": "^7.3.8",
+        "solidity-comments-extractor": "^0.0.7",
+        "string-width": "^4.2.3"
+      },
+      "engines": {
+        "node": ">=12"
+      },
+      "peerDependencies": {
+        "prettier": "^2.3.0"
+      }
+    },
+    "node_modules/prettier-plugin-solidity/node_modules/emoji-regex": {
+      "version": "10.2.1",
+      "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.2.1.tgz",
+      "integrity": "sha512-97g6QgOk8zlDRdgq1WxwgTMgEWGVAQvB5Fdpgc1MkNy56la5SKP9GsMXKDOdqwn90/41a8yPwIGk1Y6WVbeMQA==",
+      "dev": true
+    },
+    "node_modules/prettier-plugin-solidity/node_modules/escape-string-regexp": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+      "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+      "dev": true,
+      "engines": {
+        "node": ">=10"
+      },
+      "funding": {
+        "url": "https://github.com/sponsors/sindresorhus"
+      }
+    },
+    "node_modules/prettier-plugin-solidity/node_modules/lru-cache": {
+      "version": "6.0.0",
+      "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+      "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+      "dev": true,
+      "dependencies": {
+        "yallist": "^4.0.0"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/prettier-plugin-solidity/node_modules/semver": {
+      "version": "7.3.8",
+      "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz",
+      "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==",
+      "dev": true,
+      "dependencies": {
+        "lru-cache": "^6.0.0"
+      },
+      "bin": {
+        "semver": "bin/semver.js"
+      },
+      "engines": {
+        "node": ">=10"
+      }
+    },
+    "node_modules/prettier-plugin-solidity/node_modules/yallist": {
+      "version": "4.0.0",
+      "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+      "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
+      "dev": true
+    },
    "node_modules/process-nextick-args": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
@ -6547,6 +6730,12 @@
        "asap": "~2.0.6"
      }
    },
+    "node_modules/pseudomap": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz",
+      "integrity": "sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==",
+      "dev": true
+    },
    "node_modules/psl": {
      "version": "1.9.0",
      "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz",
@ -7207,6 +7396,27 @@
        "node": "*"
      }
    },
+    "node_modules/shebang-command": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz",
+      "integrity": "sha512-EV3L1+UQWGor21OmnvojK36mhg+TyIKDh3iFBKBohr5xeXIhNBcx8oWdgkTEEQ+BEFFYdLRuqMfd5L84N1V5Vg==",
+      "dev": true,
+      "dependencies": {
+        "shebang-regex": "^1.0.0"
+      },
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
+    "node_modules/shebang-regex": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz",
+      "integrity": "sha512-wpoSFAxys6b2a2wHZ1XpDSgD7N9iVjg29Ph9uV/uaP9Ex/KXlkTZTeddxDPSYQpgvzKLGJke2UU0AzoGCjNIvQ==",
+      "dev": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
    "node_modules/shelljs": {
      "version": "0.8.5",
      "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz",
@ -7239,6 +7449,12 @@
        "url": "https://github.com/sponsors/ljharb"
      }
    },
+    "node_modules/signal-exit": {
+      "version": "3.0.7",
+      "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz",
+      "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==",
+      "dev": true
+    },
    "node_modules/slash": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
@ -7357,6 +7573,12 @@
        "semver": "bin/semver"
      }
    },
+    "node_modules/solidity-comments-extractor": {
+      "version": "0.0.7",
+      "resolved": "https://registry.npmjs.org/solidity-comments-extractor/-/solidity-comments-extractor-0.0.7.tgz",
+      "integrity": "sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==",
+      "dev": true
+    },
    "node_modules/solidity-coverage": {
      "version": "0.8.2",
      "resolved": "https://registry.npmjs.org/solidity-coverage/-/solidity-coverage-0.8.2.tgz",
@ -8107,6 +8329,15 @@
        "node": ">=8"
      }
    },
+    "node_modules/strip-eof": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz",
+      "integrity": "sha512-7FCwGGmx8mD5xQd3RPUvnSpUXHM3BWuzjtpD4TXsfcZ9EL4azvVVUscFYwD9nx8Kh+uCBC00XBtAykoMHwTh8Q==",
+      "dev": true,
+      "engines": {
+        "node": ">=0.10.0"
+      }
+    },
    "node_modules/strip-hex-prefix": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/strip-hex-prefix/-/strip-hex-prefix-1.0.0.tgz",
@ -8820,7 +9051,6 @@
      "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz",
      "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==",
      "dev": true,
-      "peer": true,
      "dependencies": {
        "isexe": "^2.0.0"
      },
@ -10319,7 +10549,6 @@
      "resolved": "https://registry.npmjs.org/@solidity-parser/parser/-/parser-0.14.5.tgz",
      "integrity": "sha512-6dKnHZn7fg/iQATVEzqyUOyEidbn05q7YA2mQ9hC0MMXhhV3/JrsxmFSYZAcr7j1yUP700LLhTruvJ3MiQmjJg==",
      "dev": true,
-      "peer": true,
      "requires": {
        "antlr4ts": "^0.5.0-alpha.4"
      }
@ -10666,8 +10895,7 @@
      "version": "0.5.0-alpha.4",
      "resolved": "https://registry.npmjs.org/antlr4ts/-/antlr4ts-0.5.0-alpha.4.tgz",
      "integrity": "sha512-WPQDt1B74OfPv/IMS2ekXAKkTZIHl88uMetg6q3OTqgFxZ/dxDXI0EWLyZid/1Pe6hTftyg5N7gel5wNAGxXyQ==",
-      "dev": true,
-      "peer": true
+      "dev": true
    },
    "anymatch": {
      "version": "3.1.3",
@ -11399,6 +11627,35 @@
      "dev": true,
      "peer": true
    },
+    "cross-spawn": {
+      "version": "5.1.0",
+      "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-5.1.0.tgz",
+      "integrity": "sha512-pTgQJ5KC0d2hcY8eyL1IzlBPYjTkyH72XRZPnLyKus2mBfNjQs3klqbJU2VILqZryAZUt9JOb3h/mWMy23/f5A==",
+      "dev": true,
+      "requires": {
+        "lru-cache": "^4.0.1",
+        "shebang-command": "^1.2.0",
+        "which": "^1.2.9"
+      },
+      "dependencies": {
+        "lru-cache": {
+          "version": "4.1.5",
+          "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-4.1.5.tgz",
+          "integrity": "sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==",
+          "dev": true,
+          "requires": {
+            "pseudomap": "^1.0.2",
+            "yallist": "^2.1.2"
+          }
+        },
+        "yallist": {
+          "version": "2.1.2",
+          "resolved": "https://registry.npmjs.org/yallist/-/yallist-2.1.2.tgz",
+          "integrity": "sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==",
+          "dev": true
+        }
+      }
+    },
    "crypt": {
      "version": "0.0.2",
      "resolved": "https://registry.npmjs.org/crypt/-/crypt-0.0.2.tgz",
@ -12364,6 +12621,21 @@
        "safe-buffer": "^5.1.1"
      }
    },
+    "execa": {
+      "version": "0.6.3",
+      "resolved": "https://registry.npmjs.org/execa/-/execa-0.6.3.tgz",
+      "integrity": "sha512-/teX3MDLFBdYUhRk8WCBYboIMUmqeizu0m9Z3YF3JWrbEh/SlZg00vLJSaAGWw3wrZ9tE0buNw79eaAPYhUuvg==",
+      "dev": true,
+      "requires": {
+        "cross-spawn": "^5.0.1",
+        "get-stream": "^3.0.0",
+        "is-stream": "^1.1.0",
+        "npm-run-path": "^2.0.0",
+        "p-finally": "^1.0.0",
+        "signal-exit": "^3.0.0",
+        "strip-eof": "^1.0.0"
+      }
+    },
    "extend": {
      "version": "3.0.2",
      "resolved": "https://registry.npmjs.org/extend/-/extend-3.0.2.tgz",
@ -12582,6 +12854,12 @@
      "dev": true,
      "peer": true
    },
+    "get-stream": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-3.0.0.tgz",
+      "integrity": "sha512-GlhdIUuVakc8SJ6kK0zAFbiGzRFzNnY4jUuEbV9UROo4Y+0Ny4fjvcZFVTeDA4odpFyOQzaw6hXukJSq/f28sQ==",
+      "dev": true
+    },
    "get-symbol-description": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/get-symbol-description/-/get-symbol-description-1.0.0.tgz",
@ -13181,6 +13459,12 @@
        "call-bind": "^1.0.2"
      }
    },
+    "is-stream": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-1.1.0.tgz",
+      "integrity": "sha512-uQPm8kcs47jx38atAcWTVxyltQYoPT68y9aWYdV6yWXSyW8mzSat0TL6CiWdZeCdF3KrAvpVtnHbTv4RN+rqdQ==",
+      "dev": true
+    },
    "is-string": {
      "version": "1.0.7",
      "resolved": "https://registry.npmjs.org/is-string/-/is-string-1.0.7.tgz",
@ -13235,8 +13519,7 @@
      "version": "2.0.0",
      "resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
      "integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw==",
-      "dev": true,
-      "peer": true
+      "dev": true
    },
    "isstream": {
      "version": "0.1.2",
@ -13848,6 +14131,15 @@
      "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==",
      "dev": true
    },
+    "npm-run-path": {
+      "version": "2.0.2",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-2.0.2.tgz",
+      "integrity": "sha512-lJxZYlT4DW/bRUtFh1MQIWqmLwQfAxnqWG4HhEdjMlkrJYnJn0Jrr2u3mgxqaWsdiBc76TYkTG/mhrnYTuzfHw==",
+      "dev": true,
+      "requires": {
+        "path-key": "^2.0.0"
+      }
+    },
    "number-to-bn": {
      "version": "1.7.0",
      "resolved": "https://registry.npmjs.org/number-to-bn/-/number-to-bn-1.7.0.tgz",
@ -13964,6 +14256,12 @@
      "integrity": "sha512-D2FR03Vir7FIu45XBY20mTb+/ZSWB00sjU9jdQXt83gDrI4Ztz5Fs7/yy74g2N5SVQY4xY1qDr4rNddwYRVX0g==",
      "dev": true
    },
+    "p-finally": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-1.0.0.tgz",
+      "integrity": "sha512-LICb2p9CB7FS+0eR1oqWnHhp0FljGLZCWBE9aix0Uye9W8LTQPwMTYVGWQWIw9RdQiDg4+epXQODwIYJtSJaow==",
+      "dev": true
+    },
    "p-limit": {
      "version": "1.3.0",
      "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-1.3.0.tgz",
@ -14016,6 +14314,12 @@
      "integrity": "sha512-AVbw3UJ2e9bq64vSaS9Am0fje1Pa8pbGqTTsmXfaIiMpnr5DlDhfJOuLj9Sf95ZPVDAUerDfEk88MPmPe7UCQg==",
      "dev": true
    },
+    "path-key": {
+      "version": "2.0.1",
+      "resolved": "https://registry.npmjs.org/path-key/-/path-key-2.0.1.tgz",
+      "integrity": "sha512-fEHGKCSmUSDPv4uoj8AlD+joPlq3peND+HRYyxFz4KPw4z926S/b8rIuFs2FYJg3BwsxJf6A9/3eIdLaYC+9Dw==",
+      "dev": true
+    },
    "path-parse": {
      "version": "1.0.7",
      "resolved": "https://registry.npmjs.org/path-parse/-/path-parse-1.0.7.tgz",
@ -14082,6 +14386,67 @@
      "integrity": "sha512-lqGoSJBQNJidqCHE80vqZJHWHRFoNYsSpP9AjFhlhi9ODCJA541svILes/+/1GM3VaL/abZi7cpFzOpdR9UPKg==",
      "dev": true
    },
+    "prettier-check": {
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/prettier-check/-/prettier-check-2.0.0.tgz",
+      "integrity": "sha512-HZG53XQTJ9Cyi5hi1VFVVFxdlhITJybpZAch3ib9KqI05VUxV+F5Hip0GhSWRItrlDzVyqjSoDQ9KqIn7AHYyw==",
+      "dev": true,
+      "requires": {
+        "execa": "^0.6.0"
+      }
+    },
+    "prettier-plugin-solidity": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/prettier-plugin-solidity/-/prettier-plugin-solidity-1.0.0.tgz",
+      "integrity": "sha512-gRJCeZ7imbWtNYN2SudjJoPmka5r6jcd2cSTV6FC3pVCtY6LFZbeQQjpKufUEp88hXBAAnkOTOh7TA5xwj9M3A==",
+      "dev": true,
+      "requires": {
+        "@solidity-parser/parser": "^0.14.5",
+        "emoji-regex": "^10.2.1",
+        "escape-string-regexp": "^4.0.0",
+        "semver": "^7.3.8",
+        "solidity-comments-extractor": "^0.0.7",
+        "string-width": "^4.2.3"
+      },
+      "dependencies": {
+        "emoji-regex": {
+          "version": "10.2.1",
+          "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-10.2.1.tgz",
+          "integrity": "sha512-97g6QgOk8zlDRdgq1WxwgTMgEWGVAQvB5Fdpgc1MkNy56la5SKP9GsMXKDOdqwn90/41a8yPwIGk1Y6WVbeMQA==",
+          "dev": true
+        },
+        "escape-string-regexp": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-4.0.0.tgz",
+          "integrity": "sha512-TtpcNJ3XAzx3Gq8sWRzJaVajRs0uVxA2YAkdb1jm2YkPz4G6egUFAyA3n5vtEIZefPk5Wa4UXbKuS5fKkJWdgA==",
+          "dev": true
+        },
+        "lru-cache": {
+          "version": "6.0.0",
+          "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz",
+          "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==",
+          "dev": true,
+          "requires": {
+            "yallist": "^4.0.0"
+          }
+        },
+        "semver": {
+          "version": "7.3.8",
+          "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz",
+          "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==",
+          "dev": true,
+          "requires": {
+            "lru-cache": "^6.0.0"
+          }
+        },
+        "yallist": {
+          "version": "4.0.0",
+          "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz",
+          "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==",
+          "dev": true
+        }
+      }
+    },
    "process-nextick-args": {
      "version": "2.0.1",
      "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz",
@ -14099,6 +14464,12 @@
        "asap": "~2.0.6"
      }
    },
+    "pseudomap": {
+      "version": "1.0.2",
+      "resolved": "https://registry.npmjs.org/pseudomap/-/pseudomap-1.0.2.tgz",
+      "integrity": "sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==",
+      "dev": true
+    },
    "psl": {
      "version": "1.9.0",
      "resolved": "https://registry.npmjs.org/psl/-/psl-1.9.0.tgz",
@ -14586,6 +14957,21 @@
        "crypt": ">= 0.0.1"
      }
    },
+    "shebang-command": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-1.2.0.tgz",
+      "integrity": "sha512-EV3L1+UQWGor21OmnvojK36mhg+TyIKDh3iFBKBohr5xeXIhNBcx8oWdgkTEEQ+BEFFYdLRuqMfd5L84N1V5Vg==",
+      "dev": true,
+      "requires": {
+        "shebang-regex": "^1.0.0"
+      }
+    },
+    "shebang-regex": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-1.0.0.tgz",
+      "integrity": "sha512-wpoSFAxys6b2a2wHZ1XpDSgD7N9iVjg29Ph9uV/uaP9Ex/KXlkTZTeddxDPSYQpgvzKLGJke2UU0AzoGCjNIvQ==",
+      "dev": true
+    },
    "shelljs": {
      "version": "0.8.5",
      "resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.5.tgz",
@ -14609,6 +14995,12 @@
        "object-inspect": "^1.9.0"
      }
    },
+    "signal-exit": {
+      "version": "3.0.7",
+      "resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-3.0.7.tgz",
+      "integrity": "sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==",
+      "dev": true
+    },
    "slash": {
      "version": "3.0.0",
      "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz",
@ -14704,6 +15096,12 @@
        }
      }
    },
+    "solidity-comments-extractor": {
+      "version": "0.0.7",
+      "resolved": "https://registry.npmjs.org/solidity-comments-extractor/-/solidity-comments-extractor-0.0.7.tgz",
+      "integrity": "sha512-wciNMLg/Irp8OKGrh3S2tfvZiZ0NEyILfcRCXCD4mp7SgK/i9gzLfhY2hY7VMCQJ3kH9UB9BzNdibIVMchzyYw==",
+      "dev": true
+    },
    "solidity-coverage": {
      "version": "0.8.2",
      "resolved": "https://registry.npmjs.org/solidity-coverage/-/solidity-coverage-0.8.2.tgz",
@ -15297,6 +15695,12 @@
        "ansi-regex": "^5.0.1"
      }
    },
+    "strip-eof": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/strip-eof/-/strip-eof-1.0.0.tgz",
+      "integrity": "sha512-7FCwGGmx8mD5xQd3RPUvnSpUXHM3BWuzjtpD4TXsfcZ9EL4azvVVUscFYwD9nx8Kh+uCBC00XBtAykoMHwTh8Q==",
+      "dev": true
+    },
    "strip-hex-prefix": {
      "version": "1.0.0",
      "resolved": "https://registry.npmjs.org/strip-hex-prefix/-/strip-hex-prefix-1.0.0.tgz",
@ -15853,7 +16257,6 @@
      "resolved": "https://registry.npmjs.org/which/-/which-1.3.1.tgz",
      "integrity": "sha512-HxJdYWq1MTIQbJ3nw0cqssHoTNU267KlrDuGZ1WYlxDStUtKUhOaJmh112/TZmHxxUfuJqPXSOm7tDyas0OSIQ==",
      "dev": true,
-      "peer": true,
      "requires": {
        "isexe": "^2.0.0"
      }
--- a/package.json
+++ b/package.json
@ -20,7 +20,9 @@
    "@nomicfoundation/hardhat-toolbox": "^2.0.0",
    "dotenv": "^16.0.3",
    "hardhat": "^2.12.4",
-    "prettier": "2.8.1"
+    "prettier": "2.8.1",
+    "prettier-check": "^2.0.0",
+    "prettier-plugin-solidity": "^1.0.0-beta.18"
  },
  "dependencies": {
    "@openzeppelin/contracts": "^4.8.0",