New ERC20 token

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4

.env.example

@@ -0,0 +1,12 @@
+PRIVATE_KEY=<USE THIS OR MNEMONIC>
+HDWALLET_MNEMONIC=<USE THIS OR PRIVATE KEY>
+INFURA_API_KEY=
+MULTISIG_ADDRESS=
+SALT=
+ETHERSCAN_API_KEY=
+AVALANCHE_API_KEY=
+OPTIMISM_API_KEY=
+POLYGONSCAN_API_KEY=
+ARBISCAN_API_KEY=
+BSCSCAN_API_KEY=
+GNOSIS_API_KEY=

.gitignore

@@ -1,4 +1,25 @@
-node_modules
 build
 .etherlime-store
-coverage
+
+node_modules
+.env
+.envrc
+.npmrc
+coverage
+coverage.json
+typechain
+typechain-types
+deployments/localhost/
+yarn-error.log
+
+#Hardhat files
+cache
+artifacts
+
+abi/
+package-lock.json
+yarn.lock
+
+.DS_Store
+.vscode
+hardhat-dependency-compiler

.nvmrc

@@ -0,0 +1 @@
+18

.prettierignore

@@ -0,0 +1,22 @@
+# directories
+.yarn/
+**/.coverage_artifacts
+**/.coverage_cache
+**/.coverage_contracts
+**/artifacts
+**/build
+**/cache
+**/coverage
+**/dist
+**/node_modules
+**/types
+**/typechain-types
+
+# files
+*.env
+*.log
+.pnp.*
+coverage.json
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc.yml

@@ -0,0 +1,13 @@
+bracketSpacing: true
+printWidth: 120
+proseWrap: "always"
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+
+overrides:
+  - files: "*.sol"
+    options:
+      compiler: "0.8.17"
+      tabWidth: 4
+  - files: "*.ts"

.solhint.json

@@ -0,0 +1,19 @@
+{
+    "extends": "solhint:recommended",
+    "plugins": ["prettier"],
+    "rules": {
+      "code-complexity": ["error", 8],
+      "compiler-version": ["error", ">=0.8.4"],
+      "func-visibility": ["error", { "ignoreConstructors": true }],
+      "max-line-length": ["error", 120],
+      "not-rely-on-time": "off",
+      "prettier/prettier": [
+        "error",
+        {
+          "endOfLine": "auto"
+        }
+      ],
+      "reason-string": ["warn", { "maxLength": 64 }]
+    }
+  }
+

.solhintignore

@@ -0,0 +1,3 @@
+# directories
+**/artifacts
+**/node_modules

README.md

@@ -1,28 +1,49 @@
-<h2 align="center">AllianceBlock Smart Contracts</h2>
+# AllianceBlock Smart Contracts
 
+## NXRA token contract
+An upgradable ERC20 contract owned by a multi-signature wallet. Also, it allows creating snapshots, pausing it, support (EIP-2612)[https://eips.ethereum.org/EIPS/eip-2612] and batch minting.
 
-### ALBT token contract
-A standard ERC20 contract owned by a multisignature wallet
+## Env variables
+You will need to generate a .env file using .env.example as a boilerplate. PrivateKey or Mnemonic is necessary for live deployment but can be skipped for local development. SALT is needed for deterministic deployment, if none is provided it will use the default form constants.
 
-### Vesting Smart Contract
-Vesting smart contract able to handle vesting schedules for 24 months. Recipients withdraw amounts are presented as percentages, and vesting periods are presented with acumulative amounts of ALBT tokens.
-
-### Percentage Calculator
-Library used for more precise calculation of percentages
+## Usage
+Need node 18 installed and yarn.
+First, install the dependencies
+```bash
+yarn install
+```
 
-### Batch Transfer Smart Contract
-Contract handling  batch transfers of ALBT tokens.
+Then compile the contracts to get types from typechain
+```bash
+yarn compile
+```
 
+To run tests use
+```bash
+yarn test
+```
+It will also show gas used
 
-## Usage
+To check converage run
 ```bash
-npm install 
-npm install -g etherlime
+yarn coverage
+```
 
-# Compile
-etherlime compile
+## Deploy
+To deploy use
+```bash
+yarn deploy <NetworkName>
+```
+Where NetworkName is one of the networks configured in (hardhat.networks.ts)[./hardhat.networks.ts]
+Deployment is deterministic, this means that it can be precalculated and that it will have the same address across all chains.
+**Important to keep the same address, SALT and BYTECODE must be the same, bytecode includes not just the compiled contracts, but the parameters used in the constructor as well**
 
-# Deploy 
-etherlime deploy --network=<predefined-network> --secret=<your-private-key>
+## Verification
+The deployment script also verifies the smart contracts using `hardhat-etherscan`, but it needs the API KEY from the explorers, you will need to add them in the .env file.
 
+If the network where you are deploying uses Blockscout, use Sourcify instead.
+```bash
+yarn hardhat --network <NetworkName> sourcify
 ```
+
+