Merge pull request #9 from axieinfinity/release/v0.1.0

chore: merge from branch 'release/v0.1.0'

.debug.env.example

@@ -0,0 +1,10 @@
+# Fork block number to debug
+BLOCK=0x0
+# Caller
+FROM=0x0000000000000000000000000000000000000000
+# Callee
+TO=0x0000000000000000000000000000000000000000
+# Sent Value
+VALUE=0x27cdb0997a65b2de99
+# Call Data
+CALLDATA=0x0

.github/template/create-pull-request.md

@@ -0,0 +1,2 @@
+### Description
+PR to merge from [{{ .fromBranch }}](/axieinfinity/foundry-deployment-kit/tree/{{ .fromBranch }}) to [{{ .toBranch }}](/axieinfinity/foundry-deployment-kit/tree/{{ .toBranch }}).

.github/workflows/create-PR-implement.yml

@@ -0,0 +1,50 @@
+name: Create Pull Request From Implement To Feature
+on:
+  push:
+    branches:
+      - 'implement-feature/**'
+      - 'implement-feature/**/**'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  HEAD_BRANCH: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  createPullRequest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set env
+        run: |
+          echo "FEATURE_NAME=$(echo ${HEAD_BRANCH} | cut -d'/' -f2)" >> $GITHUB_ENV
+          echo "FEATURE_BRANCH=feature/$(echo ${HEAD_BRANCH} | cut -d'/' -f2)" >> $GITHUB_ENV
+          echo "IMPLEMENT_NAME=$(echo ${HEAD_BRANCH} | cut -d'/' -f3)" >> $GITHUB_ENV
+
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{env.FEATURE_BRANCH}}
+
+      - name: Reset promotion branch
+        run: |
+          git fetch origin ${HEAD_BRANCH}:${HEAD_BRANCH}
+          git reset --hard ${HEAD_BRANCH}
+
+      - name: Render template
+        id: template
+        uses: chuhlomin/[email protected]
+        with:
+          template: .github/template/create-pull-request.md
+          vars: |
+            fromBranch: ${{env.HEAD_BRANCH}}
+            toBranch: ${{ env.FEATURE_BRANCH }}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          branch: ${{ env.HEAD_BRANCH }}
+          base: ${{env.FEATURE_BRANCH}}
+          labels: automated PR
+          title: 'feat(${{env.FEATURE_NAME}}): implement `${{env.IMPLEMENT_NAME}}`'
+          body: ${{ steps.template.outputs.result }}

.github/workflows/create-PR-release.yml

@@ -0,0 +1,84 @@
+name: Create Pull Request From Release to Feature
+on:
+  push:
+    branches:
+      - 'release/*'
+      - 'release*/*'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  HEAD_BRANCH: ${{ github.head_ref || github.ref_name }}
+
+jobs:
+  fetchAllFeatureBranches:
+    runs-on: ubuntu-latest
+
+    steps:
+    - id: step1
+      name: Checkout code
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - id: step2
+      name: List all the remote feature branches
+      run: |
+        branches=$(git branch -r | grep -E '.*origin\/feature\/.*' | sed -e "s/.*origin\///" | tr "\n" " ")
+        JSON="["
+        for branch in ${branches[@]}; do
+            echo $branch
+            JSONline="\"$branch\","
+            # we don't need to iterate on the same branch over and over, so
+            # onnly include it when it wasn't included
+            if [[ "$JSON" != *"$JSONline"* ]]; then
+                JSON="$JSON$JSONline"
+            fi
+        done
+        # Remove last "," and add the closing bracket
+        if [[ $JSON == *, ]]; then
+            JSON="${JSON%?}"
+        fi
+        JSON="$JSON]"
+        echo $JSON
+        echo "BRANCHES={\"branch_name\": $( echo "$JSON" )}" >> "$GITHUB_OUTPUT"
+    outputs:
+      BRANCHES: ${{ steps.step2.outputs.BRANCHES }}
+
+  mergeRelease2FeatureRepo:
+    runs-on: ubuntu-latest
+    needs: fetchAllFeatureBranches
+    strategy:
+      matrix: ${{ fromJSON(needs.fetchAllFeatureBranches.outputs.BRANCHES) }}
+    steps:
+      - name: Set env
+        run: |
+          echo "PR_BRANCH=merge/${HEAD_BRANCH}-${{matrix.branch_name}}" >> $GITHUB_ENV
+          echo "FEATURE_NAME=$(echo ${{matrix.branch_name}} | cut -d'/' -f2)" >> $GITHUB_ENV
+      - uses: actions/checkout@v3
+        with:
+          ref: ${{matrix.branch_name}}
+      - name: Reset promotion branch
+        run: |
+          git fetch origin ${HEAD_BRANCH}:${HEAD_BRANCH}
+          git reset --hard ${HEAD_BRANCH}
+
+      - name: Render template
+        id: template
+        uses: chuhlomin/[email protected]
+        with:
+          template: .github/template/create-pull-request.md
+          vars: |
+            fromBranch: ${{env.HEAD_BRANCH}}
+            toBranch: ${{matrix.branch_name}}
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v5
+        with:
+          labels: automated PR
+          delete-branch: true
+          title: 'chore(`${{env.FEATURE_NAME}}`): merge from `${{env.HEAD_BRANCH}}`'
+          body: ${{ steps.template.outputs.result }}
+          branch: ${{env.PR_BRANCH}}

.github/workflows/test.yml

@@ -0,0 +1,46 @@
+name: test
+
+on:
+  push:
+    branches:
+      - mainnet
+      - testnet
+      - 'feature/*'
+      - 'features/*'
+  pull_request:
+    branches:
+      - mainnet
+      - testnet
+      - 'feature/*'
+      - 'features/*'
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Foundry project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build --sizes
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -13,7 +13,7 @@ out/
 docs/
 
 # Dotenv file
-.env
+*.env
 .vscode
 
 node_modules/

.gitmodules

@@ -3,7 +3,10 @@
 	url = https://github.com/foundry-rs/forge-std
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
-	url = https://github.com/openzeppelin/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
 [submodule "lib/solady"]
 	path = lib/solady
 	url = https://github.com/Vectorized/solady
+[submodule "lib/contract-libs"]
+	path = lib/contract-libs
+	url = https://github.com/axieinfinity/contract-libs

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/generate-layout.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+rm -rf logs/storage/*
+dirOutputs=$(ls out | grep '^[^.]*\.sol$') # assuming the out dir is at 'out'
+while IFS= read -r contractDir; do
+  innerdirOutputs=$(ls out/$contractDir)
+
+  while IFS= read -r jsonFile; do
+    fileIn=out/$contractDir/$jsonFile
+    fileOut=logs/storage/$contractDir:${jsonFile%.json}.log
+    node .husky/storage-logger.js $fileIn $fileOut &
+  done <<< "$innerdirOutputs"
+done <<< "$dirOutputs"
+
+# Wait for all background jobs to finish
+wait

.husky/pre-push

@@ -0,0 +1,26 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+set -ex
+
+# Workaround: git stash no changes doesn't cause failure but git stash pop cause
+output=$(git stash)
+stashed=true
+if [[ $output == *"No local changes to save"* ]]; then
+  stashed=false
+fi
+
+forge build --sizes 2>&1 | sed -n '/Contract/,$p' > logs/contract-code-sizes.log
+.husky/generate-layout.sh
+
+git add logs
+
+output=$(git status -s)
+line_count=$(echo "$output" | wc -l)
+if [ "$line_count" -gt 1 ]; then
+  git commit -m "chore: storage layout"
+fi
+
+if $stashed; then
+  git stash pop 
+fi

.husky/storage-logger.js

@@ -0,0 +1,46 @@
+const fs = require('fs');
+const fileIn = process.argv[2];
+const fileOut = process.argv[3];
+
+if (!fileIn) {
+    console.error('Invalid input');
+}
+
+fs.readFile(fileIn, 'utf8', (err, data) => {
+    if (err) {
+        console.error('Error reading file:', err);
+        return;
+    }
+
+    try {
+        const jsonData = JSON.parse(data);
+        if (typeof jsonData.storageLayout == 'undefined') {
+            return;
+        }
+
+        if (jsonData.storageLayout.storage.length == 0) {
+            return;
+        }
+
+        const outputData = jsonData.storageLayout.storage
+            .map(({ contract, label, offset, slot, type: typeId }) => {
+                const typeObj = jsonData.storageLayout.types[typeId];
+                const typeLabel = typeObj.label;
+                const numberOfBytes = typeObj.numberOfBytes;
+                return `${contract}:${label} (storage_slot: ${slot}) (offset: ${offset}) (type: ${typeLabel}) (numberOfBytes: ${numberOfBytes})`;
+            })
+            .join('\n');
+        if (!fileOut) {
+            console.log(outputData);
+        } else {
+            fs.writeFile(fileOut, outputData, 'utf-8', err => {
+                if (err) {
+                    console.error('Error writing file:', err);
+                    return;
+                }
+            });
+        }
+    } catch (err) {
+        console.error('Error parsing JSON:', err);
+    }
+});

README.md

@@ -1 +1,35 @@
 # foundry-deployment-kit
+
+The collections of smart contracts that support writing deployment scripts.
+
+## Development
+
+### Requirement
+
+- [Foundry forge@^0.2.0](https://book.getfoundry.sh/)
+
+### Build & Test
+
+- Install packages
+
+```shell
+$ forge install
+```
+
+- Build contracts
+
+```shell
+$ forge build
+```
+
+- Run test
+
+```shell
+$ forge test
+```
+
+### Deploy
+
+```shell
+$ forge script <path/to/file.s.sol> -f --private-key <your_private_key>
+```

debug.sh

@@ -0,0 +1,39 @@
+# Source (or "dot") the .env file to load environment variables
+if [ -f .env ]; then
+    source .debug.env
+else
+    echo "Error: .debug.env file not found."
+fi
+
+verify_arg=""
+extra_argument=""
+op_command=""
+
+for arg in "$@"; do
+    case $arg in
+    --trezor)
+        op_command=""
+        extra_argument+=trezor@
+        ;;
+    --broadcast)
+        op_command="op run --env-file="./.env" --"
+        ;;
+    --log)
+        set -- "${@/#--log/}"
+        extra_argument+=log@
+        ;;
+    *) ;;
+    esac
+done
+
+# Remove the @ character from the end of extra_argument
+extra_argument="${extra_argument%%@}"
+
+echo Debug Tx...
+echo From: ${FROM}
+echo To: ${TO}
+echo Value: ${VALUE}
+echo Calldata:
+cast pretty-calldata ${CALLDATA}
+calldata=$(cast calldata 'trace(uint256,address,address,uint256,bytes)' ${BLOCK} ${FROM} ${TO} ${VALUE} ${CALLDATA})
+${op_command} forge script ${verify_arg} --legacy ${@} script/OnchainDebugger.s.sol --sig 'run(bytes,string)' ${calldata} "${extra_argument}"

deployments/ronin-mainnet/.chainId

@@ -0,0 +1 @@
+2020

deployments/ronin-testnet/.chainId

@@ -0,0 +1 @@
+2021