Hardhat Upgrades

[Nlferu]

Hello,

I just wanted to see source code of hardhat upgrades to better understand what functions stands behind calling for example upgrades.admin or maybe get current proxy admin contract because I do not fully understand below codes:

async function main() {
    const proxyAddress = "FILL_ME_IN"
    const BoxV2 = await ethers.getContractFactory("BoxV2")
    console.log("Preparing upgrade...")
    // Extending Box contract with BoxV2 contract functions
    const boxV2Address = await upgrades.prepareUpgrade(proxyAddress, BoxV2)
    console.log("BoxV2 at:", boxV2Address)
}

async function main() {
    const gnosisSafe = "FILL_ME_IN"

    console.log("Transferring ownership of ProxyAdmin...")
    // The owner of the ProxyAdmin can upgrade our contracts
    // We are setting new admin
    await upgrades.admin.transferProxyAdminOwnership(gnosisSafe)
    console.log("Transferred ownership of ProxyAdmin to:", gnosisSafe)
}

First we are setting proxyAddress to "FILL_ME_IN" and then we are transfering ownership to same string and I have no idea why.

Could someone please explain above code to me and also pass link to hardhat upgrades source code so I can view such functions as transferProxyAdminOwnership?

Hardhat library is so big that I was unable to find it myself and ctrl+click in VsCode doesn't help with this... as it leads to nowhere like below and there is no upgrades script/code whatsoever

After getting into hardhat library we get:

import debug from "debug";

import { HardhatRuntimeEnvironment } from "../../types";
import { HardhatContext } from "../context";
import { loadConfigAndTasks } from "../core/config/config-loading";
import { HardhatError } from "../core/errors";
import { ERRORS } from "../core/errors-list";
import { getEnvHardhatArguments } from "../core/params/env-variables";
import { HARDHAT_PARAM_DEFINITIONS } from "../core/params/hardhat-params";
import { Environment } from "../core/runtime-environment";

let ctx: HardhatContext;
let env: HardhatRuntimeEnvironment;

if (HardhatContext.isCreated()) {
  ctx = HardhatContext.getHardhatContext();

  // The most probable reason for this to happen is that this file was imported
  // from the config file
  if (ctx.environment === undefined) {
    throw new HardhatError(ERRORS.GENERAL.LIB_IMPORTED_FROM_THE_CONFIG);
  }

  env = ctx.environment;
} else {
  ctx = HardhatContext.createHardhatContext();

  const hardhatArguments = getEnvHardhatArguments(
    HARDHAT_PARAM_DEFINITIONS,
    process.env
  );

  if (hardhatArguments.verbose) {
    debug.enable("hardhat*");
  }

  const { resolvedConfig, userConfig } = loadConfigAndTasks(hardhatArguments);

  env = new Environment(
    resolvedConfig,
    hardhatArguments,
    ctx.tasksDSL.getTaskDefinitions(),
    ctx.extendersManager.getExtenders(),
    ctx.experimentalHardhatNetworkMessageTraceHooks,
    userConfig
  );

  ctx.setHardhatRuntimeEnvironment(env);
}

export = env;

[alymurtazamemon]

@Neftyr You can find it here LINK

I think you got this code from the openzepplin tutorial on hardhat-upgrades, right? Here they are using the Gnosis Safe to upgrade the contract.

There they first create the V1 of the implementation contract and deploy using hardhat upgrades; example;

async function main() {
  const Box = await ethers.getContractFactory("Box");
  console.log("Deploying Box...");
  const box = await upgrades.deployProxy(Box, [42], { initializer: 'store' });
  console.log("Box deployed to:", box.address);
}

then they transfer the ownership of ProxyAdmin to Gnosis Safe, if you have read about this, you must know that using hardhat-upgrades only the owner of ProxyAdmin can upgrade the proxy implementation contract.

async function main() {
  const gnosisSafe = '0x1c14600daeca8852BA559CC8EdB1C383B8825906';
 
  console.log("Transferring ownership of ProxyAdmin...");
  // The owner of the ProxyAdmin can upgrade our contracts
  await upgrades.admin.transferProxyAdminOwnership(gnosisSafe);
  console.log("Transferred ownership of ProxyAdmin to:", gnosisSafe);
}

After that, they create a new implementation of Box contract name BoxV2 and just prepare the upgrade;

Note: Preparation is not actual upgrading the contract, it is just a way to get the implemenation address so the ProxyAdmin can perform the upgradability.

async function main() {
  const proxyAddress = '0xFF60fd044dDed0E40B813DC7CE11Bed2CCEa501F';
 
  const BoxV2 = await ethers.getContractFactory("BoxV2");
  console.log("Preparing upgrade...");
  const boxV2Address = await upgrades.prepareUpgrade(proxyAddress, BoxV2);
  console.log("BoxV2 at:", boxV2Address);
}

And in the next step using the UI they perform the upgradability using Gnosis Safe as admin.

[Nlferu]

Hi @alymurtazamemon

Thank you for above, I have ofc visited link you have sent problem is that I cannot find "upgrades" library specifically because if we are calling for example upgrades.admin I would like to see code for admin but I'm unable to find it in that repository. If you have any tips for searching specific keywords and their source code in given repository please let me know.

Also thank you for explanation. I wanted also see if there is function to get/check current Proxy Admin. Was it blank before calling transferProxyAdminOwnership? And also back to part first where can I find source code for function transferProxyAdminOwnership as I was unable to dig it from that huge upgrades repo.

[alymurtazamemon]

@Neftyr You can click on any of these functions and read their implementation code.

[Nlferu]

@alymurtazamemon

Yea I know about that feature and I'm using it often for solidity for example but for my JS code it doesn't work. Any idea why is that? When I'm ctrl+clicking on any function from imported code it doesn't get highlighted and do not show source as it does for solidity for example.

For below I'm able to go to "hardhat" or "ethers" only but I cannot for example check "prepareUpgrade" or "upgrades"

const { ethers, upgrades } = require("hardhat")

async function main() {
    const proxyAddress = "FILL_ME_IN"
    const BoxV2 = await ethers.getContractFactory("BoxV2")
    console.log("Preparing upgrade...")
    // Extending Box contract with BoxV2 contract functions
    const boxV2Address = await upgrades.prepareUpgrade(proxyAddress, BoxV2)
    console.log("BoxV2 at:", boxV2Address)
}

I can go whenever I want while my code is in TS, but it is not working for JS

[alymurtazamemon]

@Neftyr Yes, you are right, I just tried in one of the js projects but was not able to go. Not sure of the reason.

[Nlferu]

@alymurtazamemon

Ye its pretty annyoing because if you can check source code right away its very helpful. I think it is because we are not using keyword import in JS. I will try to get it from TS imports but if you can find any workaround for JS let me know :) I have also managed to find admin keyword source code in that upgrades repo. Thanks for help closing topic for now. Remember to let me know if you figure out how to turn on this feature of visiting code in JS :D

[Nlferu]

Hi @alymurtazamemon

I have figured out what was wrong with that jumping into source code not working. We need simply add below in our hardhat.config.js:

require("@openzeppelin/hardhat-upgrades")

After that we can ctrl+click everything we want from that library :)