Detruffle check-versions script (#11490)

Author: m-chrzan

.prettierignore

@@ -19,6 +19,7 @@ packages/protocol/types/
 packages/protocol/scripts/**/*.js
 packages/protocol/migrations/**/*.js
 packages/protocol/test/**/*.js
+packages/protocol/test-ts/**/*.js
 packages/protocol/contractPackages.js
 packages/protocol/abis/src-generated/
 

packages/env-tests/package.json

@@ -32,6 +32,7 @@
   "devDependencies": {
     "@tsconfig/recommended": "^1.0.3",
     "@jest/globals": "^29.5.0",
+    "@types/bunyan": "^1.8.11",
     "typescript": "^5.3.3"
   }
 }

packages/env-tests/src/context.ts

@@ -1,5 +1,4 @@
 import { Address, ContractKit } from '@celo/contractkit'
-// @ts-expect-error module started failing
 import Logger from 'bunyan'
 export interface EnvTestContext {
   kit: ContractKit

packages/env-tests/src/logger.ts

@@ -1,4 +1,3 @@
-// @ts-expect-error module started failing
 import Logger, { createLogger, levelFromName, LogLevelString, stdSerializers } from 'bunyan'
 import bunyanDebugStream from 'bunyan-debug-stream'
 import { createStream } from 'bunyan-gke-stackdriver'

packages/protocol/.gitignore

@@ -18,6 +18,8 @@ scripts/**/*.js.map
 test/**/*.js
 test/**/*.js.map
 
+test-ts/**/*.js
+
 types/**/*.js
 types/**/*.js.map
 

packages/protocol/CHEATSHEET.md

@@ -28,7 +28,6 @@ Covers changes in `package.json` scripts introduced starting with PR [#11369](ht
 | `...`                                   | `test`                                        |
 | `test:coverage`                         | `test:coverage`                               |
 | `gas`                                   | `test:gas`                                    |
-| `quicktest`                             | `test:quicktest`                              |
 | `test:release-snapshots`                | `test:release-snapshots`                      |
 | `test:scripts`                          | `test:scripts`                                |
 | `test`                                  | `test:truffle`                                |

packages/protocol/README.md

@@ -85,25 +85,6 @@ yarn run test:truffle ${contract name}
 
 Adding the optional `--gas` flag will print out a report of contract gas usage.
 
-For quick test iterations run:
-
-```bash
-yarn run test:quicktest
-```
-
-or for a single contract:
-
-```bash
-yarn run test:quicktest ${contract name}
-```
-
-For `test:quicktest` to work correctly a contract's migration dependencies have to be uncommented in `scripts/bash/backupmigrations.sh`.
-
-Compared to the normal test command, quicktest will:
-
-1. Not run the pretest script of building solidity (will still be run as part of truffle test) and compiling typescript. This works because truffle can run typescript "natively".
-2. Only migrate selected migrations as set in `backupmigrations.sh` (you'll likely need at least one compilation step since truffle seems to only run compiled migrations)
-
 ## Making a new release (Foundry)
 
 To create a new release using the Foundry script, run the following command:

packages/protocol/lib/compatibility/ast-code.ts

@@ -5,7 +5,7 @@ import {
   MethodMutabilityChange, MethodRemovedChange, MethodReturnChange,
   MethodVisibilityChange, NewContractChange
 } from '@celo/protocol/lib/compatibility/change'
-import { makeZContract } from '@celo/protocol/lib/compatibility/internal'
+import { makeZContract, getContractName, getArtifactByName } from '@celo/protocol/lib/compatibility/internal'
 import {
   BuildArtifacts,
   Contract as ZContract
@@ -259,10 +259,19 @@ export function reportASTIncompatibilities(
   let out: ASTCodeCompatibilityReport[] = []
   for (const newArtifacts of newArtifactsSets) {
     const reports = newArtifacts.listArtifacts()
+      .filter((newArtifact) => {
+        // Matches all Truffle project artifacts (core contracts and test resource contracts)
+        const truffleProjectContractPathPattern = /^project:/
+        // Matches Foundry core contracts
+        const foundryCoreContractPathPattern = /^contracts(-0\.8)?\//
+        // Matches Foundry test resource contracts
+        const foundryTestContractPathPattern = /^test-ts/
+        const path = newArtifact.ast.absolutePath
+        return truffleProjectContractPathPattern.test(path) || foundryCoreContractPathPattern.test(path) || foundryTestContractPathPattern.test(path)
+      })
       .map((newArtifact) => {
-
         for (const oldArtifacts of oldArtifactsSet) {
-          const oldArtifact = oldArtifacts.getArtifactByName(newArtifact.contractName)
+          const oldArtifact = getArtifactByName(getContractName(newArtifact), oldArtifacts)
           if (oldArtifact) {
             return generateASTCompatibilityReport(makeZContract(oldArtifact), oldArtifacts, makeZContract(newArtifact), newArtifacts)
           }
@@ -271,7 +280,6 @@ export function reportASTIncompatibilities(
         return generateASTCompatibilityReport(null, oldArtifactsSet[0], makeZContract(newArtifact), newArtifacts)
       })
     out = [...out, ...reports]
-
   }
 
   return mergeReports(out)

packages/protocol/lib/compatibility/ast-layout.ts

@@ -1,38 +1,11 @@
-import { Contract as Web3Contract } from '@celo/connect';
-import { Artifact, TypeInfo } from '@celo/protocol/lib/compatibility/internal';
+import { Artifact, TypeInfo, makeZContract, getContractName, getArtifactByName } from '@celo/protocol/lib/compatibility/internal';
 import {
   BuildArtifacts,
   Operation,
   StorageLayoutInfo,
-  Contract as ZContract,
   compareStorageLayouts,
   getStorageLayout
 } from '@openzeppelin/upgrades';
-const Web3 = require('web3')
-
-const web3 = new Web3(null)
-
-// getStorageLayout needs an oz-sdk Contract class instance. This class is a
-// subclass of Contract from web3-eth-contract, with an added .schema member and
-// several methods.
-//
-// Couldn't find an easy way of getting one just from contract artifacts. But
-// for getStorageLayout we really only need .schema.ast and .schema.contractName.
-const addSchemaForLayoutChecking = (web3Contract: Web3Contract, artifact: any): ZContract => {
-  // @ts-ignore
-  const contract = web3Contract as Contract
-  // @ts-ignore
-  contract.schema = {}
-  contract.schema.ast = artifact.ast
-  contract.schema.contractName = artifact.contractName
-  return contract
-}
-
-const makeZContract = (artifact: any): ZContract => {
-  const contract = new web3.eth.Contract(artifact.abi)
-
-  return addSchemaForLayoutChecking(contract, artifact)
-}
 
 export const getLayout = (artifact: Artifact, artifacts: BuildArtifacts) => {
   const contract = makeZContract(artifact)
@@ -200,15 +173,15 @@ export const generateCompatibilityReport = (oldArtifact: Artifact, oldArtifacts:
   const structsReport = generateStructsCompatibilityReport(oldLayout, newLayout)
 
   if (!layoutReport.compatible) {
-    console.log(newArtifact.contractName, "layoutReport incompatible", JSON.stringify(layoutReport.errors));
+    console.log(getContractName(newArtifact), "layoutReport incompatible", JSON.stringify(layoutReport.errors));
   }
 
   if (!structsReport.compatible) {
-    console.log(newArtifact.contractName, "structsReport incompatible", JSON.stringify(structsReport.errors));
+    console.log(getContractName(newArtifact), "structsReport incompatible", JSON.stringify(structsReport.errors));
   }
 
   return {
-    contract: newArtifact.contractName,
+    contract: getContractName(newArtifact),
     compatible: layoutReport.compatible && structsReport.compatible,
     errors: layoutReport.errors.concat(structsReport.errors),
     expanded: structsReport.expanded
@@ -218,10 +191,20 @@ export const generateCompatibilityReport = (oldArtifact: Artifact, oldArtifacts:
 export const reportLayoutIncompatibilities = (oldArtifactsSet: BuildArtifacts[], newArtifactsSets: BuildArtifacts[]): ASTStorageCompatibilityReport[] => {
   let out: ASTStorageCompatibilityReport[] = []
   for (const newArtifacts of newArtifactsSets) {
-    const reports = newArtifacts.listArtifacts().map((newArtifact) => {
-
+    const reports = newArtifacts.listArtifacts()
+      .filter((newArtifact: any) => {
+        // Matches all Truffle project artifacts (core contracts and test resource contracts)
+        const truffleProjectContractPathPattern = /^project:/
+        // Matches Foundry core contracts
+        const foundryCoreContractPathPattern = /^contracts(-0\.8)?\//
+        // Matches Foundry test resource contracts
+        const foundryTestContractPathPattern = /^test-ts/
+        const path = newArtifact.ast.absolutePath
+        return truffleProjectContractPathPattern.test(path) || foundryCoreContractPathPattern.test(path) || foundryTestContractPathPattern.test(path)
+      })
+      .map((newArtifact: any) => {
       for (const oldArtifacts of oldArtifactsSet) {
-        const oldArtifact = oldArtifacts.getArtifactByName(newArtifact.contractName)
+        const oldArtifact: any = getArtifactByName(getContractName(newArtifact), oldArtifacts)
         if (oldArtifact !== undefined) {
           return generateCompatibilityReport(oldArtifact, oldArtifacts, newArtifact, newArtifacts)
         }
@@ -230,7 +213,7 @@ export const reportLayoutIncompatibilities = (oldArtifactsSet: BuildArtifacts[],
       // Generate an empty report for new contracts, which are, by definition, backwards
       // compatible.
       return {
-        contract: newArtifact.contractName,
+        contract: getContractName(newArtifact),
         compatible: true,
         errors: []
       }

packages/protocol/lib/compatibility/ast-version.ts

@@ -1,5 +1,5 @@
 /* eslint-disable max-classes-per-file: 0 */
-import { Artifact } from '@celo/protocol/lib/compatibility/internal';
+import { Artifact, getContractName } from '@celo/protocol/lib/compatibility/internal';
 import { ContractVersion, ContractVersionChecker, ContractVersionCheckerIndex, ContractVersionDelta, ContractVersionDeltaIndex, ContractVersionIndex, DEFAULT_VERSION_STRING } from '@celo/protocol/lib/compatibility/version';
 import { Address as EJSAddress } from "@ethereumjs/util";
 import { VM } from "@ethereumjs/vm";
@@ -11,12 +11,12 @@ const abi = require('ethereumjs-abi')
  * A mapping {contract name => {@link ContractVersion}}.
  */
 export class ASTContractVersions {
-  static fromArtifacts = async (artifactsSet: BuildArtifacts[]): Promise<ASTContractVersions> => {
+  static fromArtifacts = async (artifactsSet: BuildArtifacts[], newLinking: boolean): Promise<ASTContractVersions> => {
     const contracts = {}
 
     for (const artifacts of artifactsSet) {
-      await Promise.all(artifacts.listArtifacts().filter(c => !isLibrary(c.contractName, [artifacts])).map(async (artifact) => {
-        contracts[artifact.contractName] = await getContractVersion(artifact)
+      await Promise.all(artifacts.listArtifacts().filter(c => !isLibrary(getContractName(c), [artifacts])).map(async (artifact) => {
+        contracts[getContractName(artifact)] = await getContractVersion(artifact, newLinking)
       }))
     }
 
@@ -30,15 +30,19 @@ export class ASTContractVersions {
  * Gets the version of a contract by calling Contract.getVersionNumber() on
  * the contract deployed bytecode.
  *
+ * If `newLinking` is true, expects `__$<hash>$__` style linking. Otherwise, `__<LibraryName>____`
+ * style.
+ *
  * If the contract version cannot be retrieved, returns version 1.1.0.0 by default.
  */
-export async function getContractVersion(artifact: Artifact): Promise<ContractVersion> {
+export async function getContractVersion(artifact: Artifact, newLinking: boolean): Promise<ContractVersion> {
   const vm = await VM.create();
-  const bytecode = artifact.deployedBytecode
+  // @ts-ignore
+  const bytecode = artifact.deployedBytecode.object || artifact.deployedBytecode
   const data = '0x' + abi.methodID('getVersionNumber', []).toString('hex')
   const nullAddress = '0000000000000000000000000000000000000000'
-  // Artificially link all libraries to the null address.
-  const linkedBytecode = bytecode.split(/[_]+[A-Za-z0-9]+[_]+/).join(nullAddress)
+  const compilerLinkRegex = newLinking ? /__\$[a-f0-9]{34}\$__/g : /__[A-Za-z0-9_]{36}__/g
+  const linkedBytecode = bytecode.split(compilerLinkRegex).join(nullAddress)
   const result = await vm.evm.runCall({
     to: new EJSAddress(Buffer.from(nullAddress, 'hex')),
     caller: new EJSAddress(Buffer.from(nullAddress, 'hex')),
@@ -57,9 +61,9 @@ export async function getContractVersion(artifact: Artifact): Promise<ContractVe
 }
 
 export class ASTContractVersionsChecker {
-  static create = async (oldArtifactsSet: BuildArtifacts[], newArtifactsSet: BuildArtifacts[], expectedVersionDeltas: ContractVersionDeltaIndex): Promise<ASTContractVersionsChecker> => {
-    const oldVersions = await ASTContractVersions.fromArtifacts(oldArtifactsSet)
-    const newVersions = await ASTContractVersions.fromArtifacts(newArtifactsSet)
+  static create = async (oldArtifactsSet: BuildArtifacts[], newArtifactsSet: BuildArtifacts[], expectedVersionDeltas: ContractVersionDeltaIndex, newLinking: boolean): Promise<ASTContractVersionsChecker> => {
+    const oldVersions = await ASTContractVersions.fromArtifacts(oldArtifactsSet, newLinking)
+    const newVersions = await ASTContractVersions.fromArtifacts(newArtifactsSet, newLinking)
     const contracts = {}
     Object.keys(newVersions.contracts).map((contract: string) => {
       const versionDelta = expectedVersionDeltas[contract] === undefined ? ContractVersionDelta.fromChanges(false, false, false, false) : expectedVersionDeltas[contract]