@openzeppelin/upgrades-core 1.27.3 → 1.29.0

package/src/cli/validate/validate-upgrade-safety.ts

@@ -2,28 +2,58 @@ import { ValidationOptions } from '../..';
 
 import { getBuildInfoFiles } from './build-info-file';
 import { getContractReports } from './contract-report';
+import { findContract } from './find-contract';
 import { ProjectReport, getProjectReport } from './project-report';
-import { validateBuildInfoContracts } from './validations';
+import { SourceContract, validateBuildInfoContracts } from './validations';
 
 /**
  * Validation options for upgrade safety checks.
  */
 export type ValidateUpgradeSafetyOptions = Omit<ValidationOptions, 'kind'>;
 
+export type SpecifiedContracts = {
+  contract: SourceContract;
+  reference?: SourceContract;
+};
+
 /**
  * Validates the upgrade safety of all contracts in the build info dir's build info files.
  * Only contracts that are detected as upgradeable will be validated.
  *
  * @param buildInfoDir Absolute path of build info directory, or undefined to use the default Hardhat or Foundry build-info dir.
+ * @param contract The name or fully qualified name of the contract to validate. If not specified, all upgradeable contracts in the build info directory will be validated.
+ * @param reference The name or fully qualified name of the reference contract to use for storage layout comparisons. Can only be used along with `contract`. If not specified, uses the `@custom:oz-upgrades-from` annotation in the contract that is being validated.
  * @param opts Validation options, or undefined to use the default validation options.
  * @returns The project report.
  */
 export async function validateUpgradeSafety(
   buildInfoDir?: string,
+  contract?: string,
+  reference?: string,
   opts: ValidateUpgradeSafetyOptions = {},
 ): Promise<ProjectReport> {
   const buildInfoFiles = await getBuildInfoFiles(buildInfoDir);
   const sourceContracts = validateBuildInfoContracts(buildInfoFiles);
-  const contractReports = getContractReports(sourceContracts, opts);
+
+  const specifiedContracts = findSpecifiedContracts(sourceContracts, contract, reference);
+
+  const contractReports = getContractReports(sourceContracts, opts, specifiedContracts);
   return getProjectReport(contractReports);
 }
+
+function findSpecifiedContracts(
+  sourceContracts: SourceContract[],
+  contractName?: string,
+  referenceName?: string,
+): SpecifiedContracts | undefined {
+  if (contractName !== undefined) {
+    return {
+      contract: findContract(contractName, undefined, sourceContracts),
+      reference: referenceName !== undefined ? findContract(referenceName, undefined, sourceContracts) : undefined,
+    };
+  } else if (referenceName !== undefined) {
+    throw new Error(`The reference option can only be specified when the contract option is also specified.`);
+  } else {
+    return undefined;
+  }
+}

package/src/cli/validate/validations.test.ts.md

@@ -50,8 +50,8 @@ Generated by [AVA](https://avajs.dev).
 
     ` ✘  contracts/test/cli/Validate.sol:UpgradesFromUUPS (upgrades from contracts/test/cli/Validate.sol:HasUpgradeTo)␊
     ␊
-          contracts/test/cli/Validate.sol:72: Implementation is missing a public \`upgradeTo(address)\` function␊
-              Inherit UUPSUpgradeable to include this function in your contract␊
+          contracts/test/cli/Validate.sol:72: Implementation is missing a public \`upgradeTo(address)\` or \`upgradeToAndCall(address,bytes)\` function␊
+              Inherit UUPSUpgradeable to include one or both of these functions in your contract␊
               @openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol␊
               https://zpl.in/upgrades/error-008`
 

package/src/cli/validate.test.ts

@@ -99,7 +99,7 @@ test('withDefaults - all', t => {
   t.is(opts.unsafeSkipStorageCheck, true);
   t.is(opts.unsafeAllowCustomTypes, true);
   t.is(opts.unsafeAllowLinkedLibraries, true);
-  t.true(opts.unsafeAllow.every((kind: string) => errorKinds.includes(kind as typeof errorKinds[number])));
+  t.true(opts.unsafeAllow.every((kind: string) => errorKinds.includes(kind as (typeof errorKinds)[number])));
 });
 
 test('withDefaults - invalid unsafeAllow', t => {

package/src/cli/validate.ts

@@ -13,6 +13,8 @@ Arguments:
   <BUILD_INFO_DIR>  Optional path to the build info directory which contains JSON files with Solidity compiler input and output. Defaults to 'artifacts/build-info' for Hardhat projects or 'out/build-info' for Foundry projects. If your project uses a custom output directory, you must specify its build info directory here.
 
 Options:
+  --contract <CONTRACT>  The name or fully qualified name of the contract to validate. If not specified, all upgradeable contracts in the build info directory will be validated.
+  --reference <REFERENCE_CONTRACT>  The name or fully qualified name of the reference contract to use for storage layout comparisons. Can only be used along with the --contract option. If not specified, uses the @custom:oz-upgrades-from annotation in the contract that is being validated.
   --unsafeAllow "<VALIDATION_ERRORS>"  Selectively disable one or more validation errors. Comma-separated list with one or more of the following: ${errorKinds.join(
     ', ',
   )}
@@ -24,7 +26,12 @@ export async function main(args: string[]): Promise<void> {
 
   if (!help(parsedArgs, extraArgs)) {
     const functionArgs = getFunctionArgs(parsedArgs, extraArgs);
-    const result = await validateUpgradeSafety(functionArgs.buildInfoDir, functionArgs.opts);
+    const result = await validateUpgradeSafety(
+      functionArgs.buildInfoDir,
+      functionArgs.contract,
+      functionArgs.reference,
+      functionArgs.opts,
+    );
     console.log(result.explain());
     process.exitCode = result.ok ? 0 : 1;
   }
@@ -39,7 +46,7 @@ function parseArgs(args: string[]) {
       'unsafeAllowCustomTypes',
       'unsafeAllowLinkedLibraries',
     ],
-    string: ['unsafeAllow'],
+    string: ['unsafeAllow', 'contract', 'reference'],
     alias: { h: 'help' },
   });
   const extraArgs = parsedArgs._;
@@ -59,6 +66,8 @@ function help(parsedArgs: minimist.ParsedArgs, extraArgs: string[]): boolean {
 
 interface FunctionArgs {
   buildInfoDir?: string;
+  contract?: string;
+  reference?: string;
   opts: Required<ValidateUpgradeSafetyOptions>;
 }
 
@@ -76,9 +85,22 @@ export function getFunctionArgs(parsedArgs: minimist.ParsedArgs, extraArgs: stri
     throw new Error('The validate command takes only one argument: the build info directory.');
   } else {
     const buildInfoDir = extraArgs.length === 1 ? undefined : extraArgs[1];
+    const contract = getAndValidateString(parsedArgs, 'contract');
+    const reference = getAndValidateString(parsedArgs, 'reference');
+    if (reference !== undefined && contract === undefined) {
+      throw new Error('The --reference option can only be used along with the --contract option.');
+    }
     const opts = withDefaults(parsedArgs);
-    return { buildInfoDir, opts };
+    return { buildInfoDir, contract, reference, opts };
+  }
+}
+
+function getAndValidateString(parsedArgs: minimist.ParsedArgs, option: string): string | undefined {
+  const value = parsedArgs[option];
+  if (value !== undefined && value.trim().length === 0) {
+    throw new Error(`Invalid option: --${option} cannot be empty`);
   }
+  return value;
 }
 
 function validateOptions(parsedArgs: minimist.ParsedArgs) {
@@ -93,6 +115,8 @@ function validateOptions(parsedArgs: minimist.ParsedArgs) {
         'unsafeAllowCustomTypes',
         'unsafeAllowLinkedLibraries',
         'unsafeAllow',
+        'contract',
+        'reference',
       ].includes(key),
   );
   if (invalidArgs.length > 0) {
@@ -101,7 +125,7 @@ function validateOptions(parsedArgs: minimist.ParsedArgs) {
 }
 
 function getUnsafeAllowKinds(unsafeAllow: string | undefined): ValidationError['kind'][] {
-  type errorKindsType = typeof errorKinds[number];
+  type errorKindsType = (typeof errorKinds)[number];
 
   if (unsafeAllow === undefined) {
     return [];

package/src/deployment.ts

@@ -257,7 +257,11 @@ export async function waitAndValidateDeployment(
 }
 
 export class TransactionMinedTimeout extends UpgradesError {
-  constructor(readonly deployment: Deployment & RemoteDeploymentId, type?: string, configurableTimeout?: boolean) {
+  constructor(
+    readonly deployment: Deployment & RemoteDeploymentId,
+    type?: string,
+    configurableTimeout?: boolean,
+  ) {
     super(
       `Timed out waiting for ${type ? type + ' ' : ''}contract deployment to address ${deployment.address} with ${
         deployment.remoteDeploymentId

package/src/impl-store.test.ts

@@ -1,8 +1,7 @@
 import test from 'ava';
 
 import { promises as fs } from 'fs';
-import rimrafAsync from 'rimraf';
-import util from 'util';
+import { rimraf } from 'rimraf';
 import path from 'path';
 import os from 'os';
 import sinon from 'sinon';
@@ -12,8 +11,6 @@ import { getVersion } from './version';
 import { stubProvider } from './stub-provider';
 import { ImplDeployment } from './manifest';
 
-const rimraf = util.promisify(rimrafAsync);
-
 test.before(async () => {
   process.chdir(await fs.mkdtemp(path.join(os.tmpdir(), 'upgrades-core-test-')));
 });

package/src/scripts/migrate-oz-cli-project.test.ts

@@ -1,8 +1,7 @@
 import os from 'os';
 import test from 'ava';
 import path from 'path';
-import util from 'util';
-import rimrafAsync from 'rimraf';
+import { rimraf } from 'rimraf';
 import { promises as fs } from 'fs';
 import { compare as compareVersions } from 'compare-versions';
 import {
@@ -13,7 +12,6 @@ import {
   migrateLegacyProject,
 } from './migrate-oz-cli-project';
 
-const rimraf = util.promisify(rimrafAsync);
 const BASE_PATH = 'src/scripts';
 const OPENZEPPELIN_FOLDER = '.openzeppelin';
 const PROJECT_FILE = path.join(OPENZEPPELIN_FOLDER, 'project.json');

package/src/standalone.ts

@@ -23,7 +23,12 @@ export class UpgradeableContract {
   readonly errors: ValidationError[];
   readonly layout: StorageLayout;
 
-  constructor(readonly name: string, solcInput: SolcInput, solcOutput: SolcOutput, opts: ValidationOptions = {}) {
+  constructor(
+    readonly name: string,
+    solcInput: SolcInput,
+    solcOutput: SolcOutput,
+    opts: ValidationOptions = {},
+  ) {
     const decodeSrc = solcInputOutputDecoder(solcInput, solcOutput);
     const validation = validate(solcOutput, decodeSrc);
     this.version = getContractVersion(validation, name);

package/src/storage/compare.ts

@@ -103,7 +103,10 @@ export class StorageLayoutComparator {
   stack = new Set<string>();
   cache = new Map<string, TypeChange | undefined>();
 
-  constructor(readonly unsafeAllowCustomTypes = false, readonly unsafeAllowRenames = false) {}
+  constructor(
+    readonly unsafeAllowCustomTypes = false,
+    readonly unsafeAllowRenames = false,
+  ) {}
 
   compareLayouts(original: StorageItem[], updated: StorageItem[]): LayoutCompatibilityReport {
     return new LayoutCompatibilityReport(this.layoutLevenshtein(original, updated, { allowAppend: true }));

package/src/storage/extract.ts

@@ -6,11 +6,10 @@ import {
   TypeDescriptions,
   VariableDeclaration,
 } from 'solidity-ast';
-import { isNodeType, findAll } from 'solidity-ast/utils';
+import { isNodeType, findAll, ASTDereferencer } from 'solidity-ast/utils';
 import { StorageLayout, TypeItem } from './layout';
 import { normalizeTypeIdentifier } from '../utils/type-id';
 import { SrcDecoder } from '../src-decoder';
-import { ASTDereferencer } from '../ast-dereferencer';
 import { mapValues } from '../utils/map-values';
 import { pick } from '../utils/pick';
 import { execall } from '../utils/execall';

package/src/storage/report-gap.test.ts

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, astDereferencer, findAll } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
-import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from './extract';
 import { StorageLayoutComparator } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';

package/src/storage/report-rename-retype.test.ts

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, astDereferencer, findAll } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
-import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from './extract';
 import { StorageLayoutComparator } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';

package/src/storage/report-retype-from-contract.test.ts

@@ -1,8 +1,7 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { ASTDereferencer, findAll } from 'solidity-ast/utils';
+import { ASTDereferencer, astDereferencer, findAll } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
-import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from './extract';
 import { StorageLayoutComparator, stripContractSubstrings } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';

package/src/storage/report.test.ts

@@ -1,10 +1,9 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from '../solc-api';
-import { astDereferencer } from '../ast-dereferencer';
 import { extractStorageLayout } from '../storage/extract';
 import { StorageLayoutComparator } from './compare';
 import { StorageLayout, getDetailedLayout } from './layout';

package/src/storage-0.8.test.ts

@@ -1,9 +1,8 @@
 import _test, { TestFn } from 'ava';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from './solc-api';
-import { astDereferencer } from './ast-dereferencer';
 import { getStorageUpgradeErrors } from './storage';
 import { extractStorageLayout } from './storage/extract';
 import { BuildInfo } from 'hardhat/types';

package/src/storage-memory-0.5.test.ts

@@ -1,9 +1,8 @@
 import _test, { TestFn } from 'ava';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from './solc-api';
-import { astDereferencer } from './ast-dereferencer';
 import { getStorageUpgradeErrors } from './storage';
 import { extractStorageLayout } from './storage/extract';
 import { BuildInfo } from 'hardhat/types';

package/src/storage.test.ts

@@ -1,10 +1,9 @@
 import _test, { TestFn } from 'ava';
 import { ContractDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 import { artifacts } from 'hardhat';
 
 import { SolcOutput } from './solc-api';
-import { astDereferencer } from './ast-dereferencer';
 import { getStorageUpgradeErrors } from './storage';
 import { StorageLayout } from './storage/layout';
 import { extractStorageLayout } from './storage/extract';

package/src/utils/function.test.ts

@@ -1,11 +1,10 @@
 import test from 'ava';
 import { artifacts } from 'hardhat';
 import { FunctionDefinition } from 'solidity-ast';
-import { findAll } from 'solidity-ast/utils';
+import { findAll, astDereferencer } from 'solidity-ast/utils';
 
 import { getFunctionSignature } from './function';
 import { SolcOutput } from '../solc-api';
-import { astDereferencer } from '../ast-dereferencer';
 
 testContract('ContractFunctionSignatures');
 testContract('LibraryFunctionSignatures');

package/src/utils/function.ts

@@ -1,5 +1,5 @@
 import type { FunctionDefinition, TypeName, VariableDeclaration } from 'solidity-ast';
-import { ASTDereferencer } from '../ast-dereferencer';
+import { ASTDereferencer } from 'solidity-ast/utils';
 import { assert, assertUnreachable } from './assert';
 
 function serializeParameterType(parameter: VariableDeclaration, deref: ASTDereferencer): string {

package/src/validate/error.ts

@@ -3,7 +3,10 @@ import { UpgradesError } from '../error';
 import { UpgradeableContractErrorReport } from './report';
 
 export class ValidationErrors extends UpgradesError {
-  constructor(contractName: string, readonly errors: ValidationError[]) {
+  constructor(
+    contractName: string,
+    readonly errors: ValidationError[],
+  ) {
     super(`Contract \`${contractName}\` is not upgrade safe`, () =>
       new UpgradeableContractErrorReport(errors).explain(),
     );

package/src/validate/overrides.ts

@@ -73,7 +73,7 @@ export const ValidationErrorUnsafeMessages: Record<ValidationError['kind'], stri
   selfdestruct: [`You are using the \`unsafeAllow.selfdestruct\` flag.`],
   'missing-public-upgradeto': [
     `You are using the \`unsafeAllow.missing-public-upgradeto\` flag with uups proxy.`,
-    `Not having a public upgradeTo function in your implementation can break upgradeability.`,
+    `Not having a public upgradeTo or upgradeToAndCall function in your implementation can break upgradeability.`,
     `Some implementation might check that onchain, and cause the upgrade to revert.`,
   ],
 };

package/src/validate/query.ts

@@ -8,6 +8,7 @@ import { ValidationData, normalizeValidationData } from './data';
 import { ProxyDeployment } from '../manifest';
 
 const upgradeToSignature = 'upgradeTo(address)';
+const upgradeToAndCallSignature = 'upgradeToAndCall(address,bytes)';
 
 export function assertUpgradeSafe(data: ValidationData, version: Version, opts: ValidationOptions): void {
   const dataV3 = normalizeValidationData(data);
@@ -147,7 +148,10 @@ export function getErrors(data: ValidationData, version: Version, opts: Validati
 
   const selfAndInheritedMethods = getAllMethods(runValidation, fullContractName);
 
-  if (!selfAndInheritedMethods.includes(upgradeToSignature)) {
+  if (
+    !selfAndInheritedMethods.includes(upgradeToSignature) &&
+    !selfAndInheritedMethods.includes(upgradeToAndCallSignature)
+  ) {
     errors.push({
       src: c.src,
       kind: 'missing-public-upgradeto',

package/src/validate/report.ts

@@ -57,9 +57,10 @@ const errorInfo: ErrorDescriptions<ValidationError> = {
     hint: () => `Update your dependency and run again`,
   },
   'missing-public-upgradeto': {
-    msg: () => `Implementation is missing a public \`upgradeTo(address)\` function`,
+    msg: () =>
+      `Implementation is missing a public \`upgradeTo(address)\` or \`upgradeToAndCall(address,bytes)\` function`,
     hint: () =>
-      `Inherit UUPSUpgradeable to include this function in your contract\n` +
+      `Inherit UUPSUpgradeable to include one or both of these functions in your contract\n` +
       `    @openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol`,
     link: 'https://zpl.in/upgrades/error-008',
   },

package/src/validate/run.ts

@@ -1,10 +1,9 @@
 import { Node } from 'solidity-ast/node';
-import { isNodeType, findAll, ASTDereferencer } from 'solidity-ast/utils';
+import { isNodeType, findAll, ASTDereferencer, astDereferencer } from 'solidity-ast/utils';
 import type { ContractDefinition, FunctionDefinition } from 'solidity-ast';
 
 import { SolcOutput, SolcBytecode } from '../solc-api';
 import { SrcDecoder } from '../src-decoder';
-import { astDereferencer } from '../ast-dereferencer';
 import { isNullish } from '../utils/is-nullish';
 import { getFunctionSignature } from '../utils/function';
 import { Version, getVersion } from '../version';
@@ -48,7 +47,7 @@ export type ValidationError =
 
 interface ValidationErrorBase {
   src: string;
-  kind: typeof errorKinds[number];
+  kind: (typeof errorKinds)[number];
 }
 
 interface ValidationErrorWithName extends ValidationErrorBase {

package/src/validate.test.ts

@@ -99,7 +99,10 @@ testOverride('UsesExplicitSafeExternalLibrary', 'transparent', { unsafeAllow: ['
 testValid('HasEmptyConstructor', 'uups', false);
 testValid('HasInternalUpgradeToFunction', 'uups', false);
 testValid('HasUpgradeToFunction', 'uups', true);
+testValid('HasInternalUpgradeToAndCallFunction', 'uups', false);
+testValid('HasUpgradeToAndCallFunction', 'uups', true);
 testValid('ParentHasUpgradeToFunction', 'uups', true);
+testValid('ParentHasUpgradeToAndCallFunction', 'uups', true);
 testValid('ChildOfProxiable', 'uups', true);
 
 testValid('HasNonEmptyConstructorNatspec1', 'transparent', true);

package/dist/ast-dereferencer.d.ts

@@ -1,8 +0,0 @@
-import type { NodeType, NodeTypeMap } from 'solidity-ast/node';
-import type { SolcOutput } from './solc-api';
-export interface ASTDereferencer {
-    <T extends NodeType>(nodeTypes: T[]): (id: number) => NodeTypeMap[T];
-    <T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T];
-}
-export declare function astDereferencer(solcOutput: SolcOutput): ASTDereferencer;
-//# sourceMappingURL=ast-dereferencer.d.ts.map

package/dist/ast-dereferencer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ast-dereferencer.d.ts","sourceRoot":"","sources":["../src/ast-dereferencer.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAQ,QAAQ,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAM7C,MAAM,WAAW,eAAe;IAC9B,CAAC,CAAC,SAAS,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC;IACrE,CAAC,CAAC,SAAS,QAAQ,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC;CAClE;AAED,wBAAgB,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,eAAe,CA0BvE"}

package/dist/ast-dereferencer.js

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.astDereferencer = void 0;
-const utils_1 = require("solidity-ast/utils");
-const curry_1 = require("./utils/curry");
-function astDereferencer(solcOutput) {
-    const asts = Array.from(Object.values(solcOutput.sources), s => s.ast);
-    const cache = new Map();
-    function deref(nodeTypes, id) {
-        const cached = cache.get(id);
-        if (cached) {
-            if (nodeTypes.includes(cached.nodeType)) {
-                return cached;
-            }
-        }
-        for (const ast of asts) {
-            for (const node of (0, utils_1.findAll)(nodeTypes, ast)) {
-                if (node.id === id) {
-                    cache.set(id, node);
-                    return node;
-                }
-            }
-        }
-        throw new Error(`No node with id ${id} of type ${nodeTypes}`);
-    }
-    return (0, curry_1.curry2)(deref);
-}
-exports.astDereferencer = astDereferencer;
-//# sourceMappingURL=ast-dereferencer.js.map

package/dist/ast-dereferencer.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ast-dereferencer.js","sourceRoot":"","sources":["../src/ast-dereferencer.ts"],"names":[],"mappings":";;;AAAA,8CAA6C;AAG7C,yCAAuC;AAYvC,SAAgB,eAAe,CAAC,UAAsB;IACpD,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvE,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgB,CAAC;IAEtC,SAAS,KAAK,CAAqB,SAAc,EAAE,EAAU;QAC3D,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAE7B,IAAI,MAAM,EAAE;YACV,IAAK,SAAwB,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;gBACvD,OAAO,MAAwB,CAAC;aACjC;SACF;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,KAAK,MAAM,IAAI,IAAI,IAAA,eAAO,EAAC,SAAS,EAAE,GAAG,CAAC,EAAE;gBAC1C,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,EAAE;oBAClB,KAAK,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;oBACpB,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,MAAM,IAAI,KAAK,CAAC,mBAAmB,EAAE,YAAY,SAAS,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,OAAO,IAAA,cAAM,EAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AA1BD,0CA0BC"}

package/src/ast-dereferencer.ts

@@ -1,42 +0,0 @@
-import { findAll } from 'solidity-ast/utils';
-import type { Node, NodeType, NodeTypeMap } from 'solidity-ast/node';
-
-import { curry2 } from './utils/curry';
-import type { SolcOutput } from './solc-api';
-
-// An ASTDereferencer is a function that looks up an AST node given its id, in all of the source files involved in a
-// solc run. It will generally be used together with the AST property `referencedDeclaration` (found in Identifier,
-// UserDefinedTypeName, etc.) to look up a variable definition or type definition.
-
-export interface ASTDereferencer {
-  <T extends NodeType>(nodeTypes: T[]): (id: number) => NodeTypeMap[T];
-  <T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T];
-}
-
-export function astDereferencer(solcOutput: SolcOutput): ASTDereferencer {
-  const asts = Array.from(Object.values(solcOutput.sources), s => s.ast);
-  const cache = new Map<number, Node>();
-
-  function deref<T extends NodeType>(nodeTypes: T[], id: number): NodeTypeMap[T] {
-    const cached = cache.get(id);
-
-    if (cached) {
-      if ((nodeTypes as NodeType[]).includes(cached.nodeType)) {
-        return cached as NodeTypeMap[T];
-      }
-    }
-
-    for (const ast of asts) {
-      for (const node of findAll(nodeTypes, ast)) {
-        if (node.id === id) {
-          cache.set(id, node);
-          return node;
-        }
-      }
-    }
-
-    throw new Error(`No node with id ${id} of type ${nodeTypes}`);
-  }
-
-  return curry2(deref);
-}