migrate project files

.env.example

@@ -0,0 +1,4 @@
+INFURA_TOKEN="909b972ab2ff3afb8b0f8f6a9667test"
+BOR_CHAIN_URL="http://localhost:9545"
+ENV="local"
+MNEMONIC_DEV="poly radar mass judge dismiss just intact mind resemble fringe diary casino"

.gitignore

@@ -1,13 +1,17 @@
 node_modules
-build
+artifacts
+out
 contractAddresses.json
+.vscode
+
 
 # ignore generated files
-contracts/root/predicates/TransferWithSigUtils.sol
-contracts/common/mixin/ChainIdMixin.sol
-test-blockchain/genesis.json
-test-blockchain/start.sh
+src/root/predicates/TransferWithSigUtils.sol
+src/common/mixin/ChainIdMixin.sol
 test/helpers/marketplaceUtils.js
+cache_hardhat
+forge-cache
+
 
 test-blockchain/geth
 test-blockchain/history

.nvmrc

@@ -1 +1 @@
-11.1.0
+20.6.0

.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+        description: Forces to replace line ending by the UNIX 'lf' character.
+        exclude: "^docs/autogen"
+  - repo: local
+    hooks:
+      - id: format
+        name: Format solidity code
+        description: Format solidity code with `forge fmt`
+        language: system
+        entry: forge fmt
+        exclude: "^lib/"
+        pass_filenames: true
+      - id: doc
+        name: Generate documentation
+        description: Generate docs with `forge doc`
+        language: system
+        # generates docs and unstages files if only the commit hash changed within the file, this way only when the documentation is updated, the documentation needs to be regenerated and only the changed files are pushed
+        entry: "script/util/doc_gen.sh"
+        pass_filenames: false
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.0.3"
+    hooks:
+      - id: prettier
+        name: Format non solidity files with prettier
+        exclude: "^docs/autogen"

.prettierrc

@@ -10,6 +10,16 @@
         "bracketSpacing": false,
         "explicitTypes": "always"
       }
+    },
+    {
+      "files": "*.js",
+      "options": {
+        "semi": false,
+        "singleQuote": true,
+        "tabWidth": 2,
+        "printWidth": 120,
+        "trailingComma": "none"
+      }
     }
   ]
 }

.solcover.js

@@ -3,12 +3,5 @@ module.exports = {
         grep: "@skip-on-coverage", // Find everything with this tag
         invert: true               // Run the grep's inverse set.
     },
-    providerOptions: {
-        // port: 8545,
-        mnemonic: "clock radar mass judge dismiss just intact mind resemble fringe diary casino",
-        gasLimit: 9007199254740991,
-        gasPrice: 0,
-        allowUnlimitedContractSize: true
-    },
-    compileCommand: 'npm run truffle:compile'
-};
+    compileCommand: 'npx hardhat compile'
+}

CONTRIBUTING.md

@@ -0,0 +1,177 @@
+# Contributing
+
+- [Install](#install)
+- [Pre-commit Hooks](#pre-commit-hooks)
+- [Branching](#branching)
+  - [Main](#main)
+  - [Staging](#staging)
+  - [Dev](#dev)
+  - [Feature](#feature)
+  - [Fix](#fix)
+- [Code Practices](#code-practices)
+  - [Code Style](#code-style)
+  - [Interfaces](#interfaces)
+  - [NatSpec \& Comments](#natspec--comments)
+- [Versioning](#versioning)
+- [Testing](#testing)
+  - [Deployer Template](#deployer-template)
+- [Deployment](#deployment)
+  - [Deployer Template](#deployer-template-1)
+  - [Deployment](#deployment-1)
+  - [Deployment Info Generation](#deployment-info-generation)
+- [Deployer Template Script](#deployer-template-script)
+- [Releases](#releases)
+
+## Install
+
+Follow these steps to set up your local environment for development:
+
+- [Install foundry](https://book.getfoundry.sh/getting-started/installation)
+- Install dependencies: `forge install`
+- [Install pre-commit](https://pre-commit.com/#installation)
+- Install pre commit hooks: `pre-commit install`
+
+## Pre-commit Hooks
+
+Follow the [installation steps](#install) to enable pre-commit hooks. To ensure consistency in our formatting `pre-commit` is used to check whether code was formatted properly and the documentation is up to date. Whenever a commit does not meet the checks implemented by pre-commit, the commit will fail and the pre-commit checks will modify the files to make the commits pass. Include these changes in your commit for the next commit attempt to succeed. On pull requests the CI checks whether all pre-commit hooks were run correctly.
+This repo includes the following pre-commit hooks that are defined in the `.pre-commit-config.yaml`:
+
+- `mixed-line-ending`: This hook ensures that all files have the same line endings (LF).
+- `format`: This hook uses `forge fmt` to format all Solidity files.
+- `doc`: This hook uses `forge doc` to automatically generate documentation for all Solidity files whenever the NatSpec documentation changes. The `script/util/doc_gen.sh` script is used to generate documentation. Forge updates the commit hash in the documentation automatically. To only generate new documentation when the documentation has actually changed, the script checks whether more than just the hash has changed in the documentation and discard all changes if only the hash has changed.
+- `prettier`: All remaining files are formatted using prettier.
+
+## Branching
+
+This section outlines the branching strategy of this repo.
+
+### Main
+
+The main branch is supposed to reflect the deployed state on all networks. Any pull requests into this branch MUST come from the staging branch. The main branch is protected and requires a separate code review by the security team. Whenever the main branch is updated, a new release is created with the latest version. For more information on versioning, check [here](#versioning).
+
+### Staging
+
+The staging branch reflects new code complete deployments or upgrades containing fixes and/or features. Any pull requests into this branch MUST come from the dev branch. The staging branch is used for security audits and deployments. Once the deployment is complete and deployment log files are generated, the branch can be merged into main. For more information on the deployment and log file generation check [here](#deployment--versioning).
+
+### Dev
+
+This is the active development branch. All pull requests into this branch MUST come from fix or feature branches. Upon code completion this branch is merged into staging for auditing and deployment.
+
+### Feature
+
+Any new feature should be developed on a separate branch. The naming convention for these branches is `feat/*`. Once the feature is complete, a pull request into the dev branch can be created.
+
+### Fix
+
+Any bug fixes should be developed on a separate branch. The naming convention for these branches is `fix/*`. Once the fix is complete, a pull request into the dev branch can be created.
+
+## Code Practices
+
+### Code Style
+
+The repo follows the official [Solidity Style Guide](https://docs.soliditylang.org/en/latest/style-guide.html). In addition to that, this repo also borrows the following rules from [OpenZeppelin](https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/GUIDELINES.md#solidity-conventions):
+
+- Internal or private state variables or functions should have an underscore prefix.
+
+  ```solidity
+  contract TestContract {
+      uint256 private _privateVar;
+      uint256 internal _internalVar;
+      function _testInternal() internal { ... }
+      function _testPrivate() private { ... }
+  }
+  ```
+
+- Events should generally be emitted immediately after the state change that they
+  represent, and should be named in the past tense. Some exceptions may be made for gas
+  efficiency if the result doesn't affect observable ordering of events.
+
+  ```solidity
+  function _burn(address who, uint256 value) internal {
+      super._burn(who, value);
+      emit TokensBurned(who, value);
+  }
+  ```
+
+- Interface names should have a capital I prefix.
+
+  ```solidity
+  interface IERC777 {
+  ```
+
+- Contracts not intended to be used standalone should be marked abstract
+  so they are required to be inherited to other contracts.
+
+  ```solidity
+  abstract contract AccessControl is ..., {
+  ```
+
+- Unchecked arithmetic blocks should contain comments explaining why overflow is guaranteed not to happen. If the reason is immediately apparent from the line above the unchecked block, the comment may be omitted.
+
+### Interfaces
+
+Every contract MUST implement their corresponding interface that includes all externally callable functions, errors and events.
+
+### NatSpec & Comments
+
+Interfaces should be the entrypoint for all contracts. When exploring the a contract within the repository, the interface MUST contain all relevant information to understand the functionality of the contract in the form of NatSpec comments. This includes all externally callable functions, errors and events. The NatSpec documentation MUST be added to the functions, errors and events within the interface. This allows a reader to understand the functionality of a function before moving on to the implementation. The implementing functions MUST point to the NatSpec documentation in the interface using `@inheritdoc`. Internal and private functions shouldn't have NatSpec documentation except for `@dev` comments, whenever more context is needed. Additional comments within a function should only be used to give more context to more complex operations, otherwise the code should be kept readable and self-explanatory.
+
+## Versioning
+
+This repo utilizes [semantic versioning](https://semver.org/) for smart contracts. An `IVersioned` interface is included in the [interfaces directory](src/interface/IVersioned.sol) exposing a unified versioning interface for all contracts. This version MUST be included in all contracts, whether they are upgradeable or not, to be able to easily match deployed versions. For example, in the case of a non-upgradeable contract one version could be deployed to a network and later a new version might be deployed to another network. The exposed `version()` function is also used by the [Deployment Log Generator](https://github.com/0xPolygon/deployment-log-generator#readme) to extract information about the version.
+
+Whenever contracts are modified, only the version of the changed contracts should be updated. Unmodified contracts should remain on the version of their last change.
+
+## Testing
+
+### Deployer Template
+
+This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/contract-deployer-template#readme).
+
+## Deployment
+
+This repo utilizes versioned deployments. Any changes to a contract should update the version of this specific contract. A script is provided that extracts deployment information from the `run-latest.json` file within the `broadcast` directory generated while the forge script runs. From this information a JSON and markdown file is generated containing various information about the deployment itself as well as past deployments.
+
+### Deployer Template
+
+This repo provides a deployer template library for consistency between scripts and unit tests. For more information on how to use the template, check [here](https://github.com/0xPolygon/contract-deployer-template#readme).
+
+### Deployment
+
+This repo set up the following RPCs in the `foundry.toml` file:
+
+- mainnet: Ethereum Mainnet
+- goerli: Ethereum Goerli
+- sepolia: Ethereum Sepolia
+- polygon_pos: Polygon PoS
+- mumbai: Polygon Mumbai
+- polygon_zkevm: Polygon zkEVM
+- polygon_zkevm_testnet: Polygon zkEVM Testnet
+
+To deploy the contracts, provide the `--broadcast` flag to the forge script command. Should the etherscan verification time out, it can be picked up again by replacing the `--broadcast` flag with `--resume`.
+Deploy the contracts to one of the predefined networks by providing the according key with the `--rpc-url` flag. Most of the predefined networks require the `INFURA_KEY` environment variable to be set in the `.env` file.
+Including the `--verify` flag will verify deployed contracts on Etherscan. Define the appropriate environment variable for the Etherscan api key in the `.env` file.
+
+```shell
+forge script script/Deploy.s.sol --broadcast --rpc-url <rpc_url> --verify
+```
+
+## Releases
+
+Releases should be created whenever the code on the main branch is updated to reflect a deployment or an upgrade on a network. The release should be named after the version of the contracts deployed or upgraded.
+The release should include the following:
+
+- In case of a MAJOR version
+  - changelog
+  - summary of breaking changes
+  - summary of new features
+  - summary of fixes
+- In case of a MINOR version
+  - changelog
+  - summary of new features
+  - summary of fixes
+- In case of a PATCH version
+  - changelog
+  - summary of fixes
+- Deployment information (can be copied from the generated log files)
+  - Addresses of the deployed contracts

README.md

@@ -12,48 +12,54 @@ npm install
 
 ### Compile
 
-bor-chain-id for Mainnet = 137
-bor-chain-id for TestnetV4 (Mumbai) = 80001
 
 ```
-npm run template:process -- --bor-chain-id <bor-chain-id>
-npm run truffle:compile
+npm run template:process -- --bor-chain-id 15001
 ```
 
-### Start main chain and side chain
+bor-chain-id should be:  
+**local: 15001**  
+Mainnet = 137  
+TestnetV4 (Mumbai) = 80001
+### Main chain and side chain
 
-- Start Main chain
+- Main chain
 
-```
-npm run testrpc
-```
+All tests are run against a fork of mainnet using Hardhat's forking functionality. No need to run any local chain!
 
 - Start Matic side chain. Requires docker.
 
 ```
 npm run bor:simulate
 ```
 
-- If you ran a bor instance before, a dead docker container might still be lying around, clean it with
+- Stop with
 
 ```
-npm run bor:clean
+npm run bor:stop
 ```
 
-- Run a bor (our matic chain node) instance.
+- If you want a clean chain, this also deletes your /data folder containing the chain state.
 
-### Deploy Contracts
+```
+npm run bor:clean
+```
 
-- For local development
+### Run tests
 
+Run Hardhat test
 ```
-npm run truffle:migrate
+npm test:hardhat
 ```
 
-- For a properly initialized set of contracts, follow the instructions [here](./deploy-migrations/README.md).
+Run Foundry test
+```
+npm test:foundry
+```
 
-### Run tests
+### Coverage
 
+Run coverage with
 ```
-npm test
+npm run coverage
 ```

SECURITY.md

@@ -0,0 +1,22 @@
+# Polygon Technology Security Information
+
+## Link to vulnerability disclosure details (Bug Bounty).
+
+- Websites and Applications: https://hackerone.com/polygon-technology
+- Smart Contracts: https://immunefi.com/bounty/polygon
+
+## Languages that our team speaks and understands.
+
+Preferred-Languages: en
+
+## Security-related job openings at Polygon.
+
+https://polygon.technology/careers
+
+## Polygon security contact details.
+
+[email protected]
+
+## The URL for accessing the security.txt file.
+
+Canonical: https://polygon.technology/security.txt

contracts/common/mixin/ChainIdMixin.sol

@@ -0,0 +1,6 @@
+pragma solidity ^0.5.2;
+
+contract ChainIdMixin {
+  bytes constant public networkId = hex"3A99";
+  uint256 constant public CHAINID = 15001;
+}