Upgrades built-in

[PatrickAlphaC]

Overview

Provide a simple overview of what you wish to see added. Please include:

A built in API to feature Openzeppelin's upgradeable smart contracts. I'm thinking we could start with the transparent proxy. If it makes more sense for this to just be a mix first, I'm working on that too.

This will follow the Openzeppelin Proxy pattern heavily, ERC1967, and use the openzeppelin upgrade contracts.

Specification

Here's what I imagine that API look like:

from Brownie import ImplementationContract, accounts

def main():
    account = accounts[0]
    ImplementationContract.deployProxy(initializer="initializerFunction", 1, {"from": account})

Where deployProxy looks something like:

def deployProxy(initializer=None, *args):
    # pseudocode
    implementation = depolyImplementation()
    if initializer:
        call_initializer(*args)
    proxy = depolyProxy(implementation=implementation)
    admin = deployProxyAdmin()
    proxy.set_admin(admin)

And then we can call the upgrade like:

ImplementationContract.upgrade(new_implementation)

Or something of the like.

Dependencies

In your brownie-config.yaml

dependencies:
  - OpenZeppelin/openzeppelin-contracts@4.1.0
compiler:
  solc:
    remappings:
      - '@openzeppelin=OpenZeppelin/openzeppelin-contracts@4.1.0'

[PatrickAlphaC]

Inspiration from the openzeppelin plugins for truffle and hardhat: https://github.com/OpenZeppelin/openzeppelin-upgrades

Maybe we could even do something where this is a plugin for brownie.

[jee-liqing]

looking forward for this update!!

[PatrickAlphaC]

For now, you can check out the upgrades mix I worked on https://github.com/PatrickAlphaC/upgrades-mix

[jee-liqing]

wow！