@openzeppelin/upgrades-core 1.9.0 → 1.11.0

package/dist/version.test.js

@@ -7,7 +7,7 @@ const ava_1 = __importDefault(require("ava"));
 const hardhat_1 = require("hardhat");
 const version_1 = require("./version");
 const contractBytecode = '01234567890abcdef';
-ava_1.default('same code different formatting produces different metadata', async (t) => {
+(0, ava_1.default)('same code different formatting produces different metadata', async (t) => {
     async function getBytecodeByContractName(contractName) {
         const buildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/Version.sol:Greeter');
         if (buildInfo === undefined) {
@@ -18,17 +18,17 @@ ava_1.default('same code different formatting produces different metadata', asyn
     }
     const GreeterBytecode = await getBytecodeByContractName('Greeter');
     const GreeterDifferentFormattingBytecode = await getBytecodeByContractName('GreeterDifferentFormatting');
-    t.not(version_1.hashBytecode(GreeterBytecode), version_1.hashBytecode(GreeterDifferentFormattingBytecode));
-    t.is(version_1.hashBytecodeWithoutMetadata(GreeterBytecode), version_1.hashBytecodeWithoutMetadata(GreeterDifferentFormattingBytecode));
+    t.not((0, version_1.hashBytecode)(GreeterBytecode), (0, version_1.hashBytecode)(GreeterDifferentFormattingBytecode));
+    t.is((0, version_1.hashBytecodeWithoutMetadata)(GreeterBytecode), (0, version_1.hashBytecodeWithoutMetadata)(GreeterDifferentFormattingBytecode));
 });
-ava_1.default('removes metadata from Solidity 0.4 bytecode', t => {
+(0, ava_1.default)('removes metadata from Solidity 0.4 bytecode', t => {
     const swarmHash = '69b1869ae52f674ffccdd8f6d35de04d578a778e919a1b41b7a2177668e08e1a';
     const swarmHashWrapper = `65627a7a72305820${swarmHash}`;
     const metadata = `a1${swarmHashWrapper}0029`;
     const bytecode = `0x${contractBytecode}${metadata}`;
-    t.is(version_1.hashBytecodeWithoutMetadata(bytecode), version_1.hashBytecode(`0x${contractBytecode}`));
+    t.is((0, version_1.hashBytecodeWithoutMetadata)(bytecode), (0, version_1.hashBytecode)(`0x${contractBytecode}`));
 });
-ava_1.default('removes metadata from Solidity ^0.5.9 bytecode', t => {
+(0, ava_1.default)('removes metadata from Solidity ^0.5.9 bytecode', t => {
     // Solidity 0.5.9 includes solc version into the CBOR encoded metadata
     // https://github.com/ethereum/solidity/releases/tag/v0.5.9
     const swarmHash = '69b1869ae52f674ffccdd8f6d35de04d578a778e919a1b41b7a2177668e08e1a';
@@ -36,18 +36,18 @@ ava_1.default('removes metadata from Solidity ^0.5.9 bytecode', t => {
     const solcVersionWrapper = '64736f6c6343000509';
     const metadata = `a2${swarmHashWrapper}${solcVersionWrapper}0032`;
     const bytecode = `0x${contractBytecode}${metadata}`;
-    t.is(version_1.hashBytecodeWithoutMetadata(bytecode), version_1.hashBytecode(`0x${contractBytecode}`));
+    t.is((0, version_1.hashBytecodeWithoutMetadata)(bytecode), (0, version_1.hashBytecode)(`0x${contractBytecode}`));
 });
-ava_1.default('does not change the bytecode if metadata encoding is invalid', t => {
+(0, ava_1.default)('does not change the bytecode if metadata encoding is invalid', t => {
     const swarmHash = '69b1869ae52f674ffccdd8f6d35de04d578a778e919a1b41b7a2177668e08e1a';
     const invalidSwarmHashWrapper = `a165627a7a72305821${swarmHash}0029`;
     const bytecode = `0x${contractBytecode}${invalidSwarmHashWrapper}`;
-    t.is(version_1.hashBytecodeWithoutMetadata(bytecode), version_1.hashBytecode(bytecode));
+    t.is((0, version_1.hashBytecodeWithoutMetadata)(bytecode), (0, version_1.hashBytecode)(bytecode));
 });
-ava_1.default('does not change the bytecode if metadata length is not reliable', t => {
+(0, ava_1.default)('does not change the bytecode if metadata length is not reliable', t => {
     const swarmHash = '69b1869ae52f674ffccdd8f6d35de04d578a778e919a1b41b7a2177668e08e1a';
     const invalidSwarmHashWrapper = `a165627a7a72305821${swarmHash}9929`;
     const bytecode = `0x${contractBytecode}${invalidSwarmHashWrapper}`;
-    t.is(version_1.hashBytecodeWithoutMetadata(bytecode), version_1.hashBytecode(bytecode));
+    t.is((0, version_1.hashBytecodeWithoutMetadata)(bytecode), (0, version_1.hashBytecode)(bytecode));
 });
 //# sourceMappingURL=version.test.js.map

package/dist/version.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.test.js","sourceRoot":"","sources":["../src/version.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,qCAAoC;AACpC,uCAAsE;AAEtE,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAE7C,aAAI,CAAC,4DAA4D,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3E,KAAK,UAAU,yBAAyB,CAAC,YAAoB;QAC3D,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,oCAAoC,CAAC,CAAC;QACrF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,OAAO,UAAU,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9F,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACnE,MAAM,kCAAkC,GAAG,MAAM,yBAAyB,CAAC,4BAA4B,CAAC,CAAC;IAEzG,CAAC,CAAC,GAAG,CAAC,sBAAY,CAAC,eAAe,CAAC,EAAE,sBAAY,CAAC,kCAAkC,CAAC,CAAC,CAAC;IACvF,CAAC,CAAC,EAAE,CAAC,qCAA2B,CAAC,eAAe,CAAC,EAAE,qCAA2B,CAAC,kCAAkC,CAAC,CAAC,CAAC;AACtH,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,6CAA6C,EAAE,CAAC,CAAC,EAAE;IACtD,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,gBAAgB,GAAG,mBAAmB,SAAS,EAAE,CAAC;IACxD,MAAM,QAAQ,GAAG,KAAK,gBAAgB,MAAM,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAEpD,CAAC,CAAC,EAAE,CAAC,qCAA2B,CAAC,QAAQ,CAAC,EAAE,sBAAY,CAAC,KAAK,gBAAgB,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,gDAAgD,EAAE,CAAC,CAAC,EAAE;IACzD,sEAAsE;IACtE,2DAA2D;IAC3D,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,gBAAgB,GAAG,mBAAmB,SAAS,EAAE,CAAC;IACxD,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;IAChD,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,kBAAkB,MAAM,CAAC;IAClE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAEpD,CAAC,CAAC,EAAE,CAAC,qCAA2B,CAAC,QAAQ,CAAC,EAAE,sBAAY,CAAC,KAAK,gBAAgB,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,8DAA8D,EAAE,CAAC,CAAC,EAAE;IACvE,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,uBAAuB,GAAG,qBAAqB,SAAS,MAAM,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAEnE,CAAC,CAAC,EAAE,CAAC,qCAA2B,CAAC,QAAQ,CAAC,EAAE,sBAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AAEH,aAAI,CAAC,iEAAiE,EAAE,CAAC,CAAC,EAAE;IAC1E,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,uBAAuB,GAAG,qBAAqB,SAAS,MAAM,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAEnE,CAAC,CAAC,EAAE,CAAC,qCAA2B,CAAC,QAAQ,CAAC,EAAE,sBAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC"}
+{"version":3,"file":"version.test.js","sourceRoot":"","sources":["../src/version.test.ts"],"names":[],"mappings":";;;;;AAAA,8CAAuB;AACvB,qCAAoC;AACpC,uCAAsE;AAEtE,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAE7C,IAAA,aAAI,EAAC,4DAA4D,EAAE,KAAK,EAAC,CAAC,EAAC,EAAE;IAC3E,KAAK,UAAU,yBAAyB,CAAC,YAAoB;QAC3D,MAAM,SAAS,GAAG,MAAM,mBAAS,CAAC,YAAY,CAAC,oCAAoC,CAAC,CAAC;QACrF,IAAI,SAAS,KAAK,SAAS,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;SACzC;QACD,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC;QACpC,OAAO,UAAU,CAAC,SAAS,CAAC,4BAA4B,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9F,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,yBAAyB,CAAC,SAAS,CAAC,CAAC;IACnE,MAAM,kCAAkC,GAAG,MAAM,yBAAyB,CAAC,4BAA4B,CAAC,CAAC;IAEzG,CAAC,CAAC,GAAG,CAAC,IAAA,sBAAY,EAAC,eAAe,CAAC,EAAE,IAAA,sBAAY,EAAC,kCAAkC,CAAC,CAAC,CAAC;IACvF,CAAC,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,eAAe,CAAC,EAAE,IAAA,qCAA2B,EAAC,kCAAkC,CAAC,CAAC,CAAC;AACtH,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,6CAA6C,EAAE,CAAC,CAAC,EAAE;IACtD,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,gBAAgB,GAAG,mBAAmB,SAAS,EAAE,CAAC;IACxD,MAAM,QAAQ,GAAG,KAAK,gBAAgB,MAAM,CAAC;IAC7C,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAEpD,CAAC,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,QAAQ,CAAC,EAAE,IAAA,sBAAY,EAAC,KAAK,gBAAgB,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,gDAAgD,EAAE,CAAC,CAAC,EAAE;IACzD,sEAAsE;IACtE,2DAA2D;IAC3D,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,gBAAgB,GAAG,mBAAmB,SAAS,EAAE,CAAC;IACxD,MAAM,kBAAkB,GAAG,oBAAoB,CAAC;IAChD,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,kBAAkB,MAAM,CAAC;IAClE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,QAAQ,EAAE,CAAC;IAEpD,CAAC,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,QAAQ,CAAC,EAAE,IAAA,sBAAY,EAAC,KAAK,gBAAgB,EAAE,CAAC,CAAC,CAAC;AACrF,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,8DAA8D,EAAE,CAAC,CAAC,EAAE;IACvE,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,uBAAuB,GAAG,qBAAqB,SAAS,MAAM,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAEnE,CAAC,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,QAAQ,CAAC,EAAE,IAAA,sBAAY,EAAC,QAAQ,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC;AAEH,IAAA,aAAI,EAAC,iEAAiE,EAAE,CAAC,CAAC,EAAE;IAC1E,MAAM,SAAS,GAAG,kEAAkE,CAAC;IACrF,MAAM,uBAAuB,GAAG,qBAAqB,SAAS,MAAM,CAAC;IACrE,MAAM,QAAQ,GAAG,KAAK,gBAAgB,GAAG,uBAAuB,EAAE,CAAC;IAEnE,CAAC,CAAC,EAAE,CAAC,IAAA,qCAA2B,EAAC,QAAQ,CAAC,EAAE,IAAA,sBAAY,EAAC,QAAQ,CAAC,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openzeppelin/upgrades-core",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "",
   "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
   "license": "MIT",
@@ -13,14 +13,17 @@
     "/artifacts/contracts/proxy/AdminUpgradeabilityProxy.sol/AdminUpgradeabilityProxy.json",
     "/artifacts/contracts/proxy/ProxyAdmin.sol/ProxyAdmin.json",
     "/contracts/Initializable.sol",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/BeaconProxy.sol",
+    "/artifacts/@openzeppelin/contracts/proxy/beacon/UpgradeableBeacon.sol",
     "/artifacts/@openzeppelin/contracts/proxy/ERC1967/ERC1967Proxy.sol",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json ",
     "/artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json"
   ],
   "scripts": {
-    "prepublish": "rimraf artifacts cache dist *.tsbuildinfo",
-    "prepare": "tsc -b && yarn prepare:contracts",
-    "prepare:contracts": "hardhat compile",
+    "clean": "hardhat clean && rimraf dist *.tsbuildinfo",
+    "compile": "tsc -b && yarn compile:contracts",
+    "compile:contracts": "hardhat compile",
+    "prepare": "yarn clean && yarn compile",
     "prepublishOnly": "bash scripts/copy-artifacts.sh",
     "test": "tsc -b && hardhat compile --force && ava",
     "test:watch": "hardhat compile --force && fgbg 'ava --watch' 'tsc -b --watch' --",
@@ -31,6 +34,7 @@
     "@nomiclabs/hardhat-ethers": "^2.0.2",
     "@nomiclabs/hardhat-etherscan": "^2.1.0",
     "@openzeppelin/contracts": "4.1.0",
+    "@openzeppelin/contracts-upgradeable": "4.1.0",
     "@types/bn.js": "^5.0.0",
     "@types/cbor": "^5.0.0",
     "@types/debug": "^4.1.5",
@@ -49,10 +53,11 @@
     "bn.js": "^5.1.2",
     "cbor": "^8.0.0",
     "chalk": "^4.1.0",
-    "compare-versions": "^3.6.0",
+    "compare-versions": "^4.0.0",
     "debug": "^4.1.1",
     "ethereumjs-util": "^7.0.3",
     "proper-lockfile": "^4.1.1",
     "solidity-ast": "^0.4.15"
-  }
+  },
+  "gitHead": "a32bd11a82ede9136d18de4cf0a1d18f44127103"
 }

package/src/beacon.ts

@@ -0,0 +1,20 @@
+import { InvalidBeacon, getImplementationAddressFromBeacon } from './impl-address';
+import { EthereumProvider } from './provider';
+
+/**
+ * Checks if the address looks like a beacon.
+ *
+ * @returns true if the address has an implementation() function that returns an address, false otherwise.
+ */
+export async function isBeacon(provider: EthereumProvider, beaconAddress: string): Promise<boolean> {
+  try {
+    await getImplementationAddressFromBeacon(provider, beaconAddress);
+    return true;
+  } catch (e: any) {
+    if (e instanceof InvalidBeacon) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}

package/src/eip-1967-type.ts

@@ -0,0 +1,35 @@
+import {
+  EIP1967BeaconNotFound,
+  EIP1967ImplementationNotFound,
+  getBeaconAddress,
+  getImplementationAddress,
+} from './eip-1967';
+import { EthereumProvider } from './provider';
+
+export async function isTransparentOrUUPSProxy(provider: EthereumProvider, address: string): Promise<boolean> {
+  try {
+    await getImplementationAddress(provider, address);
+    // if an exception was not encountered above, then this address is a transparent/uups proxy
+    return true;
+  } catch (e: any) {
+    if (e instanceof EIP1967ImplementationNotFound) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}
+
+export async function isBeaconProxy(provider: EthereumProvider, address: string): Promise<boolean> {
+  try {
+    await getBeaconAddress(provider, address);
+    // if an exception was not encountered above, then this address is a beacon proxy
+    return true;
+  } catch (e: any) {
+    if (e instanceof EIP1967BeaconNotFound) {
+      return false;
+    } else {
+      throw e;
+    }
+  }
+}

package/src/eip-1967.ts

@@ -1,7 +1,12 @@
-import { toChecksumAddress, keccak256 } from 'ethereumjs-util';
 import BN from 'bn.js';
-
+import { keccak256 } from 'ethereumjs-util';
+import { UpgradesError } from './error';
 import { EthereumProvider, getStorageAt } from './provider';
+import { parseAddress } from './utils/address';
+
+export class EIP1967ImplementationNotFound extends UpgradesError {}
+
+export class EIP1967BeaconNotFound extends UpgradesError {}
 
 export async function getAdminAddress(provider: EthereumProvider, address: string): Promise<string> {
   const storage = await getStorageFallback(
@@ -11,7 +16,7 @@ export async function getAdminAddress(provider: EthereumProvider, address: strin
     toFallbackEip1967Hash('org.zeppelinos.proxy.admin'),
   );
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 export async function getImplementationAddress(provider: EthereumProvider, address: string): Promise<string> {
@@ -23,20 +28,20 @@ export async function getImplementationAddress(provider: EthereumProvider, addre
   );
 
   if (isEmptySlot(storage)) {
-    throw new Error(`Contract at ${address} doesn't look like an administered ERC 1967 proxy`);
+    throw new EIP1967ImplementationNotFound(`Contract at ${address} doesn't look like an administered ERC 1967 proxy`);
   }
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 export async function getBeaconAddress(provider: EthereumProvider, address: string): Promise<string> {
   const storage = await getStorageFallback(provider, address, toEip1967Hash('eip1967.proxy.beacon'));
 
   if (isEmptySlot(storage)) {
-    throw new Error(`Contract at ${address} doesn't look like an ERC 1967 beacon proxy`);
+    throw new EIP1967BeaconNotFound(`Contract at ${address} doesn't look like an ERC 1967 beacon proxy`);
   }
 
-  return parseAddress(storage);
+  return parseAddressFromStorage(storage);
 }
 
 async function getStorageFallback(provider: EthereumProvider, address: string, ...slots: string[]): Promise<string> {
@@ -67,11 +72,10 @@ function isEmptySlot(storage: string): boolean {
   return new BN(storage, 'hex').isZero();
 }
 
-function parseAddress(storage: string): string {
-  const buf = Buffer.from(storage.replace(/^0x/, ''), 'hex');
-  if (!buf.slice(0, 12).equals(Buffer.alloc(12, 0))) {
+function parseAddressFromStorage(storage: string): string {
+  const address = parseAddress(storage);
+  if (address === undefined) {
     throw new Error(`Value in storage is not an address (${storage})`);
   }
-  const address = '0x' + buf.toString('hex', 12, 32); // grab the last 20 bytes
-  return toChecksumAddress(address);
+  return address;
 }

package/src/impl-address.ts

@@ -0,0 +1,76 @@
+import { keccak256 } from 'ethereumjs-util';
+import {
+  call,
+  EIP1967BeaconNotFound,
+  EIP1967ImplementationNotFound,
+  getBeaconAddress,
+  getImplementationAddress,
+  UpgradesError,
+} from '.';
+
+import { EthereumProvider } from './provider';
+import { parseAddress } from './utils/address';
+
+export class InvalidBeacon extends UpgradesError {}
+
+/**
+ * Gets the implementation address from the beacon using its implementation() function.
+ * @param provider
+ * @param beaconAddress
+ * @returns The implementation address.
+ * @throws {InvalidBeacon} If the implementation() function could not be called or does not return an address.
+ */
+export async function getImplementationAddressFromBeacon(
+  provider: EthereumProvider,
+  beaconAddress: string,
+): Promise<string> {
+  const implementationFunction = '0x' + keccak256(Buffer.from('implementation()')).toString('hex').slice(0, 8);
+  let result: string | undefined;
+  try {
+    const implAddress = await call(provider, beaconAddress, implementationFunction);
+    result = parseAddress(implAddress);
+  } catch (e: any) {
+    if (
+      !(
+        e.message.includes('function selector was not recognized') ||
+        e.message.includes('invalid opcode') ||
+        e.message.includes('Transaction reverted')
+      )
+    ) {
+      throw e;
+    } // otherwise fall through with no result
+  }
+  if (result === undefined) {
+    throw new InvalidBeacon(`Contract at ${beaconAddress} doesn't look like a beacon`);
+  }
+  return result;
+}
+
+/**
+ * Gets the implementation address from a UUPS/Transparent/Beacon proxy.
+ *
+ * @returns a Promise with the implementation address, or undefined if a UUPS/Transparent/Beacon proxy is not located at the address.
+ */
+export async function getImplementationAddressFromProxy(
+  provider: EthereumProvider,
+  proxyAddress: string,
+): Promise<string | undefined> {
+  try {
+    return await getImplementationAddress(provider, proxyAddress);
+  } catch (e: any) {
+    if (e instanceof EIP1967ImplementationNotFound) {
+      try {
+        const beaconAddress = await getBeaconAddress(provider, proxyAddress);
+        return await getImplementationAddressFromBeacon(provider, beaconAddress);
+      } catch (e: any) {
+        if (e instanceof EIP1967BeaconNotFound) {
+          return undefined;
+        } else {
+          throw e;
+        }
+      }
+    } else {
+      throw e;
+    }
+  }
+}

package/src/impl-store.ts

@@ -3,6 +3,7 @@ import { Manifest, ManifestData, ImplDeployment } from './manifest';
 import { EthereumProvider, isDevelopmentNetwork } from './provider';
 import { Deployment, InvalidDeployment, resumeOrDeploy, waitAndValidateDeployment } from './deployment';
 import type { Version } from './version';
+import assert from 'assert';
 
 interface ManifestLens<T> {
   description: string;
@@ -46,6 +47,7 @@ async function fetchOrDeployGeneric<T extends Deployment>(
     // If we run into a deployment error, we remove it from the manifest.
     if (e instanceof InvalidDeployment) {
       await manifest.lockedRun(async () => {
+        assert(e instanceof InvalidDeployment); // Not sure why this is needed but otherwise doesn't type
         const data = await manifest.read();
         const deployment = lens(data);
         const stored = deployment.get();

package/src/index.ts

@@ -9,10 +9,27 @@ export * from './src-decoder';
 export * from './solc-api';
 export * from './deployment';
 export * from './link-refs';
+export * from './error';
 
 export { getStorageLayoutForAddress } from './manifest-storage-layout';
 
 export * from './scripts/migrate-oz-cli-project';
 
 export { logWarning } from './utils/log';
-export { setProxyKind } from './set-proxy-kind';
+export { setProxyKind, processProxyKind } from './proxy-kind';
+
+export { UpgradeableContract } from './standalone';
+
+export { isTransparentOrUUPSProxy, isBeaconProxy } from './eip-1967-type';
+export { getImplementationAddressFromBeacon, getImplementationAddressFromProxy } from './impl-address';
+export { isBeacon } from './beacon';
+
+export {
+  BeaconProxyUnsupportedError,
+  LoadProxyUnsupportedError,
+  PrepareUpgradeUnsupportedError,
+  DeployBeaconProxyUnsupportedError,
+  DeployBeaconProxyImplUnknownError,
+  DeployBeaconProxyKindError,
+  assertNotProxy,
+} from './usage-error';

package/src/manifest.ts

@@ -25,7 +25,7 @@ export interface ImplDeployment extends Deployment {
 }
 
 export interface ProxyDeployment extends Deployment {
-  kind: 'uups' | 'transparent';
+  kind: 'uups' | 'transparent' | 'beacon';
 }
 
 function defaultManifest(): ManifestData {
@@ -90,7 +90,7 @@ export class Manifest {
     try {
       const data = JSON.parse(await fs.readFile(this.file, 'utf8')) as ManifestData;
       return validateOrUpdateManifestVersion(data);
-    } catch (e) {
+    } catch (e: any) {
       if (e.code === 'ENOENT') {
         return defaultManifest();
       } else {

package/src/provider.ts

@@ -5,6 +5,7 @@ export interface EthereumProvider {
   send(method: 'net_version', params: []): Promise<string>;
   send(method: 'eth_chainId', params: []): Promise<string>;
   send(method: 'eth_getCode', params: [string, string]): Promise<string>;
+  send(method: 'eth_call', params: unknown[]): Promise<string>;
   send(method: 'eth_getStorageAt', params: [string, string, string]): Promise<string>;
   send(method: 'eth_getTransactionByHash', params: [string]): Promise<null | EthereumTransaction>;
   send(method: 'eth_getTransactionReceipt', params: [string]): Promise<null | EthereumTransactionReceipt>;
@@ -53,6 +54,21 @@ export async function getCode(provider: EthereumProvider, address: string, block
   return provider.send('eth_getCode', [address, block]);
 }
 
+export async function call(
+  provider: EthereumProvider,
+  address: string,
+  data: string,
+  block = 'latest',
+): Promise<string> {
+  return provider.send('eth_call', [
+    {
+      to: address,
+      data: data,
+    },
+    block,
+  ]);
+}
+
 export async function hasCode(provider: EthereumProvider, address: string, block?: string): Promise<boolean> {
   const code = await getCode(provider, address, block);
   return code !== '0x';

package/src/proxy-kind.ts

@@ -0,0 +1,59 @@
+import { EthereumProvider } from './provider';
+import { inferProxyKind, ValidationData, ValidationOptions } from './validate';
+import { Manifest, DeploymentNotFound, ProxyDeployment } from './manifest';
+import { isBeaconProxy } from './eip-1967-type';
+import { Version } from './version';
+import { BeaconProxyUnsupportedError } from './usage-error';
+
+export async function setProxyKind(
+  provider: EthereumProvider,
+  proxyAddress: string,
+  opts: ValidationOptions,
+): Promise<ProxyDeployment['kind']> {
+  const manifest = await Manifest.forNetwork(provider);
+
+  const manifestDeployment = await manifest.getProxyFromAddress(proxyAddress).catch(e => {
+    if (e instanceof DeploymentNotFound) {
+      return undefined;
+    } else {
+      throw e;
+    }
+  });
+
+  if (opts.kind === undefined) {
+    opts.kind = manifestDeployment?.kind ?? 'transparent';
+  } else if (manifestDeployment && opts.kind !== manifestDeployment.kind) {
+    throw new Error(`Requested an upgrade of kind ${opts.kind} but proxy is ${manifestDeployment.kind}`);
+  }
+
+  return opts.kind;
+}
+
+/**
+ * Processes opts.kind when deploying the implementation for a UUPS or Transparent proxy.
+ *
+ * @throws {BeaconProxyUnsupportedError} If this function is called for a Beacon proxy.
+ */
+export async function processProxyKind(
+  provider: EthereumProvider,
+  proxyAddress: string | undefined,
+  opts: ValidationOptions,
+  data: ValidationData,
+  version: Version,
+) {
+  if (opts.kind === undefined) {
+    if (proxyAddress !== undefined && (await isBeaconProxy(provider, proxyAddress))) {
+      opts.kind = 'beacon';
+    } else {
+      opts.kind = inferProxyKind(data, version);
+    }
+  }
+
+  if (proxyAddress !== undefined) {
+    await setProxyKind(provider, proxyAddress, opts);
+  }
+
+  if (opts.kind === 'beacon') {
+    throw new BeaconProxyUnsupportedError();
+  }
+}

package/src/src-decoder.test.ts

@@ -1,5 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
 import test from 'ava';
 
 import { SolcInput, SolcOutput } from './solc-api';

package/src/standalone.test.ts

@@ -0,0 +1,40 @@
+import _test, { TestInterface } from 'ava';
+import { artifacts } from 'hardhat';
+
+import { SolcInput, SolcOutput } from './solc-api';
+import { UpgradeableContract } from './standalone';
+
+interface Context {
+  solcInput: SolcInput;
+  solcOutput: SolcOutput;
+}
+
+const test = _test as TestInterface<Context>;
+
+test.before(async t => {
+  const buildInfo = await artifacts.getBuildInfo('contracts/test/Standalone.sol:StandaloneV1');
+  if (buildInfo === undefined) {
+    throw new Error('Build info not found');
+  }
+  t.context.solcInput = buildInfo.input;
+  t.context.solcOutput = buildInfo.output;
+});
+
+test('reports unsafe operation', t => {
+  const impl = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput);
+  const report = impl.getErrorReport();
+  t.false(report.ok);
+  t.true(report.errors[0].kind === 'delegatecall');
+});
+
+test('reports storage upgrade errors', t => {
+  const v1 = new UpgradeableContract('StandaloneV1', t.context.solcInput, t.context.solcOutput);
+
+  const v2Good = new UpgradeableContract('StandaloneV2Good', t.context.solcInput, t.context.solcOutput);
+  const goodReport = v1.getStorageUpgradeReport(v2Good);
+  t.true(goodReport.ok);
+
+  const v2Bad = new UpgradeableContract('StandaloneV2Bad', t.context.solcInput, t.context.solcOutput);
+  const badReport = v1.getStorageUpgradeReport(v2Bad);
+  t.false(badReport.ok);
+});

package/src/standalone.ts

@@ -0,0 +1,41 @@
+import { SolcOutput, SolcInput } from './solc-api';
+import { solcInputOutputDecoder } from './src-decoder';
+import {
+  getContractVersion,
+  getErrors,
+  getStorageLayout,
+  UpgradeableContractErrorReport,
+  validate,
+  ValidationOptions,
+  withValidationDefaults,
+} from './validate';
+import { getStorageUpgradeReport, StorageLayout } from './storage';
+import { Version } from './version';
+import { ValidationError } from './validate/run';
+
+export interface Report {
+  ok: boolean;
+  explain(color?: boolean): string;
+}
+
+export class UpgradeableContract {
+  readonly version: Version;
+  readonly errors: ValidationError[];
+  readonly layout: StorageLayout;
+
+  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);
+    this.errors = getErrors(validation, this.version, opts);
+    this.layout = getStorageLayout(validation, this.version);
+  }
+
+  getErrorReport() {
+    return new UpgradeableContractErrorReport(this.errors);
+  }
+
+  getStorageUpgradeReport(newVersion: UpgradeableContract, opts: ValidationOptions = {}) {
+    return getStorageUpgradeReport(this.layout, newVersion.layout, withValidationDefaults(opts));
+  }
+}

package/src/storage/index.ts

@@ -1,13 +1,11 @@
-import chalk from 'chalk';
-
 export * from './compat';
 
 import { UpgradesError } from '../error';
 import { StorageLayout, getDetailedLayout } from './layout';
 import { StorageOperation, StorageItem, StorageLayoutComparator } from './compare';
 import { LayoutCompatibilityReport } from './report';
-import { ValidationOptions, isSilencingWarnings, withValidationDefaults } from '../validate/overrides';
-import { logWarning } from '../utils/log';
+import { ValidationOptions, withValidationDefaults } from '../validate/overrides';
+import { logNote, logWarning } from '../utils/log';
 
 export function assertStorageUpgradeSafe(
   original: StorageLayout,
@@ -31,31 +29,36 @@ export function assertStorageUpgradeSafe(
     opts = withValidationDefaults({ unsafeAllowCustomTypes });
   }
 
+  const report = getStorageUpgradeReport(original, updated, opts);
+
+  if (!report.pass) {
+    throw new StorageUpgradeErrors(report);
+  }
+}
+
+export function getStorageUpgradeReport(
+  original: StorageLayout,
+  updated: StorageLayout,
+  opts: Required<ValidationOptions>,
+): LayoutCompatibilityReport {
   const originalDetailed = getDetailedLayout(original);
   const updatedDetailed = getDetailedLayout(updated);
   const comparator = new StorageLayoutComparator(opts.unsafeAllowCustomTypes, opts.unsafeAllowRenames);
   const report = comparator.compareLayouts(originalDetailed, updatedDetailed);
 
-  if (!isSilencingWarnings()) {
-    if (comparator.hasAllowedUncheckedCustomTypes) {
-      logWarning(`Potentially unsafe deployment`, [
-        `You are using \`unsafeAllowCustomTypes\` to force approve structs or enums with missing data.`,
-        `Make sure you have manually checked the storage layout for incompatibilities.`,
-      ]);
-    } else if (opts.unsafeAllowCustomTypes) {
-      console.error(
-        chalk.yellow.bold('Note:') +
-          ` \`unsafeAllowCustomTypes\` is no longer necessary. Structs are enums are automatically checked.\n`,
-      );
-    }
+  if (comparator.hasAllowedUncheckedCustomTypes) {
+    logWarning(`Potentially unsafe deployment`, [
+      `You are using \`unsafeAllowCustomTypes\` to force approve structs or enums with missing data.`,
+      `Make sure you have manually checked the storage layout for incompatibilities.`,
+    ]);
+  } else if (opts.unsafeAllowCustomTypes) {
+    logNote(`\`unsafeAllowCustomTypes\` is no longer necessary. Structs are enums are automatically checked.\n`);
   }
 
-  if (!report.pass) {
-    throw new StorageUpgradeErrors(report);
-  }
+  return report;
 }
 
-class StorageUpgradeErrors extends UpgradesError {
+export class StorageUpgradeErrors extends UpgradesError {
   constructor(readonly report: LayoutCompatibilityReport) {
     super(`New storage layout is incompatible`, () => report.explain());
   }

package/src/storage/report.ts

@@ -1,4 +1,4 @@
-import chalk from 'chalk';
+import _chalk from 'chalk';
 
 import type { BasicOperation } from '../levenshtein';
 import type { ParsedTypeDetailed } from './layout';
@@ -8,13 +8,18 @@ import { indent } from '../utils/indent';
 import { assert } from '../utils/assert';
 
 export class LayoutCompatibilityReport {
-  readonly pass: boolean;
+  constructor(readonly ops: StorageOperation<StorageItem>[]) {}
 
-  constructor(readonly ops: StorageOperation<StorageItem>[]) {
-    this.pass = ops.length === 0;
+  get ok(): boolean {
+    return this.pass;
   }
 
-  explain(): string {
+  get pass(): boolean {
+    return this.ops.length === 0;
+  }
+
+  explain(color = true): string {
+    const chalk = new _chalk.Instance({ level: color && _chalk.supportsColor ? _chalk.supportsColor.level : 0 });
     const res = [];
 
     for (const op of this.ops) {