[v1.0 MAIN BRANCH] Main branch for Ethereum Deployed v1.0

.circleci/config.yml

@@ -7,7 +7,7 @@ orbs:
 defaults: &defaults
   working_directory: ~/repo
   docker:
-    - image: cimg/node:18.15.0
+    - image: cimg/node:18.18.0
     - image: mongo:7.0.0-rc5-jammy
 
 jobs:

.env.sample

@@ -12,27 +12,32 @@ SEPOLIA_RPC_URL=
 # ENV vars for MongoDB, for local development you can use below
 MONGO_DB_URI="mongodb://localhost:27018"
 MONGO_DB_NAME="zns-campaign"
+
 # Optional params for Mongo Client class specifically
 MONGO_DB_CLIENT_OPTS=
+
 # This is crucial based on the DB behaviour you want. MongoAdapter will create a new DB version if this is NOT passed
 # and it will use existing version if specified. If you want to deploy from scratch, do not supply and the previous
 # versioned data will be wiped out.
 # If you wish to save the previous data and write a new version on top, look at the next ENV var.
 MONGO_DB_VERSION=
+
 # This is crucial to saving the data written in previous DB (DEPLOYED) version.
 # If this is not passed or passed as "false", previous DB data will be wiped out.
 # If you want to save the previous contract data in DB, set this to "true"!
 ARCHIVE_PREVIOUS_DB_VERSION="true" | "false"
 
 # ENV vars for Logger
-LOG_LEVEL="debug" | "info" | "warn" | "error
+LOG_LEVEL="debug" | "info" | "warn" | "error"
+
 # Removes logger output and does not write to file as well
 SILENT_LOGGER="false" | "true"
 
 # Boolean value for if we deploy the mock
 # true = we deploy the mock
 # false = we use a hard coded address and pull data from chain
 MOCK_MEOW_TOKEN=
+
 # Address of the MEOW Token deployed to the network PRIOR to running Campaign or any other EXISTING token
 # This is only used if MOCK_MEOW_TOKEN is set to false (`test` and `prod` environments)
 STAKING_TOKEN_ADDRESS=
@@ -42,7 +47,6 @@ MAX_PRICE=
 MIN_PRICE=
 MAX_LENGTH=
 BASE_LENGTH=
-
 DECIMALS=
 PRECISION=
 PROTOCOL_FEE_PERC=
@@ -65,6 +69,7 @@ ADMIN_ADDRESSES=
 MONITOR_CONTRACTS="false"
 VERIFY_CONTRACTS="false"
 
+# For using OpenZeppelin Defender for deployment
 DEFENDER_KEY=
 DEFENDER_SECRET=
 RELAYER_KEY=
@@ -81,3 +86,8 @@ TENDERLY_ACCOUNT_ID="zer0-os"
 # Below are used only for the `deploy:devnet` script (for testing new logic) NOT RELATED TO THE DEPLOY CAMPAIGN !
 TENDERLY_DEVNET_TEMPLATE="zns-devnet"
 DEVNET_RPC_URL=
+
+# If executing the migration scripts, you must also specify
+# the below to specify a different database to write data too
+MONGO_DB_URI_WRITE=
+MONGO_DB_NAME_WRITE=

.eslintrc

@@ -9,9 +9,10 @@
         "no-console": "off",
         "no-shadow": "warn",
         "@typescript-eslint/no-shadow": "warn",
-        "no-invalid-this": "off"
+        "no-invalid-this": "off",
+        "jsdoc/newline-after-description": "off"
         // "@typescript-eslint/no-unused-vars": "off" // For debugging
       }
     }
   ]
-}
+}

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -1,10 +1,13 @@
 node_modules
-.env
+*.env*
 coverage
 coverage.json
 typechain
 typechain-types
 .idea
+.vscode
+dist
+*.log
 
 # Hardhat files
 cache
@@ -19,3 +22,5 @@ docker*.tgz
 
 # We don't ever use the generated manifests
 .openzeppelin
+
+output

.solcover.js

@@ -2,6 +2,7 @@ module.exports = {
   skipFiles: [
     'utils/StringUtils.sol',
     'token/mocks',
-    'upgrade-test-mocks'
+    'upgrade-test-mocks',
+    'zns-pausable'
   ]
 };

.solhint.json

@@ -3,7 +3,7 @@
   "rules": {
     "compiler-version": [
       "error",
-      "^0.8.18"
+      "0.8.18"
     ],
     "not-rely-on-time": "off",
     "no-inline-assembly": "off",
@@ -24,4 +24,4 @@
     "max-line-length": ["error", 120],
     "custom-errors": "off"
   }
-}
+}

contracts/zns-pausable/IZNSPausable.sol

@@ -0,0 +1,21 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.18;
+
+
+interface IZNSPausable {
+    /**
+     * @dev Emitted when the pause is triggered by `account`.
+     */
+    event Paused(address account);
+
+    /**
+     * @dev Emitted when the pause is lifted by `account`.
+     */
+    event Unpaused(address account);
+
+    function pause() external;
+
+    function unpause() external;
+
+    function paused() external view returns (bool);
+}

contracts/zns-pausable/price/IZNSCurvePricerPausable.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.18;
+
+import { IZNSCurvePricer } from "../../price/IZNSCurvePricer.sol";
+import { IZNSPausable } from "../IZNSPausable.sol";
+
+
+interface IZNSCurvePricerPausable is IZNSCurvePricer, IZNSPausable {}

contracts/zns-pausable/price/IZNSFixedPricerPausable.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.18;
+
+import { IZNSFixedPricer } from "../../price/IZNSFixedPricer.sol";
+import { IZNSPausable } from "../IZNSPausable.sol";
+
+
+interface IZNSFixedPricerPausable is IZNSFixedPricer, IZNSPausable {}