BREAKING_CHANGE: refactor repo

.env.example

@@ -1,14 +1,15 @@
-# Devnet configs
-DEVNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
-DEVNET_URL=http://localhost:8545
+# Shadow configs
+RONIN_MAINNET_SHADOW_PK=0x0000000000000000000000000000000000000000000000000000000000000000
+RONIN_MAINNET_SHADOW_URL=http://
+
+RONIN_TESTNET_SHADOW_PK=0x0000000000000000000000000000000000000000000000000000000000000000
+RONIN_TESTNET_SHADOW_URL=http://
 
 # Testnet configs
-TESTNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
-TESTNET_URL=https://testnet.skymavis.one/rpc
+RONIN_TESTNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
 
 # Mainnet configs
-MAINNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
-MAINNET_URL=https://api.roninchain.com/rpc
+RONIN_MAINNET_PK=0x0000000000000000000000000000000000000000000000000000000000000000
 
-# Report gas
-REPORT_GAS=false
+# Infura configs
+INFURA_API_KEY=

.git-blame-ignore-revs

@@ -0,0 +1,6 @@
+# style(automated): post-commit forge fmt (*.sol)
+a88906eaf3e08acc1f5517ddcbfaa26af7b8559b
+# style(automated): post-commit forge fmt (*.sol)
+04cca08e8242d2eff83fd895c4b56b456a52b37c
+# style(automated): post-commit forge fmt (*.sol)
+138b0b7fb7ebf761275fe9917243c89201f226c4

.github/scripts/comment.js

@@ -0,0 +1,24 @@
+module.exports = async ({ github, context, header, body }) => {
+	const comment = [header, body].join("\n");
+
+	const { data: comments } = await github.rest.issues.listComments({
+		owner: context.repo.owner,
+		repo: context.repo.repo,
+		issue_number: context.payload.number,
+	});
+
+	const botComment = comments.find(
+		(comment) =>
+			// github-actions bot user
+			comment.user.id === 41898282 && comment.body.startsWith(header)
+	);
+
+	const commentFn = botComment ? "updateComment" : "createComment";
+
+	await github.rest.issues[commentFn]({
+		owner: context.repo.owner,
+		repo: context.repo.repo,
+		body: comment,
+		...(botComment ? { comment_id: botComment.id } : { issue_number: context.payload.number }),
+	});
+};

.github/workflows/compare-storage-layout.yml

@@ -0,0 +1,117 @@
+name: Check Storage Layout Changes
+
+on:
+  pull_request:
+    branches:
+      - mainnet
+      - testnet
+      - "release/*"
+      - "feature/*"
+      - "features/*"
+      - "implement-feature/*"
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check-storage-layout:
+    strategy:
+      fail-fast: true
+
+    name: Check storage layout changes
+    runs-on: [self-hosted, dockerize]
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: "Setup Node"
+        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 #v3.4.1
+        with:
+          node-version: v16.16.0
+
+      - name: Install package with soldeer
+        run: |
+          forge soldeer install
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build
+        id: build
+
+      - name: Install Dependencies
+        id: install-deps
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y wget
+          sudo apt-get install bc
+          sudo wget https://github.com/mikefarah/yq/releases/download/v4.44.3/yq_linux_amd64 -O /usr/bin/yq
+          sudo chmod +x /usr/bin/yq
+
+      - name: Run Storage Layout Check
+        id: storage-layout-check
+        run: |
+          git fetch --unshallow || git fetch --all
+
+          dependencies/storage-delta-0.3.2/run.sh \
+            --omit new \
+            --dst-commit ${{ github.event.pull_request.base.sha }} \
+            --src-commit ${{ github.event.pull_request.head.sha }} \
+            --github-root ${{ github.server_url }}/${{ github.repository }}/blob/
+
+      - name: Check for storage_delta folder
+        id: check-folder
+        run: |
+          if [ -d "storage_delta" ]; then
+              # Query all the subdirectories in the storage_delta folder to check any `.diff` files
+              # Echo the contents of the `.diff` files to the output with wrapped ```diff {content} ```
+              find storage_delta -type f -name "*.diff"
+              for file in $(find storage_delta -type f -name "*.diff"); do
+                  clean_path=$(echo "$file" | sed -e 's|storage_delta/diffs/||' -e 's|https:/|https://|' -e 's|\.diff$||')
+                  echo "## Layout Changes for [$(basename "${clean_path%.*}")]($clean_path)" >>storage_delta_report.md
+                  echo '```diff' >>storage_delta_report.md    
+                  # Remove \ No newline at end of file from the diff file
+                  grep -v '\\ No newline at end of file' $file >>storage_delta_report.md
+                  echo '```' >>storage_delta_report.md
+              done
+              # Check if .removed files exist, if yes, add header `Removed Storage Layouts` and append the contents of the file to storage_delta_report.md
+              if [ -f "storage_delta/.removed" ]; then
+                  echo "## Removed Components" >>storage_delta_report.md
+                  cat storage_delta/.removed >>storage_delta_report.md
+              fi
+
+              # Check if the storage_delta_report.md file exists
+              if [ -f "storage_delta_report.md" ]; then
+                  # Output the contents of the storage_delta_report.md file to the output
+                  cat storage_delta_report.md 
+                  echo "storage_delta_exists=true" >>$GITHUB_OUTPUT
+              else
+                  echo "No storage layout changes detected."
+              fi
+          fi
+        env:
+          GITHUB_OUTPUT: ${{ steps.check-folder.outputs.storage_delta_exists }}
+        shell: bash
+
+      - name: Set storage delta report output
+        if: ${{ steps.check-folder.outputs.storage_delta_exists == 'true' }}
+        id: set-report
+        run: |
+          REPORT=$(cat storage_delta_report.md)
+          echo "REPORT<<EOF" >> $GITHUB_ENV
+          echo "$REPORT" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - name: Create/update checklist as PR comment
+        uses: actions/github-script@v7
+        if: github.event_name == 'pull_request' && steps.check-folder.outputs.storage_delta_exists == 'true'
+        with:
+          script: |
+            const script = require('.github/scripts/comment');
+            const header = '# Storage Layout Change Report';
+            const body = process.env.REPORT;
+            await script({ github, context, header, body });

.github/workflows/slither-analyze.yml

@@ -0,0 +1,59 @@
+name: Slither Analyze
+
+on:
+  pull_request:
+    branches:
+      - mainnet
+      - testnet
+      - "feature/*"
+      - "features/*"
+      - "feat/*"
+      - "feats/*"
+      - "release/*"
+      - "implement-feature/*"
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check-slither:
+    strategy:
+      fail-fast: true
+
+    name: Slither Analyze
+    runs-on: [self-hosted, dockerize]
+
+    env:
+      ETHERSCAN_API_KEY: ${{ secrets.ETHERSCAN_API_KEY }}
+      INFURA_API_KEY: ${{ secrets.INFURA_API_KEY }}
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Install package with soldeer
+        run: forge soldeer install
+
+      - name: Run Slither
+        uses: crytic/[email protected]
+        id: slither
+        with:
+          node-version: 18
+          fail-on: none
+          slither-args: --exclude-optimization --exclude-low --exclude-medium --exclude-informational --exclude-dependencies --filter-paths "dependencies/|script/|test/foundry/" --checklist --markdown-root ${{ github.server_url }}/${{ github.repository }}/blob/${{ github.sha }}/
+
+      - name: Create/update checklist as PR comment
+        uses: actions/github-script@v7
+        if: github.event_name == 'pull_request'
+        env:
+          REPORT: ${{ steps.slither.outputs.stdout }}
+        with:
+          script: |
+            const script = require('.github/scripts/comment')
+            const header = '# Slither report'
+            const body = process.env.REPORT
+            await script({ github, context, header, body })

.github/workflows/test.yml

@@ -15,35 +15,52 @@ on:
       - "release/*"
       - "feature/*"
       - "features/*"
+      - "implement-feature/*"
 
 env:
   FOUNDRY_PROFILE: ci
 
 jobs:
-  check:
+  check-unit-test:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Unit test
     runs-on: [self-hosted, dockerize]
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
 
+      - name: Set up Go 1.19
+        uses: actions/setup-go@v4
+        with:
+          go-version: "1.19"
+
+      - name: Setup external packages
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y jq
+          sudo apt-get install -y gcc
+          sudo apt-get install -y wget
+          sudo wget https://github.com/mikefarah/yq/releases/download/v4.34.1/yq_linux_amd64 -O /usr/local/bin/yq
+          sudo chmod +x /usr/local/bin/yq
+
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly-2b1f8d6dd90f9790faf0528e05e60e573a7569ce
 
       - name: Install package with soldeer
         run: forge soldeer install
 
-      - name: Recursively update dependencies
+      - name: Build random beacon binary
         run: |
-          chmod +x ./update-deps.sh
-          ./update-deps.sh
-        id: update-deps
+          rm -rf temp && mkdir temp && cd temp
+          git clone https://github.com/ronin-chain/ronin-random-beacon.git 
+          cd ronin-random-beacon && ls 
+          go build -o ronin-random-beacon && ls
+          cp ./ronin-random-beacon ../../bin/ 
+          cd ../../ 
+          rm -rf temp
 
       - name: Run Forge build
         run: |

.gitignore

@@ -27,4 +27,8 @@ deployments/**/exported_address
 config/config.json
 config/config.yaml
 dependencies
-deployments/ronin-mainnet-shadow
+deployments/*-shadow
+bin/ronin-random-beacon
+broadcast/**/6063/*
+broadcast/**/31337/*
+script/**/command