Implement the POL flow

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+insert_final_newline = true
+end_of_line = lf
+indent_style = tab
+indent_size = 4
+max_line_length = 80
+
+[*.yaml]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

.env.example

@@ -0,0 +1,15 @@
+RPC_PROVIDER=ankr
+SEPOLIA_API_KEY=1234567890ABCDEF1234567890abcdef
+AMOY_API_KEY=1234567890ABCDEF1234567890abcdef
+ETHEREUM_API_KEY=1234567890ABCDEF1234567890abcdef
+POLYGON_API_KEY=1234567890ABCDEF1234567890abcdef
+ETHERSCAN_API_KEY=1234567890ABCDEF1234567890abcdef12
+POLYGONSCAN_API_KEY=1234567890ABCDEF1234567890abcdef12
+FORKING_BLOCK_NUMBER=20700204
+COINMARKETCAP_API_KEY=
+GAS_REPORTER_NETWORK=ethereum
+GAS_PRICE_GWEI=0
+REPORT_GAS=false
+DEPLOYER_MNEMONIC="test test test test test test test test test test test junk"
+DEPLOYER_PASSPHRASE=
+DEPLOYER_ADDRESS=0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266

.env.test.example

@@ -1,9 +1,9 @@
-DEPLOYER_PRIVATE_KEY=
-ETHERSCAN_API_KEY=
-ROOT_CHAIN_RPC=
-ROOT_GAS_PRICE=
-CHILD_CHAIN_RPC=
-CHILD_GAS_PRICE=
+DEPLOYER_PRIVATE_KEY=1234567890ABCDEF1234567890abcde1234567890ABCDEF1234567890abcdeff
+ETHERSCAN_API_KEY=1234567890ABCDEF1234567890abcdef12
+ROOT_CHAIN_RPC=https://rpc.ankr.com/eth
+ROOT_GAS_PRICE=0
+CHILD_CHAIN_RPC=https://rpc.ankr.com/polygon
+CHILD_GAS_PRICE=0
 STAKE_MANAGER=
 MATIC_TOKEN=
 MANAGER=
@@ -12,5 +12,7 @@ TREASURY=
 FX_ROOT=
 FX_CHILD=
 CHECKPOINT_MANAGER=
-DEFENDER_TEAM_API_KEY=
-DEFENDER_TEAM_API_SECRET_KEY=
+DEFENDER_TEAM_API_KEY=1234567890ABCDEF1234567890abcdef
+DEFENDER_TEAM_API_SECRET_KEY=1234567890ABCDEF1234567890abcde1234567890ABCDEF1234567890abcdeff
+FORKING_ROOT_BLOCK_NUMBER=20700204
+REPORT_GAS=false

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.github/workflows/ci.yaml

@@ -0,0 +1,77 @@
+name: CI
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - "**"
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: ["20.15.x"]
+        python-version: ["3.12"]
+        solidity-version: ["0.8.7"]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup node ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: npm
+
+      - name: Setup python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          check-latest: true
+          cache: pip
+
+      - name: Install node dependencies
+        run: npm ci
+
+      - name: Install python dependencies
+        run: |
+          pip install -U pip setuptools
+          pip install -q -r requirements.txt
+
+      - name: Configure solidity compiler
+        run: |
+          solc-select install ${{ matrix.solidity-version }}
+          solc-select use ${{ matrix.solidity-version }}
+
+      - name: Clean artifacts
+        run: npm run clean
+
+      - name: Compile contracts
+        run: npm run compile
+
+      - name: Lint code
+        run: npm run lint
+
+      - name: Check contracts with linter
+        run: npm run check
+
+      - name: Analyze contracts with static analyzer
+        run: npm run analyze:ci
+
+      - name: Run unit tests
+        run: npm run test:ci
+
+      - name: Deploy contracts into hardhat network
+        run: make hardhat
+
+      - name: Save contract artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: contracts
+          path: |
+            artifacts/contracts/
+            !artifacts/contracts/**/*.dbg.json
+            !artifacts/contracts/interfaces/
+            !artifacts/contracts/libraries/
+            !artifacts/contracts/mocks/
+            !artifacts/contracts/state-transfer/
+          retention-days: 30

.github/workflows/wiki.yaml

@@ -0,0 +1,31 @@
+name: Wiki
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+      - pol-flow
+jobs:
+  wiki:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          path: maticX
+
+      - name: Checkout wiki repository
+        uses: actions/checkout@v4
+        with:
+          repository: stader-labs/maticX.wiki
+          path: maticX.wiki
+
+      - name: Mirror docs to wiki
+        run: |
+          cd $GITHUB_WORKSPACE/maticX.wiki
+          git config user.name Actions
+          git config user.email [email protected]
+          cp $GITHUB_WORKSPACE/maticX/docs/*.md $GITHUB_WORKSPACE/maticX.wiki
+          git add .
+          git diff-index --quiet HEAD -- || git commit -m "Mirror docs to wiki"
+          git push

.gitignore

@@ -1,16 +1,16 @@
-node_modules
+.idea/
+.vscode/
+artifacts/
+cache/
+coverage/
+crytic-corpus/
+crytic-export/
+node_modules/
+typechain-types/
+.DS_Store
 .env
 .env.test
-
-#Hardhat files
-cache
-artifacts
-typechain
-
-.openzeppelin
-
-.idea
-
-#test coverage logs
+.solcx-lock-*
 coverage.json
-coverage/
+mochaOutput.json
+testMatrix.json

.husky/pre-commit

@@ -0,0 +1 @@
+npm run format && npm run lint && npm run check && npm test