Enable partial transpilation for upgradeable package

.github/actions/setup/action.yml

@@ -15,5 +15,3 @@ runs:
       run: npm ci
       shell: bash
       if: steps.cache.outputs.cache-hit != 'true'
-      env:
-        SKIP_COMPILE: true

.github/workflows/checks.yml

@@ -56,8 +56,16 @@ jobs:
           fetch-depth: 0 # Include history so patch conflicts are resolved automatically
       - name: Set up environment
         uses: ./.github/actions/setup
+      - name: Pack vanilla package
+        id: vanilla
+        run: |
+          tarball="$(npm pack --pack-destination .. | tee /dev/stderr | tail -1)"
+          echo "tarball=$tarball" >> "$GITHUB_OUTPUT"
+        working-directory: contracts
       - name: Transpile to upgradeable
         run: bash scripts/upgradeable/transpile.sh
+      - name: Install vanilla as dependency
+        run: npm install --no-save "${{ steps.vanilla.outputs.tarball }}"
       - name: Run tests
         run: npm run test
       - name: Check linearisation of the inheritance graph

contracts/package.json

@@ -8,7 +8,7 @@
     "!/mocks/**/*"
   ],
   "scripts": {
-    "prepare": "bash ../scripts/prepare-contracts-package.sh",
+    "prepack": "bash ../scripts/prepack.sh",
     "prepare-docs": "cd ..; npm run prepare-docs"
   },
   "repository": {

package.json

@@ -2,6 +2,7 @@
   "name": "openzeppelin-solidity",
   "description": "Secure Smart Contract library for Solidity",
   "version": "4.9.2",
+  "private": true,
   "files": [
     "/contracts/**/*.sol",
     "/build/contracts/*.json",
@@ -20,7 +21,6 @@
     "lint:sol": "prettier --log-level warn --ignore-path .gitignore '{contracts,test}/**/*.sol' --check && solhint '{contracts,test}/**/*.sol'",
     "lint:sol:fix": "prettier --log-level warn --ignore-path .gitignore '{contracts,test}/**/*.sol' --write",
     "clean": "hardhat clean && rimraf build contracts/build",
-    "prepare": "scripts/prepare.sh",
     "prepack": "scripts/prepack.sh",
     "generate": "scripts/generate/run.js",
     "release": "scripts/release/release.sh",

scripts/prepack.sh

@@ -4,9 +4,24 @@ set -euo pipefail
 shopt -s globstar
 
 # cross platform `mkdir -p`
-node -e 'fs.mkdirSync("build/contracts", { recursive: true })'
+mkdirp() {
+  node -e "fs.mkdirSync('$1', { recursive: true })"
+}
 
+# cd to the root of the repo
+cd "$(git rev-parse --show-toplevel)"
+
+npm run clean
+
+env COMPILE_MODE=production npm run compile
+
+mkdirp build/contracts
 cp artifacts/contracts/**/*.json build/contracts
 rm build/contracts/*.dbg.json
 
 node scripts/remove-ignored-artifacts.js
+
+cp README.md contracts/
+
+mkdirp contracts/build/contracts
+cp -r build/contracts/*.json contracts/build/contracts

scripts/upgradeable/transpile.sh

@@ -24,6 +24,7 @@ fi
 # -p: emit public initializer
 # -n: use namespaces
 # -N: exclude from namespaces transformation
+# -q: partial transpilation using @openzeppelin/contracts as peer project
 npx @openzeppelin/upgrade-safe-transpiler@latest -D \
   -b "$build_info" \
   -i contracts/proxy/utils/Initializable.sol \
@@ -36,7 +37,8 @@ npx @openzeppelin/upgrade-safe-transpiler@latest -D \
   -x '!contracts/proxy/beacon/IBeacon.sol' \
   -p 'contracts/**/presets/**/*' \
   -n \
-  -N 'contracts/mocks/**/*'
+  -N 'contracts/mocks/**/*' \
+  -q '@openzeppelin/'
 
 # delete compilation artifacts of vanilla code
 npm run clean