@openzeppelin/upgrades-core 1.9.1

package/dist/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":";;;;;;AAAA,qDAA4C;AAC5C,gDAAwB;AAQxB,SAAgB,UAAU,CAAC,QAAgB,EAAE,cAAuB;IAClE,IAAI,QAAQ,KAAK,EAAE,EAAE;QACnB,OAAO;YACL,YAAY,EAAE,YAAY,CAAC,QAAQ,CAAC;YACpC,eAAe,EAAE,2BAA2B,CAAC,QAAQ,CAAC;YACtD,qBAAqB,EAAE,2BAA2B,CAAC,cAAc,aAAd,cAAc,cAAd,cAAc,GAAI,QAAQ,CAAC;SAC/E,CAAC;KACH;SAAM;QACL,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;AACH,CAAC;AAVD,gCAUC;AAED,SAAgB,YAAY,CAAC,QAAgB;IAC3C,QAAQ,GAAG,QAAQ;SAChB,OAAO,CAAC,4BAA4B,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,EAAE,CAAC,MAAM,WAAW,KAAK,CAAC;SACjF,OAAO,CAAC,aAAa,EAAE,WAAW,CAAC,EAAE,CAAC,2BAAS,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IAErG,uEAAuE;IACvE,iEAAiE;IACjE,kFAAkF;IAClF,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;QACzC,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;KACvD;IAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;IAC5D,OAAO,2BAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AACxC,CAAC;AAdD,oCAcC;AAED,SAAgB,2BAA2B,CAAC,QAAgB;IAC1D,OAAO,YAAY,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;AACtD,CAAC;AAFD,kEAEC;AAED,SAAS,oBAAoB,CAAC,QAAgB;IAC5C,yBAAyB;IACzB,IAAI,QAAQ,CAAC,MAAM,IAAI,CAAC,EAAE;QACxB,OAAO,QAAQ,CAAC;KACjB;IAED,0DAA0D;IAC1D,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACtD,MAAM,cAAc,GAAG,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEnD,yCAAyC;IACzC,IAAI,cAAc,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;QACxC,OAAO,QAAQ,CAAC;KACjB;IAED,0EAA0E;IAC1E,MAAM,aAAa,GAAG,QAAQ,CAAC,MAAM,GAAG,cAAc,GAAG,CAAC,CAAC;IAC3D,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,aAAa,EAAE,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAEpE,iDAAiD;IACjD,IAAI;QACF,cAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC;KAC3C;IAAC,OAAO,GAAG,EAAE;QACZ,uCAAuC;QACvC,OAAO,QAAQ,CAAC;KACjB;IAED,6BAA6B;IAC7B,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC;AAC1C,CAAC"}

package/dist/version.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=version.test.d.ts.map

package/dist/version.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.test.d.ts","sourceRoot":"","sources":["../src/version.test.ts"],"names":[],"mappings":""}

package/dist/version.test.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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) => {
+    async function getBytecodeByContractName(contractName) {
+        const buildInfo = await hardhat_1.artifacts.getBuildInfo('contracts/test/Version.sol:Greeter');
+        if (buildInfo === undefined) {
+            throw new Error('Build info not found');
+        }
+        const solcOutput = buildInfo.output;
+        return solcOutput.contracts['contracts/test/Version.sol'][contractName].evm.bytecode.object;
+    }
+    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));
+});
+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}`));
+});
+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';
+    const swarmHashWrapper = `65627a7a72305820${swarmHash}`;
+    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}`));
+});
+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));
+});
+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));
+});
+//# sourceMappingURL=version.test.js.map

package/dist/version.test.js.map

@@ -0,0 +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"}

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@openzeppelin/upgrades-core",
+  "version": "1.9.1",
+  "description": "",
+  "repository": "https://github.com/OpenZeppelin/openzeppelin-upgrades/tree/master/packages/core",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "files": [
+    "/dist",
+    "/src",
+    "/artifacts/AdminUpgradeabilityProxy.json",
+    "/artifacts/ProxyAdmin.json",
+    "/artifacts/contracts/proxy/AdminUpgradeabilityProxy.sol/AdminUpgradeabilityProxy.json",
+    "/artifacts/contracts/proxy/ProxyAdmin.sol/ProxyAdmin.json",
+    "/contracts/Initializable.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",
+    "prepublishOnly": "bash scripts/copy-artifacts.sh",
+    "test": "tsc -b && hardhat compile --force && ava",
+    "test:watch": "hardhat compile --force && fgbg 'ava --watch' 'tsc -b --watch' --",
+    "version": "node ../../scripts/bump-changelog.js"
+  },
+  "devDependencies": {
+    "@ava/typescript": "^2.0.0",
+    "@nomiclabs/hardhat-ethers": "^2.0.2",
+    "@nomiclabs/hardhat-etherscan": "^2.1.0",
+    "@openzeppelin/contracts": "4.1.0",
+    "@types/bn.js": "^5.0.0",
+    "@types/cbor": "^5.0.0",
+    "@types/debug": "^4.1.5",
+    "@types/mocha": "^7.0.2",
+    "@types/node": "^10.17.26",
+    "@types/proper-lockfile": "^4.1.1",
+    "@types/rimraf": "^3.0.0",
+    "ava": "^3.9.0",
+    "dotenv": "^10.0.0",
+    "fgbg": "^0.1.4",
+    "hardhat": "^2.0.2",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.0.0"
+  },
+  "dependencies": {
+    "bn.js": "^5.1.2",
+    "cbor": "^8.0.0",
+    "chalk": "^4.1.0",
+    "compare-versions": "^3.6.0",
+    "debug": "^4.1.1",
+    "ethereumjs-util": "^7.0.3",
+    "proper-lockfile": "^4.1.1",
+    "solidity-ast": "^0.4.15"
+  }
+}

package/src/ast-dereferencer.ts

@@ -0,0 +1,42 @@
+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);
+}

package/src/deployment.test.ts

@@ -0,0 +1,98 @@
+import test from 'ava';
+import { promisify } from 'util';
+
+import { Deployment, resumeOrDeploy, waitAndValidateDeployment } from './deployment';
+import { stubProvider } from './stub-provider';
+
+const sleep = promisify(setTimeout);
+
+test('deploys new contract', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  t.true(provider.isContract(deployment.address));
+  t.is(provider.deployCount, 1);
+});
+
+test('resumes existing deployment with txHash', async t => {
+  const provider = stubProvider();
+  const first = await resumeOrDeploy(provider, undefined, provider.deployPending);
+  const second = await resumeOrDeploy(provider, first, provider.deployPending);
+  t.is(first, second);
+  t.is(provider.deployCount, 1);
+});
+
+test('resumes existing deployment without txHash', async t => {
+  const provider = stubProvider();
+  const first = await provider.deploy();
+  delete first.txHash;
+  const second = await resumeOrDeploy(provider, first, provider.deployPending);
+  t.is(first, second);
+  t.is(provider.deployCount, 1);
+});
+
+test('errors if tx is not found', async t => {
+  const provider = stubProvider();
+  const fakeDeployment: Deployment = {
+    address: '0x1aec6468218510f19bb19f52c4767996895ce711',
+    txHash: '0xc48e21ac9c051922f5ccf1b47b62000f567ef9bbc108d274848b44351a6872cb',
+  };
+  await t.throwsAsync(resumeOrDeploy(provider, fakeDeployment, provider.deploy));
+});
+
+test('redeploys if tx is not found on dev network', async t => {
+  // 31337 = Hardhat Network chainId
+  const provider = stubProvider(31337, 'HardhatNetwork/2.2.1/@ethereumjs/vm/5.3.2');
+  const fakeDeployment: Deployment = {
+    address: '0x1aec6468218510f19bb19f52c4767996895ce711',
+    txHash: '0xc48e21ac9c051922f5ccf1b47b62000f567ef9bbc108d274848b44351a6872cb',
+  };
+  const deployment = await resumeOrDeploy(provider, fakeDeployment, provider.deploy);
+  t.true(provider.isContract(deployment.address));
+  t.is(provider.deployCount, 1);
+});
+
+test('validates a mined deployment with txHash', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  await waitAndValidateDeployment(provider, deployment);
+  t.is(provider.getMethodCount('eth_getTransactionReceipt'), 1);
+  t.is(provider.getMethodCount('eth_getCode'), 1);
+});
+
+test('validates a mined deployment without txHash', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  delete deployment.txHash;
+  await waitAndValidateDeployment(provider, deployment);
+  t.is(provider.getMethodCount('eth_getTransactionReceipt'), 0);
+  t.is(provider.getMethodCount('eth_getCode'), 1);
+});
+
+test('waits for a deployment to mine', async t => {
+  const timeout = Symbol('timeout');
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deployPending);
+  const result = await Promise.race([waitAndValidateDeployment(provider, deployment), sleep(100).then(() => timeout)]);
+  t.is(result, timeout);
+  provider.mine();
+  await waitAndValidateDeployment(provider, deployment);
+});
+
+test('fails deployment fast if tx reverts', async t => {
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+  provider.failTx(deployment.txHash!);
+  await t.throwsAsync(waitAndValidateDeployment(provider, deployment));
+});
+
+test('waits for a deployment to return contract code', async t => {
+  const timeout = Symbol('timeout');
+  const provider = stubProvider();
+  const deployment = await resumeOrDeploy(provider, undefined, provider.deploy);
+  provider.removeContract(deployment.address);
+  const result = await Promise.race([waitAndValidateDeployment(provider, deployment), sleep(100).then(() => timeout)]);
+  t.is(result, timeout);
+  provider.addContract(deployment.address);
+  await waitAndValidateDeployment(provider, deployment);
+});

package/src/deployment.ts

@@ -0,0 +1,122 @@
+import { promisify } from 'util';
+
+import debug from './utils/debug';
+import { makeNonEnumerable } from './utils/make-non-enumerable';
+import {
+  EthereumProvider,
+  getTransactionByHash,
+  getTransactionReceipt,
+  hasCode,
+  isDevelopmentNetwork,
+  isReceiptSuccessful,
+} from './provider';
+
+const sleep = promisify(setTimeout);
+
+export interface Deployment {
+  address: string;
+  txHash?: string;
+}
+
+export async function resumeOrDeploy<T extends Deployment>(
+  provider: EthereumProvider,
+  cached: T | undefined,
+  deploy: () => Promise<T>,
+): Promise<T> {
+  if (cached !== undefined) {
+    const { txHash } = cached;
+    if (txHash === undefined) {
+      // Nothing to do here without a txHash.
+      // This is the case for deployments migrated from OpenZeppelin CLI.
+      return cached;
+    }
+    // If there is a deployment with txHash stored, we look its transaction up. If the
+    // transaction is found, the deployment is reused.
+    debug('found previous deployment', txHash);
+    const tx = await getTransactionByHash(provider, txHash);
+    if (tx !== null) {
+      debug('resuming previous deployment', txHash);
+      return cached;
+    } else if (!(await isDevelopmentNetwork(provider))) {
+      // If the transaction is not found we throw an error, except if we're in
+      // a development network then we simply silently redeploy.
+      throw new InvalidDeployment(cached);
+    } else {
+      debug('ignoring invalid deployment in development network', txHash);
+    }
+  }
+
+  const deployment = await deploy();
+  debug('initiated deployment', deployment.txHash);
+  return deployment;
+}
+
+export async function waitAndValidateDeployment(provider: EthereumProvider, deployment: Deployment): Promise<void> {
+  const { txHash, address } = deployment;
+
+  // Poll for 60 seconds with a 5 second poll interval.
+  // TODO: Make these parameters configurable.
+  const pollTimeout = 60e3;
+  const pollInterval = 5e3;
+
+  if (txHash !== undefined) {
+    const startTime = Date.now();
+
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+      const elapsedTime = Date.now() - startTime;
+      if (elapsedTime >= pollTimeout) {
+        // A timeout is NOT an InvalidDeployment
+        throw new TransactionMinedTimeout(deployment);
+      }
+      debug('verifying deployment tx mined', txHash);
+      const receipt = await getTransactionReceipt(provider, txHash);
+      if (receipt && isReceiptSuccessful(receipt)) {
+        debug('succeeded verifying deployment tx mined', txHash);
+        break;
+      } else if (receipt) {
+        debug('tx was reverted', txHash);
+        throw new InvalidDeployment(deployment);
+      } else {
+        debug('waiting for deployment tx mined', txHash);
+        await sleep(pollInterval);
+      }
+    }
+  }
+
+  debug('verifying code in target address', address);
+  const startTime = Date.now();
+  while (!(await hasCode(provider, address))) {
+    const elapsedTime = Date.now() - startTime;
+    if (elapsedTime >= pollTimeout || txHash === undefined) {
+      throw new InvalidDeployment(deployment);
+    }
+    await sleep(pollInterval);
+  }
+  debug('code in target address found', address);
+}
+
+export class TransactionMinedTimeout extends Error {
+  constructor(readonly deployment: Deployment) {
+    super(`Timed out waiting for transaction ${deployment.txHash}`);
+  }
+}
+
+export class InvalidDeployment extends Error {
+  removed = false;
+
+  constructor(readonly deployment: Deployment) {
+    super();
+    // This hides the properties from the error when it's printed.
+    makeNonEnumerable(this, 'removed');
+    makeNonEnumerable(this, 'deployment');
+  }
+
+  get message(): string {
+    let msg = `No contract at address ${this.deployment.address}`;
+    if (this.removed) {
+      msg += ' (Removed from manifest)';
+    }
+    return msg;
+  }
+}

package/src/eip-1967.ts

@@ -0,0 +1,77 @@
+import { toChecksumAddress, keccak256 } from 'ethereumjs-util';
+import BN from 'bn.js';
+
+import { EthereumProvider, getStorageAt } from './provider';
+
+export async function getAdminAddress(provider: EthereumProvider, address: string): Promise<string> {
+  const storage = await getStorageFallback(
+    provider,
+    address,
+    toEip1967Hash('eip1967.proxy.admin'),
+    toFallbackEip1967Hash('org.zeppelinos.proxy.admin'),
+  );
+
+  return parseAddress(storage);
+}
+
+export async function getImplementationAddress(provider: EthereumProvider, address: string): Promise<string> {
+  const storage = await getStorageFallback(
+    provider,
+    address,
+    toEip1967Hash('eip1967.proxy.implementation'),
+    toFallbackEip1967Hash('org.zeppelinos.proxy.implementation'),
+  );
+
+  if (isEmptySlot(storage)) {
+    throw new Error(`Contract at ${address} doesn't look like an administered ERC 1967 proxy`);
+  }
+
+  return parseAddress(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`);
+  }
+
+  return parseAddress(storage);
+}
+
+async function getStorageFallback(provider: EthereumProvider, address: string, ...slots: string[]): Promise<string> {
+  let storage = '0x0000000000000000000000000000000000000000000000000000000000000000'; // default: empty slot
+
+  for (const slot of slots) {
+    storage = await getStorageAt(provider, address, slot);
+    if (!isEmptySlot(storage)) {
+      break;
+    }
+  }
+
+  return storage;
+}
+
+export function toFallbackEip1967Hash(label: string): string {
+  return '0x' + keccak256(Buffer.from(label)).toString('hex');
+}
+
+export function toEip1967Hash(label: string): string {
+  const hash = keccak256(Buffer.from(label));
+  const bigNumber = new BN(hash).sub(new BN(1));
+  return '0x' + bigNumber.toString(16);
+}
+
+function isEmptySlot(storage: string): boolean {
+  storage = storage.replace(/^0x/, '');
+  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))) {
+    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);
+}