NET-61 ci gamma diff report

.github/workflows/Bytecode_diff_report.yml

@@ -0,0 +1,173 @@
+name: Bytecode Diff Report
+env:
+    FOUNDRY_VERSION: nightly
+    TESTNET_PRIVATE_KEY: ${{ secrets.GAMMA_BASE_SEPOLIA_DEPLOYER_PK }}
+    BASE_RPC_URL: ${{ secrets.BASE_RPC_URL }}
+    BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
+    FACET_SOURCE_PATH: ../../contracts/src
+    REPORT_OUT_DIR: ${{ vars.REPORT_OUT_DIR }}
+    BASESCAN_API_KEY: ${{ secrets.BASESCAN_API_KEY }}
+    BASESCAN_SEPOLIA_URL: 'https://api-sepolia.basescan.org/api'
+    BLOCKSCOUT_SEPOLIA_URL: 'https://base-sepolia.blockscout.com/api'
+    BLOCKSCOUT_SEPOLIA_API_KEY: ${{ secrets.BLOCKSCOUT_BASE_SEPOLIA_API_KEY }}
+    AWS_ACCESS_KEY_ID: ${{ secrets.RIVER_S3_AWS_ACCESS_KEY_ID }}
+    AWS_SECRET_ACCESS_KEY: ${{ secrets.RIVER_S3_AWS_SECRET_ACCESS_KEY }}
+    AWS_REGION: ${{ secrets.RIVER_S3_AWS_REGION }}
+    GOWORK: off
+
+on:
+    workflow_dispatch:
+        inputs:
+            origin_environment:
+                description: 'Origin environment'
+                required: true
+                type: choice
+                options:
+                    - 'alpha'
+                    - 'gamma'
+                    - 'omega'
+                default: 'alpha'
+            target_environment:
+                description: 'Target environment'
+                required: true
+                type: choice
+                options:
+                    - 'alpha'
+                    - 'gamma'
+                    - 'omega'
+                default: 'gamma'
+
+    workflow_call:
+        inputs:
+            origin_environment:
+                description: 'Origin environment'
+                required: true
+                type: string
+            target_environment:
+                description: 'Target environment'
+                required: true
+                type: string
+        secrets:
+            BASE_RPC_URL:
+                required: true
+            BASE_SEPOLIA_RPC_URL:
+                required: true
+            BASESCAN_API_KEY:
+                required: true
+            BLOCKSCOUT_BASE_SEPOLIA_API_KEY:
+                required: true
+            GAMMA_BASE_SEPOLIA_DEPLOYER_PK:
+                required: true
+            RIVER_S3_AWS_ACCESS_KEY_ID:
+                required: true
+            RIVER_S3_AWS_SECRET_ACCESS_KEY:
+                required: true
+            RIVER_S3_AWS_REGION:
+                required: true
+
+jobs:
+    Render_Network_Diff_Upgrade_Report:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.ref }}
+
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: '20'
+                  cache: 'yarn'
+
+            - name: Install Foundry
+              uses: foundry-rs/foundry-toolchain@v1
+              with:
+                  version: ${{ env.FOUNDRY_VERSION }}
+
+            - name: Install node dependencies
+              run: yarn install --immutable
+
+            - name: Set up Go
+              uses: actions/setup-go@v4
+              with:
+                  go-version: '1.22' # Specify the Go version you need
+
+            - name: Install dependencies
+              run: |
+                  go mod download
+                  go mod tidy
+              working-directory: scripts/bytecode-diff
+
+            - name: Run report generation
+              run: |
+                  go run main.go -v ${{ inputs.origin_environment }} ${{ inputs.target_environment }}
+              working-directory: scripts/bytecode-diff
+              env:
+                  REPORT_OUT_DIR: ${{ env.REPORT_OUT_DIR }}
+                  BASESCAN_API_KEY: ${{ env.BASESCAN_API_KEY }}
+                  BASE_RPC_URL: ${{ env.BASE_RPC_URL }}
+                  BASE_SEPOLIA_RPC_URL: ${{ env.BASE_SEPOLIA_RPC_URL }}
+                  FACET_SOURCE_PATH: ${{ env.FACET_SOURCE_PATH }}
+                  GOWORK: ${{ env.GOWORK }}
+
+            - name: Get latest facet diff file
+              run: |
+                  FACET_DIFF_FILE=$(find ${{ env.REPORT_OUT_DIR }} -name "facet_diff*.yaml" | sort -r | head -n 1 | xargs basename)
+                  echo "Latest facet diff file: $FACET_DIFF_FILE"
+                  echo "FACET_DIFF_FILE=$FACET_DIFF_FILE" >> $GITHUB_ENV
+              working-directory: scripts/bytecode-diff
+
+            - name: Run facet upgrades based on diffs
+              run: |
+                  ./scripts/upgrade-facets.sh ${{ inputs.target_environment }} ${{ env.REPORT_OUT_DIR }} ${{ env.FACET_DIFF_FILE }}
+              working-directory: scripts/bytecode-diff
+              env:
+                  BASE_RPC_URL: ${{ env.BASE_RPC_URL }}
+                  BASE_SEPOLIA_RPC_URL: ${{ env.BASE_SEPOLIA_RPC_URL }}
+                  BLOCKSCOUT_SEPOLIA_URL: ${{ env.BLOCKSCOUT_SEPOLIA_URL }}
+                  BLOCKSCOUT_SEPOLIA_API_KEY: ${{ env.BLOCKSCOUT_SEPOLIA_API_KEY }}
+                  BASESCAN_API_KEY: ${{ env.BASESCAN_API_KEY }}
+                  BASESCAN_SEPOLIA_URL: ${{ env.BASESCAN_SEPOLIA_URL }}
+                  TESTNET_PRIVATE_KEY: ${{ env.TESTNET_PRIVATE_KEY }}
+
+            - name: Run final html report generation w/ updated hashes
+              id: gen_html_report
+
+              run: |
+                  go run main.go add-hashes ${{ inputs.target_environment }} ${{ env.REPORT_OUT_DIR }}/${{ env.FACET_DIFF_FILE }}
+              working-directory: scripts/bytecode-diff
+              env:
+                  BASE_RPC_URL: ${{ env.BASE_RPC_URL }}
+                  BASE_SEPOLIA_RPC_URL: ${{ env.BASE_SEPOLIA_RPC_URL }}
+                  GOWORK: ${{ env.GOWORK }}
+
+            - name: Configure AWS credentials
+              if: steps.gen_html_report.outcome == 'success'
+              uses: aws-actions/configure-aws-credentials@v1
+              with:
+                  aws-access-key-id: ${{ env.AWS_ACCESS_KEY_ID }}
+                  aws-secret-access-key: ${{ env.AWS_SECRET_ACCESS_KEY }}
+                  aws-region: ${{ env.AWS_REGION }}
+
+            - name: Copy HTML report to S3
+              if: steps.gen_html_report.outcome == 'success'
+              run: |
+                  # Find the latest hashed HTML file
+                  HTML_FILE=$(find ${{ env.REPORT_OUT_DIR }} -name "*_hashed_*.html" | sort -r | head -n 1)
+
+                  if [ -z "$HTML_FILE" ]; then
+                    echo "Error: No HTML file found"
+                    exit 1
+                  fi
+
+                  echo "Latest HTML file: $HTML_FILE"
+
+                  # Copy to report.html
+                  aws s3 cp $HTML_FILE s3://${{ inputs.target_environment }}-reports/report.html
+
+                  # Copy to report_YYYYMMDD.html
+                  DATED_FILENAME="report_$(date -u +%Y%m%d).html"
+                  aws s3 cp $HTML_FILE s3://${{ inputs.target_environment }}-reports/$DATED_FILENAME
+
+                  echo "HTML report copied to S3 bucket ${{ inputs.target_environment }}-reports files report.html and $DATED_FILENAME"

.github/workflows/Network_diff_upgrade.yml

@@ -4,21 +4,18 @@ on:
     workflow_dispatch:
 
 jobs:
-    Run_Bytecode_Diff_Upgrade:
-        runs-on: ubuntu-latest
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v4
-              with:
-                  ref: main
-
-            - name: Gamma Network Diff Report
-              uses: ./.github/workflows/Bytecode_diff_report.yml
-              with:
-                  origin_environment: alpha
-                  target_environment: gamma
-
-            - name: Upgrade Gamma Facets
-              uses: ./.github/workflows/Upgrade_network_facets.yml
-              with:
-                  environment_name: gamma
+    Run_Alpha_to_Gamma:
+        name: Run Alpha to Gamma Diff Upgrade
+        uses: ./.github/workflows/Bytecode_diff_report.yml
+        with:
+            origin_environment: alpha
+            target_environment: gamma
+        secrets:
+            BASE_RPC_URL: ${{ secrets.BASE_RPC_URL }}
+            BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
+            BASESCAN_API_KEY: ${{ secrets.BASESCAN_API_KEY }}
+            BLOCKSCOUT_BASE_SEPOLIA_API_KEY: ${{ secrets.BLOCKSCOUT_BASE_SEPOLIA_API_KEY }}
+            GAMMA_BASE_SEPOLIA_DEPLOYER_PK: ${{ secrets.GAMMA_BASE_SEPOLIA_DEPLOYER_PK }}
+            RIVER_S3_AWS_ACCESS_KEY_ID: ${{ secrets.RIVER_S3_AWS_ACCESS_KEY_ID }}
+            RIVER_S3_AWS_SECRET_ACCESS_KEY: ${{ secrets.RIVER_S3_AWS_SECRET_ACCESS_KEY }}
+            RIVER_S3_AWS_REGION: ${{ secrets.RIVER_S3_AWS_REGION }}

.github/workflows/Render_diff_upgrade_report.yml

@@ -0,0 +1,91 @@
+name: Render Diff Upgrade Report
+env:
+    BASE_RPC_URL: ${{ secrets.BASE_RPC_URL }}
+    BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
+    REPORT_OUT_DIR: ${{ vars.REPORT_OUT_DIR }}
+    AWS_ACCESS_KEY_ID: ${{ secrets.RIVER_S3_AWS_ACCESS_KEY_ID }}
+    AWS_SECRET_ACCESS_KEY: ${{ secrets.RIVER_S3_AWS_SECRET_ACCESS_KEY }}
+    AWS_REGION: ${{ secrets.RIVER_S3_AWS_REGION }}
+    GOWORK: off
+
+on:
+    workflow_dispatch:
+        inputs:
+            environment_name:
+                description: 'Environment name'
+                required: true
+                type: choice
+                options:
+                    - 'alpha'
+                    - 'gamma'
+                    - 'omega'
+
+    workflow_call:
+        inputs:
+            environment_name:
+                description: 'Environment name'
+                required: true
+                type: string
+
+jobs:
+    Render_Diff_Upgrade_Report:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+              with:
+                  ref: ${{ github.ref }}
+
+            - name: Set up Go
+              uses: actions/setup-go@v4
+              with:
+                  go-version: '1.22' # Specify the Go version you need
+
+            - name: Install dependencies
+              run: |
+                  go mod download
+                  go mod tidy
+              working-directory: scripts/bytecode-diff
+
+            - name: Get latest facet diff file
+              run: |
+                  FACET_DIFF_FILE=$(find ${{ env.REPORT_OUT_DIR }} -name "facet_diff*.yaml" | sort -r | head -n 1)
+                  echo "Latest facet diff file: $FACET_DIFF_FILE"
+                  echo "FACET_DIFF_FILE=$FACET_DIFF_FILE" >> $GITHUB_ENV
+
+            - name: Run final html report generation w/ updated hashes
+              id: gen_html_report
+              run: |
+                  go run main.go add-hashes ${{ inputs.environment_name }} ${{ env.FACET_DIFF_FILE }}
+              working-directory: scripts/bytecode-diff
+
+            - name: Configure AWS credentials
+              if: steps.gen_html_report.outcome == 'success'
+              uses: aws-actions/configure-aws-credentials@v1
+              with:
+                  aws-access-key-id: ${{ env.AWS_ACCESS_KEY_ID }}
+                  aws-secret-access-key: ${{ env.AWS_SECRET_ACCESS_KEY }}
+                  aws-region: ${{ env.AWS_REGION }}
+
+            - name: Copy HTML report to S3
+              if: steps.gen_html_report.outcome == 'success'
+              run: |
+                  # Find the latest hashed HTML file
+                  HTML_FILE=$(find ${{ env.REPORT_OUT_DIR }} -name "*_hashed_*.html" | sort -r | head -n 1)
+
+                  if [ -z "$HTML_FILE" ]; then
+                    echo "Error: No hashed HTML file found"
+                    exit 1
+                  fi
+
+                  echo "Latest hashed HTML file: $HTML_FILE"
+
+                  # Copy to report.html
+                  aws s3 cp $HTML_FILE s3://${{ inputs.environment_name }}-reports/report.html
+
+                  # Copy to report_YYYYMMDD.html
+                  DATED_FILENAME="report_$(date -u +%Y%m%d).html"
+                  aws s3 cp $HTML_FILE s3://${{ inputs.environment_name }}-reports/$DATED_FILENAME
+
+                  echo "HTML report copied to S3 bucket ${{ inputs.environment_name }}-reports files report.html and $DATED_FILENAME"

.prettierignore

@@ -47,4 +47,5 @@ yarn.lock
 
 packages/generated/*
 
+scripts/bytecode-diff/templates/*
 packages/proto/src/protocol_*.ts

scripts/bytecode-diff/README.md

@@ -83,6 +83,28 @@ diamonds:
 
 ```
 
+### Run keccak256 hash generation on deployed contracts
+
+```bash
+GOWORK=off go run main.go add-hashes gamma deployed-diffs/facet_diff_090624_1.yaml
+
+# output to new yaml file suffixed with _hashed.yaml including bytecodeHash for each contract in deployments section
+➜  bytecode-diff git:(jt/net-62-upgrade-script-2) ✗ yq e '.deployments' deployed-diffs/facet_diff_090624_1_hashed.yaml
+Architect:
+  address: 0xa18a3df4f63cdcae943d9c76730adf2812388de4
+  baseScanLink: https://sepolia.basescan.org/tx/0x4280ef1300fe001e7d85e7495eba13fc99be53ee7a7060e753d466f8bebf1622
+  bytecodeHash: 0x20d0a86e9ea31a39663285aacfe88705983520a4482a7bac5ada891c9adfe090
+  deploymentDate: 2024-09-06 19:04
+  transactionHash: 0x4280ef1300fe001e7d85e7495eba13fc99be53ee7a7060e753d466f8bebf1622
+Banning:
+  address: 0x4d88d1fbba6ce6bcdb4381549ee0b7c0d2b56919
+  baseScanLink: https://sepolia.basescan.org/tx/0x4ccbaf9750bcd0971975e73a24b05f1c51d4703cf72a406356c79eb54de9c33c
+  bytecodeHash: 0xa2ce3e77ba060ff1d59ed384e1c6c5788f308ad8bbbef612eb3e5de4e1d79de8
+  deploymentDate: 2024-09-06 19:05
+  transactionHash: 0x4ccbaf9750bcd0971975e73a24b05f1c51d4703cf72a406356c79eb54de9c33c
+...
+```
+
 ### Flags
 
 ```bash