Expose implementation address in hardhat plugin

It would be nice for there to be a standardized way to get the address of a deployed implementation contract when working with the hardhat plugin.

Currently the user flow is:

  const Box = await ethers.getContractFactory("Box");
  const box = await upgrades.deployProxy(Box, [42]);
  await box.deployed();
  console.log("Box deployed to:", box.address);

But it would be nice to do something like this:

  const Box = await ethers.getContractFactory("Box");
  const box = await upgrades.deployProxy(Box, [42]);
  await box.deployed();
  console.log("Box deployed to:", box.address);
  const implementation = await upgrades.getImplementation(box);

  await run("verify", implementation.address") // Run the etherscan verification tkas

Currently a user must manually check the ./.openzeppelin/ folder and extract the contract address. Automating this process is made difficult by the fact that the implementations are stored in a map whose key is a hash. The method of obtaining this hash isn’t readily documented either.

[frangio]

Available in the latest release.

await upgrades.erc1967.getImplementationAddress(proxyAddress);

[Remscar]

Hi @abcoathup,

An example use case that I encountered needing is automating the etherscan verification of an implemented proxy when using hardhat.

I found a workaround, but it’s as you can probably see, less than ideal:

// Relevant OpenZeppelin imports
import {
  hashBytecodeWithoutMetadata,
  Manifest,
} from "@openzeppelin/upgrades-core";

// inside of user defined script

// deploy upgradable contract
const accounts = await ethers.getSigners();
const deploymentAccount = accounts[0];
const registrarFactory = new Registrar__factory(deploymentAccount);
const instance = await upgrades.deployProxy(registrarFactory, [], {
  initializer: "initialize",
});
await instance.deployed();

// Peer into OpenZeppelin manifest to extract the implementation address
const ozUpgradesManifestClient = await Manifest.forNetwork(network.provider);
const manifest = await ozUpgradesManifestClient.read();
const bytecodeHash = hashBytecodeWithoutMetadata(registrarFactory.bytecode);
const implementationContract = manifest.impls[bytecodeHash];

// Verify implementation on etherscan
if (implementationContract) {
    logger.log(`Attempting to verify implementation contract with etherscan`);
    try {
      await run("verify:verify", {
        address: implementationContract.address,
        constructorArguments: [],
      });
    } catch (e) {
      logger.error(`Failed to verify contract: ${e}`);
    }
  }

Another user case that we needed it for is we have our own json format where we store all deployed contracts (proxy, implementation, proxyadmin) and we needed to fetch those from the manifest to load the json file.

I’m concerned those core functions will change, or the manifest format will change, so an official way to retrieve this data would be helpful.