Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Upgradeable contracts

Small library providing upgradeable smart contracts. You can have upgradeable contracts for reasonable price (about 1100 gas per call. it depends on data size). Dispatcher uses new returndatasize and returndatacopy opcodes. So it won't work in pre-byzantium network.

Disclaimer

Library has not been heavily tested. Use it on your own risk. Do it only if you understand how data is stored.

Basic Usage

  1. Deploy target contract (You can use Upgradeable as base contract, it has some useful functions)
  2. Deploy Dispatcher contract with address of the target as constructor argument.
  3. You can use dispatcher's address as static address even if you want to switch to other implementation in future.

Writing compatible contracts

  • The first storage slot in the contract will be used to store the address of the target contract
  • Additionally, when you upgrade a contract that has already stored data on the blockchain, you will need to be sure not to change the organization of your contract's storage. You can safely add new storage variables, but do not delete or re-order existing ones. It may also be risky to change the version of the Solidity compiler used, as there is no guarantee the storage layout will remain the same
  • Take a look at upgradeable.js to see some examples

Upgradeable overview

  • Upgradeable has some checks to ensure next version is compatible with previous.
  • See Upgradeable.verifyTargetState. It uses delegatecall to check if next contract version stores "target" storage variable in the same slot
  • Also, you'd better implement your own version of "verifyState" function. It can check if other storage variables are in the same slots. See Target for example. NotVerifyingTarget doesn't have this check. This leads to data corruption. See upgradeable.js "but it'll let upgrade if no check present" test
  • Implement checkAdmin function. Usually you can check if msg.sender is some address responsible for upgrading contracts

About

Upgradeable smart contracts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published