Merge pull request #71 from nation3/active-passport-github

Require valid passport when setting GitHub username
nation3 · Oct 22, 2023 · 4c936f4 · 4c936f4
2 parents 4d16d9b + 882820d
commit 4c936f4
Show file tree

Hide file tree

Showing 29 changed files with 366 additions and 3,247 deletions.
diff --git a/.eslintignore b/.eslintignore
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.github/workflows/linters.yml b/.github/workflows/linters.yml
@@ -23,6 +23,5 @@ jobs:
         cache-dependency-path: package-lock.json
     - run: npm install
 
-    - run: npx eslint '**/*.{js,ts}'
     - run: npx solhint 'contracts/**/*.sol'
     - run: npx prettier '**/*.{json,sol,md}' --check
diff --git a/.gitignore b/.gitignore
@@ -51,9 +51,6 @@ typings/
 # Optional npm cache directory
 .npm
 
-# Optional eslint cache
-.eslintcache
-
 # Microbundle cache
 .rpt2_cache/
 .rts2_cache_cjs/

diff --git a/.solhint.json b/.solhint.json
@@ -1,7 +1,7 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "compiler-version": ["error", "^0.8.17"],
+    "compiler-version": ["error", "^0.8.19"],
     "func-visibility": ["warn", { "ignoreConstructors": true }]
   }
 }
diff --git a/README.md b/README.md
@@ -19,10 +19,6 @@ npx hardhat compile
 
 Run unit tests:
 
-```
-export REPORT_GAS=true
-```
-
 ```
 npx hardhat test
 ```
@@ -43,13 +39,7 @@ Check if coverage threshold has been met:
 npx istanbul check-coverage --lines 90
 ```
 
-## Linters
-
-Run ESLint:
-
-```
-npx eslint '**/*.{js,ts}' --fix
-```
+## Linting
 
 Run Solhint:
 
@@ -111,18 +101,20 @@ npx hardhat run scripts/deploy-<contract>.ts --network mainnet
 ```
 
 ```
-npx hardhat verify --network mainnet <address>
+npx hardhat verify --network mainnet <address> <parameters>
 ```
 
 ## Deployments
 
 ### Goerli
 
-- GitHub.sol: `0x7a0e37e6e64d4fc59207c163e0176e22a4072503`
+- utils/PassportUtils.sol: `0xad42FC3fE04add6B4D177188E3B41677f03703a7`
+- GitHubUsernames.sol: `0x1bDa420e57059FB7C97B13DE7F7Dd719371E0291`
 - Discord.sol: `0x4BD52941D5C14035F49C93ab6EB3878DDa063119`
 
 ### Sepolia
 
+- utils/PassportUtils.sol: `0x90EC93e8B5948b1F7759692fB3082ACd3abDa3F8`
 - NationCred.sol: `0xff5F7A95D6dd29a0543f661a148ba1B9ac554763`
 
 ### Mainnet

diff --git a/contracts/Discord.sol b/contracts/Discord.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 contract Discord {
     mapping(address => string) public usernames;

diff --git a/contracts/Discourse.sol b/contracts/Discourse.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 contract Discourse {
     mapping(address => string) public usernames;

diff --git a/contracts/GitHub.sol b/contracts/GitHub.sol
diff --git a/contracts/GitHubUsernames.sol b/contracts/GitHubUsernames.sol
@@ -0,0 +1,27 @@
+//SPDX-License-Identifier: GPL-3.0-or-later
+pragma solidity ^0.8.19;
+
+import {IPassportUtils} from "./utils/IPassportUtils.sol";
+
+contract GitHubUsernames {
+    string public constant VERSION = "0.6.1";
+    mapping(address => string) public usernames;
+    IPassportUtils public passportUtils;
+
+    error PassportExpired(address citizen);
+
+    event UsernameUpdated(address citizen, string username);
+
+    constructor(address passportUtils_) {
+        passportUtils = IPassportUtils(passportUtils_);
+    }
+
+    function updateUsername(string calldata username) public {
+        if (passportUtils.isExpired(msg.sender)) {
+            revert PassportExpired(msg.sender);
+        } else {
+            usernames[msg.sender] = username;
+            emit UsernameUpdated(msg.sender, username);
+        }
+    }
+}
diff --git a/contracts/Greeter.sol b/contracts/Greeter.sol
diff --git a/contracts/INationCred.sol b/contracts/INationCred.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 interface INationCred {
     /**

diff --git a/contracts/NationCred.sol b/contracts/NationCred.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "./INationCred.sol";
 import "@openzeppelin/contracts/interfaces/IERC721.sol";
@@ -8,6 +8,7 @@ import "@openzeppelin/contracts/interfaces/IERC721.sol";
  * @notice Stores the passport IDs of active Nation3 citizens.
  */
 contract NationCred is INationCred {
+    string public constant VERSION = "0.6.1";
     address public owner;
     IERC721 public passport;
     uint16[] private passportIDs;

diff --git a/contracts/governance/IVotingEscrow.sol b/contracts/governance/IVotingEscrow.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 

diff --git a/contracts/mock/PassportIssuerMock.sol b/contracts/mock/PassportIssuerMock.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "../passport/IPassportIssuer.sol";
 

diff --git a/contracts/mock/PassportMock.sol b/contracts/mock/PassportMock.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "@openzeppelin/contracts/token/ERC721/ERC721.sol";
 import "@openzeppelin/contracts/access/Ownable.sol";

diff --git a/contracts/mock/VotingEscrowMock.sol b/contracts/mock/VotingEscrowMock.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "../governance/IVotingEscrow.sol";
 import "@openzeppelin/contracts/token/ERC20/ERC20.sol";

diff --git a/contracts/passport/IPassportIssuer.sol b/contracts/passport/IPassportIssuer.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 interface IPassportIssuer {
     function revokeUnderBalance() external view returns (uint256);

diff --git a/contracts/utils/IPassportUtils.sol b/contracts/utils/IPassportUtils.sol
@@ -1,5 +1,5 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 interface IPassportUtils {
     /**

diff --git a/contracts/utils/PassportUtils.sol b/contracts/utils/PassportUtils.sol
@@ -1,15 +1,13 @@
 //SPDX-License-Identifier: GPL-3.0-or-later
-pragma solidity ^0.8.17;
+pragma solidity ^0.8.19;
 
 import "./IPassportUtils.sol";
 import "../passport/IPassportIssuer.sol";
 import "../governance/IVotingEscrow.sol";
-import "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";
 import "hardhat/console.sol";
 
 contract PassportUtils is IPassportUtils {
-    using SafeERC20 for IERC20;
-
+    string public constant VERSION = "0.6.1";
     IPassportIssuer public passportIssuer;
     IVotingEscrow public votingEscrow;
 

diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -1,13 +1,6 @@
-import * as dotenv from "dotenv";
-
 import { HardhatUserConfig, task } from "hardhat/config";
-import "@nomiclabs/hardhat-etherscan";
-import "@nomiclabs/hardhat-waffle";
-import "@typechain/hardhat";
-import "hardhat-gas-reporter";
-import "solidity-coverage";
-
-dotenv.config();
+import "@nomicfoundation/hardhat-toolbox";
+require("dotenv").config();
 
 // This is a sample Hardhat task. To learn how to create your own go to
 // https://hardhat.org/guides/create-task.html
@@ -23,7 +16,7 @@ task("accounts", "Prints the list of accounts", async (taskArgs, hre) => {
 // Go to https://hardhat.org/config/ to learn more
 
 const config: HardhatUserConfig = {
-  solidity: "0.8.17",
+  solidity: "0.8.19",
   networks: {
     goerli: {
       url: process.env.GOERLI_URL || "",
@@ -42,7 +35,7 @@ const config: HardhatUserConfig = {
     },
   },
   gasReporter: {
-    enabled: process.env.REPORT_GAS !== undefined,
+    enabled: true,
     currency: "USD",
   },
   etherscan: {