feat(scripts): adds an easy way to start/stop protocol locally

.github/workflows/_tests.yml

@@ -54,6 +54,11 @@ jobs:
       BUILDKIT_PROGRESS: plain
     steps:
       - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+      - name: Prepare repo
+        run: yarn && yarn build
       - name: Run Integration Tests
         run: scripts/integration-tests.sh
       - name: Archive production artifacts

.gitignore

@@ -38,3 +38,6 @@ yarn-error.log
 .netlify
 .vercel
 governance/.openzeppelin/unknown-31337.json
+
+# log files
+nohup.out

docker/development/eth-node/.dockerignore

@@ -1,3 +1,5 @@
 node_modules
+**/node_modules
 cache
-.yarn
+.yarn/cache
+.yarn/install-state.gz

docker/development/eth-node/.gitignore

@@ -1,3 +1,17 @@
+# local deps
+packages
+networks.json
+
+# contracts
 cache
-.yarn
-networks.json
+
+# yarn
+.yarn/*
+.yarn/install-state.gz
+.pnp.js
+# !.yarn/cache
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

docker/development/eth-node/.yarnrc.yml

@@ -0,0 +1,2 @@
+yarnPath: .yarn/releases/yarn-4.1.1.cjs
+nodeLinker: node-modules

docker/development/eth-node/Dockerfile

@@ -11,10 +11,13 @@ WORKDIR /app
 # install deps
 COPY --chown=node package.json package.json
 COPY --chown=node yarn.lock yarn.lock
-RUN yarn install --pure-lockfile
+COPY --chown=node .yarn .yarn
+COPY --chown=node .yarnrc.yml .yarnrc.yml
 
 # add files
 COPY --chown=node . .
 
+RUN yarn
+
 EXPOSE 8545
-CMD [  "yarn", "hardhat", "node", "--hostname", "0.0.0.0" ]
+CMD [ "yarn", "hardhat", "node", "--hostname", "0.0.0.0" ]

docker/development/eth-node/package.json

@@ -3,17 +3,26 @@
   "description": "Simple ETH node for development purposes",
   "private": true,
   "scripts": {
+    "packages:clean": "yarn packages --parallel run clean",
+    "packages:build": "yarn packages --topological-dev run build",
+    "build": "yarn packages:clean && yarn packages:build",
     "lint:fix": "yarn lint --fix",
     "lint": "eslint --resolve-plugins-relative-to ../eslint-config --ext .tsx,.ts,.js scripts/",
+    "packages": "yarn workspaces foreach --recursive --from '{@unlock-protocol/types,@unlock-protocol/core,@unlock-protocol/eslint-config,@unlock-protocol/hardhat-helpers,@unlock-protocol/express,@unlock-protocol/contracts,@unlock-protocol/networks,@unlock-protocol/paywall,@unlock-protocol/unlock-js,@unlock-protocol/crypto-icon,@unlock-protocol/ui,@unlock-protocol/hardhat-plugin,@unlock-protocol/email-templates}'",
     "provision": "hardhat run scripts/provision.ts",
     "start": "hardhat node"
   },
+  "workspaces": [
+    "packages/**"
+  ],
   "dependencies": {
     "@nomicfoundation/hardhat-ethers": "3.0.5",
-    "@unlock-protocol/contracts": "latest",
-    "@unlock-protocol/hardhat-plugin": "latest",
+    "@unlock-protocol/contracts": "workspace:^",
+    "@unlock-protocol/hardhat-plugin": "workspace:^",
+    "@unlock-protocol/networks": "workspace:^",
     "eslint": "8.57.0",
     "ethers": "6.10.0",
+    "fs-extra": "11.2.0",
     "hardhat": "2.22.3",
     "hardhat-erc1820": "0.1.0",
     "ts-node": "10.9.2",

docker/development/eth-node/scripts/provision.ts

@@ -76,7 +76,13 @@ async function main() {
    * 3. Deploy UNLOCK contracts
    */
   const { unlock: unlockContract } = await unlock.deployProtocol()
-  log('UNLOCK PROTOCOL DEPLOYED')
+  const [publicLockVersion, unlockVersion] = await Promise.all([
+    await unlockContract.publicLockLatestVersion(),
+    await unlockContract.unlockVersion(),
+  ])
+  log(
+    `UNLOCK PROTOCOL DEPLOYED : Unlock v${unlockVersion}, PublicLock v${publicLockVersion}`
+  )
 
   // grant Unlock minting permissions
   await udt.addMinter(await unlockContract.getAddress())
@@ -100,8 +106,7 @@ async function main() {
   // Finally, deploy locks and for each of them, if it's an ERC20, approve it for locksmith purchases
   await Promise.all(
     locksArgs(erc20Address).map(async (lockParams) => {
-      const { lock } = await unlock.createLock(lockParams)
-
+      const { lock } = await unlock.createLock({ ...lockParams })
       log(
         `LOCK "${await lockParams.name}" DEPLOYED TO ${await lock.getAddress()}`
       )