@openzeppelin/upgrades-core 1.10.0 → 1.11.0

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/index.ts

@@ -9,12 +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 {

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/usage-error.ts

@@ -0,0 +1,68 @@
+import { EthereumProvider, getBeaconAddress, isBeaconProxy, isTransparentOrUUPSProxy, UpgradesError } from '.';
+
+export class BeaconProxyUnsupportedError extends UpgradesError {
+  constructor() {
+    super(
+      'Beacon proxies are not supported with the current function.',
+      () => 'Use deployBeacon(), deployBeaconProxy(), or upgradeBeacon() instead.',
+    );
+  }
+}
+
+export class DeployBeaconProxyKindError extends UpgradesError {
+  constructor(kind: string) {
+    super(
+      `Unsupported proxy kind '${kind}'`,
+      () => `deployBeaconProxy() is only supported with proxy kind undefined or 'beacon'`,
+    );
+  }
+}
+
+export class DeployBeaconProxyUnsupportedError extends UpgradesError {
+  constructor(beaconAddress: string) {
+    super(`Contract at ${beaconAddress} doesn't look like a beacon`, () => 'Deploy a beacon using deployBeacon().');
+  }
+}
+
+export class DeployBeaconProxyImplUnknownError extends UpgradesError {
+  constructor(implAddress: string) {
+    super(
+      `Beacon's current implementation at ${implAddress} is unknown`,
+      () => `Call deployBeaconProxy() with the implementation option providing the beacon's current implementation.`,
+    );
+  }
+}
+
+export class LoadProxyUnsupportedError extends UpgradesError {
+  constructor(proxyAddress: string) {
+    super(
+      `Contract at ${proxyAddress} doesn't look like a supported proxy`,
+      () => 'Only transparent, UUPS, or beacon proxies can be loaded with the loadProxy() function.',
+    );
+  }
+}
+
+export class PrepareUpgradeUnsupportedError extends UpgradesError {
+  constructor(proxyOrBeaconAddress: string) {
+    super(
+      `Contract at address ${proxyOrBeaconAddress} doesn't look like a supported proxy or beacon`,
+      () => `Only transparent, UUPS, or beacon proxies or beacons can be used with the prepareUpgrade() function.`,
+    );
+  }
+}
+
+export async function assertNotProxy(provider: EthereumProvider, address: string) {
+  if (await isTransparentOrUUPSProxy(provider, address)) {
+    throw new UpgradesError(
+      'Address is a transparent or UUPS proxy which cannot be upgraded using upgradeBeacon().',
+      () => 'Use upgradeProxy() instead.',
+    );
+  } else if (await isBeaconProxy(provider, address)) {
+    const beaconAddress = await getBeaconAddress(provider, address);
+    throw new UpgradesError(
+      'Address is a beacon proxy which cannot be upgraded directly.',
+      () =>
+        `upgradeBeacon() must be called with a beacon address, not a beacon proxy address. Call upgradeBeacon() on the beacon address ${beaconAddress} instead.`,
+    );
+  }
+}

package/src/utils/address.ts

@@ -0,0 +1,16 @@
+import { toChecksumAddress } from 'ethereumjs-util';
+
+/**
+ * Parses an address from a hex string which may come from storage or a returned address via eth_call.
+ *
+ * @param addressString The address hex string.
+ * @returns The parsed checksum address, or undefined if the input string is not an address.
+ */
+export function parseAddress(addressString: string): string | undefined {
+  const buf = Buffer.from(addressString.replace(/^0x/, ''), 'hex');
+  if (!buf.slice(0, 12).equals(Buffer.alloc(12, 0))) {
+    return undefined;
+  }
+  const address = '0x' + buf.toString('hex', 12, 32); // grab the last 20 bytes
+  return toChecksumAddress(address);
+}

package/src/validate/overrides.ts

@@ -69,7 +69,7 @@ export function processExceptions(
 ): ValidationError[] {
   const { unsafeAllow } = withValidationDefaults(opts);
 
-  if (opts.kind === 'transparent') {
+  if (opts.kind === 'transparent' || opts.kind === 'beacon') {
     errors = errors.filter(error => error.kind !== 'missing-public-upgradeto');
   }
 

package/CHANGELOG.md

@@ -1,120 +0,0 @@
-# Changelog
-
-## 1.10.0 (2021-10-22)
-
-- Infer whether a proxy should be UUPS or Transparent. ([#441](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/441))
-- Add a standalone interface to the core. ([#442](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/442))
-- Add implementation constructor arguments to initialize immutable variables. ([#433](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/433))
-
-## 1.9.2 (2021-09-17)
-
-- Fix a bug where libraries used transitively were not considered for safety checks.
-
-## 1.9.1 (2021-09-15)
-
-- Silence all warnings when using `silenceWarnings`.
-
-## 1.9.0 (2021-08-25)
-
-- Add `getBeaconAddress`. ([#413](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/413))
-
-## 1.8.1 (2021-08-06)
-
-- Add support for function types.
-
-## 1.8.0 (2021-06-29)
-
-- Add option `unsafeAllowRenames` to configure storage layout check to allow variable renaming.
-
-## 1.7.6 (2021-05-25)
-
-- Fix recognition of value types in storage layouts.
-
-## 1.7.5 (2021-05-22)
-
-- Fix exception when upgrading mapping key to enum.
-
-## 1.7.4 (2021-05-22)
-
-- Fix handling of functions with struct or mapping storage pointer arguments.
-
-## 1.7.3 (2021-05-13)
-
-- Simplify clean up of manifest data before storing to disk.
-
-## 1.7.2 (2021-05-13)
-
-- Fix bug when the project uses external libraries.
-
-## 1.7.1 (2021-05-03)
-
-- Use `web3_clientVersion` to better detect development networks.
-
-## 1.7.0 (2021-04-29)
-
-- Add support for UUPS proxies. ([#315](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/315))
-- Fix parsing of NatSpec `@custom:oz-upgrades-unsafe-allow` when included in a `/**`-style comment.
-
-## 1.6.0 (2021-04-14)
-- Add `unsafeAllow` as a new field in `ValidationOptions`, which can be used as a manual override to silence any type of validation error. For example, `opts = { unsafeAllow: ['external-library-linking', 'delegatecall'] }` will silence the corresponding checks. ([#320](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/320))
-- Custom NatSpec comments can disable error checks directly from the Solidity code. See `core/contracts/test/ValidationNatspec.sol` for example usage of these NatSpec comments. Note: this requires Solidity >=0.8.2. ([#320](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/320))
-- Fix a bug with library placeholders when hashing contract source code. ([#320](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/320))
-
-## 1.5.1 (2021-02-24)
-
-- Add support for enum keys in mappings. ([#301](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/301))
-
-## 1.5.0 (2021-01-27)
-
-- Add support for structs and enums. ([#261](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/261))
-- Enable optimizations when compiling proxies.
-
-## 1.4.4 (2021-01-14)
-
-- Fix `InvalidDeployment` error on some networks. ([#282](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/282))
-
-## 1.4.3 (2020-12-21)
-
-- Fix a type error caused by duplicate contract names in Truffle.
-
-## 1.4.2 (2020-12-16)
-
-- Fix an error in the `unsafeAllowCustomTypes` flag that would cause other storage layout incompatibilities to be ignored. ([#259](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/259))
-
-Users of this flag are advised to update to this version.
-
-## 1.4.1 (2020-11-30)
-
-- Fix a problem in deployment logic when used with Hyperledger Besu. ([#244](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/244))
-
-## 1.4.0 (2020-11-24)
-
-- Add `silenceWarnings` to emit a single warning and silence all subsequent ones. ([#228](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/228))
-
-## 1.3.1 (2020-11-13)
-
-- Add missing artifact files in the package.
-
-## 1.3.0 (2020-11-13)
-
-- Support Hardhat. ([#214](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/214))
-
-## 1.2.0 (2020-10-16)
-
-- Support new flag `unsafeAllowLinkedLibraries` to allow deployment of contracts with linked libraries. ([#182](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/182))
-
-## 1.1.1 (2020-10-08)
-
-- Fix OpenZeppelin CLI migration for projects that were initialized with ZeppelinOS. ([#193](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/193))
-
-## 1.1.0 (2020-09-18)
-
-- Add ability to migrate from OpenZeppelin CLI. ([#143](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/143))
-
-## 1.0.2 (2020-09-16)
-
-- Fix false positive variable initialization check in Solidity 0.7.1. ([#171](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/171))
-
-## 1.0.1 (2020-09-01)
-
-- Include `src` directory in npm packages. ([#150](https://github.com/OpenZeppelin/openzeppelin-upgrades/pull/150))

package/dist/set-proxy-kind.d.ts

@@ -1,5 +0,0 @@
-import { EthereumProvider } from './provider';
-import { ValidationOptions } from './validate';
-import { ProxyDeployment } from './manifest';
-export declare function setProxyKind(provider: EthereumProvider, proxyAddress: string, opts: ValidationOptions): Promise<ProxyDeployment['kind']>;
-//# sourceMappingURL=set-proxy-kind.d.ts.map

package/dist/set-proxy-kind.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"set-proxy-kind.d.ts","sourceRoot":"","sources":["../src/set-proxy-kind.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,EAAgC,eAAe,EAAE,MAAM,YAAY,CAAC;AAE3E,wBAAsB,YAAY,CAChC,QAAQ,EAAE,gBAAgB,EAC1B,YAAY,EAAE,MAAM,EACpB,IAAI,EAAE,iBAAiB,GACtB,OAAO,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,CAkBlC"}

package/dist/set-proxy-kind.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setProxyKind = void 0;
-const manifest_1 = require("./manifest");
-async function setProxyKind(provider, proxyAddress, opts) {
-    var _a;
-    const manifest = await manifest_1.Manifest.forNetwork(provider);
-    const manifestDeployment = await manifest.getProxyFromAddress(proxyAddress).catch(e => {
-        if (e instanceof manifest_1.DeploymentNotFound) {
-            return undefined;
-        }
-        else {
-            throw e;
-        }
-    });
-    if (opts.kind === undefined) {
-        opts.kind = (_a = manifestDeployment === null || manifestDeployment === void 0 ? void 0 : manifestDeployment.kind) !== null && _a !== void 0 ? _a : '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;
-}
-exports.setProxyKind = setProxyKind;
-//# sourceMappingURL=set-proxy-kind.js.map

package/dist/set-proxy-kind.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"set-proxy-kind.js","sourceRoot":"","sources":["../src/set-proxy-kind.ts"],"names":[],"mappings":";;;AAEA,yCAA2E;AAEpE,KAAK,UAAU,YAAY,CAChC,QAA0B,EAC1B,YAAoB,EACpB,IAAuB;;IAEvB,MAAM,QAAQ,GAAG,MAAM,mBAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAErD,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;QACpF,IAAI,CAAC,YAAY,6BAAkB,EAAE;YACnC,OAAO,SAAS,CAAC;SAClB;aAAM;YACL,MAAM,CAAC,CAAC;SACT;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;QAC3B,IAAI,CAAC,IAAI,GAAG,MAAA,kBAAkB,aAAlB,kBAAkB,uBAAlB,kBAAkB,CAAE,IAAI,mCAAI,aAAa,CAAC;KACvD;SAAM,IAAI,kBAAkB,IAAI,IAAI,CAAC,IAAI,KAAK,kBAAkB,CAAC,IAAI,EAAE;QACtE,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,CAAC,IAAI,iBAAiB,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAC;KACtG;IAED,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC;AAtBD,oCAsBC"}

package/src/set-proxy-kind.ts

@@ -1,27 +0,0 @@
-import { EthereumProvider } from './provider';
-import { ValidationOptions } from './validate';
-import { Manifest, DeploymentNotFound, ProxyDeployment } from './manifest';
-
-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;
-}