baseline icon indicating copy to clipboard operation
baseline copied to clipboard

Published 20 hours ago • verified publisher icon ethereum-oasis-op

Implement EIP-2535 to make workgroup shield contract upgradeable

Open kthomas opened this issue 4 years ago • 3 comments

Overview

The "Diamond Standard" (see EIP-2535) is a pattern for upgradable smart contracts. The workgroup shield contract should be refactored to implement EIP-255, with each workflow identifier becoming an upgradable facet.

Reference

Questions

  • How do existing workflows behave once they are upgraded?

Assumptions

Acceptance

Tasks

  • [ ] Spike the workgroup shield contract diamond pattern

kthomas avatar Nov 12 '20 22:11 kthomas

A couple of comments/thoughts/observations:

  • You need all contracts to be facets in the diamond pattern, not just the shield contract
  • You need the governance contract from the Diamond pattern to manage the upgrade process
  • Since during the upgrade process you need to suspend processing, you need a. a transaction queue b. a mechanism that pends transactions in the queue when the upgrade is initiated
  • You need a way to roll back an upgrade if a bug is found which would be most simply done through another upgrade process
  • You need to be able to inform the users of a planned upgrade and you need to inform users that a transaction is pending due to upgrade -- requires additional request response for transaction submission
  • Since you have shared storage e.g. workgroups etc. you need to utilize the diamond pattern where contracts share storage (separate contract instances for functional vs storage contracts)
  • Who or what will be authorized to make upgrades?

Therecanbeonlyone1969 avatar Dec 01 '20 19:12 Therecanbeonlyone1969

@Kasshern @skosito @Ybittan @biscuitdey This discussion might be relevant for our work on the SRI. Keeping it open so that we can discuss.

ognjenkurtic avatar Jul 28 '22 08:07 ognjenkurtic

Trail of Bits brought up significant security issues with EIP-2535, and the response.

More real-world use cases and a Consensys Diligence recommendation

Real-world use case and security analysis of that implementation.

Recent blog about EIP-2535 ... apparently 3 reference implementations by author have been security audited.

@ognjenkurtic @Kasshern @Ybittan @biscuitdey @kthomas

Therecanbeonlyone1969 avatar Sep 22 '22 18:09 Therecanbeonlyone1969

@Kasshern @skosito @Ybittan @biscuitdey This discussion might be relevant for our work on the SRI. Keeping it open so that we can discuss.

probably not so relevant for SRI to have these upgradable, but if we decide to make contracts upgradable since we will use hardhat anyways we can use proxy pattern built in hardhat https://docs.openzeppelin.com/upgrades-plugins/1.x/hardhat-upgrades

skosito avatar Oct 20 '22 14:10 skosito