第3回 SolidityのUpgradeabilityとOpenZeppelinSDKとは

3.OpenZeppelinSDKの基本

はじめに

OpenZeppelinSDKとは

OpenZeppelinSDKの導入

実行環境

インストール

$ mkdir project1115 && cd project1115
project1115$ npm init

project1115$ npm install --global @openzeppelin/cli

project1115$ oz init

? Welcome to the OpenZeppelin SDK! Choose a name for your project project1115
? Initial project version 1.0.0
? Would you like to contribute anonymous usage data to help us improve the OpenZeppelin CLI? Learn more at https://zpl.in
/telemetry Yes
Project initialized. Write a new contract in the contracts folder and run 'openzeppelin create' to deploy it.

簡単なコントラクトをアップグレードする

pragma solidity ^0.5.0;

contract Counter {
  uint256 public value;

  function increase() public {
    value++;
  }
}

project1115$ oz compile
✓ Compiled contracts with solc 0.5.13 (commit.5b0b510c)

project1115$ ganache-cli
You can improve web3's peformance when running Node.js versions older than 10.5.0 by installing the (deprecated) scrypt package in your project
Ganache CLI v6.7.0 (ganache-core: 2.8.0)

Available Accounts
==================
(0) 0x9C27ed188B55fA57a3f2ADD432E37747E0CF550F (100 ETH)
(1) 0x41687D9E3a13fa38BBf627d33D3b23B12540f6E4 (100 ETH)
(2) 0x5dcfB34EfDA0fccfC2d62668244a7DeD7b96f1A5 (100 ETH)
(3) 0x6c33C8045C32985Ea02247eFDa89Ef42D788f4F7 (100 ETH)
(4) 0xDfF7E63B96547D7e6DB2b556996e752dA595724e (100 ETH)
(5) 0xc3a9F8cFd9f1dff96AD61E11413877D174b42Ca9 (100 ETH)
(6) 0x800937a68A764EE548378CD189b9f36bA8cFb60d (100 ETH)
(7) 0xD64f8f50Bc514A677017Ae8D832BA40978a71Ca8 (100 ETH)
(8) 0xC889EE4Aa318aDE7ff16cdBB2fF200bF4930Fe6D (100 ETH)
(9) 0xf410F2c4Eba8Ba346365186342bD01ACe8C9C2d9 (100 ETH)

Private Keys
==================
(0) 0x0afbeecca16a906dc701d1ff6b347dbb81d03ed57acca5f09f57c08354f1bc0f
(1) 0x0f856fda1741cc5f3d34138fa35f050f2fee3fa1df4ea7c184b01ed1cbd6c27c
(2) 0x3b47d1921a1c0c31f4a2457c9322e1a3c8cd5af38dbfb042d43a6882869851f7
(3) 0xa1f92150eb1df66d01d2d74e8b745bab2a3cb5be91a5b1b180161644df2dfee2
(4) 0x248e53f0250f39d2bffe8652f1b899a54d799d9f8aba87965edb319662b1c2ac
(5) 0xc62c08ff39c17ec533dd0588bc55d134ec9cf9ec8b08fedd88d26a524cd5c064
(6) 0x44157c4e5c400e888cdf729b69451c02f4a1d36360312b47f9f943588b41d00c
(7) 0x35667d9364c558629c474f78a4dd4c348c846e2f1a5641a27fe66decf0e1cc41
(8) 0xdba1840691f5b4978647036991bd1960443c2ad5ea64430e4aa935cec5aa0146
(9) 0x27c51cf31310813b3bb44ff99aa471f5feaa6070000f2256ceb53b736e833d66

HD Wallet
==================
Mnemonic:      scissors erupt shell angle cross dignity desert brush furnace route choice sell
Base HD Path:  m/44'/60'/0'/0/{account_index}

Gas Price
==================
20000000000

Gas Limit
==================
6721975

Listening on 127.0.0.1:8545

project1115$ oz create
Nothing to compile, all contracts are up to date.
? Pick a contract to instantiate Counter
? Pick a network development
✓ Added contract Counter
✓ Contract Counter deployed
All contracts have been deployed
? Call a function to initialize the instance after creating it? No
✓ Setting everything up to create contract instances
✓ Instance created at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D
0x88aE9Dd0e219344ff4F3Fd75472843A62518050D

project1115$ oz send-tx
? Pick a network development
? Pick an instance Counter at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D
? Select which function increase()
✓ Transaction successful. Transaction hash: 0x001656de2d5ab56638793b4bea47c9e9e9fe9446b77c0cdc00aa3782d9abb689

project1115$ oz call
? Pick a network development
? Pick an instance Counter at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D
? Select which function value()
✓ Method 'value()' returned: 1
1

contract/Counter.sol
pragma solidity ^0.5.0;

contract Counter {
  uint256 public value;

  function increase(uint256 amount) public {
    value += amount;   //変更点
  }
}

project1115$ oz upgrade
? Pick a network development
✓ Compiled contracts with solc 0.5.13 (commit.5b0b510c)
✓ Contract Counter deployed
All contracts have been deployed
? Which instances would you like to upgrade? All instances
✓ Instance upgraded at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D. Transaction receipt: 0x198e9f18e8d7b1baa143f344eda06528e9633999c2d63e80f54377db446f79dc
✓ Instance at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D upgraded

project1115$ oz send-tx
? Pick a network development
? Pick an instance Counter at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D
? Select which function increase(amount: uint256)
? amount (uint256): 100
✓ Transaction successful. Transaction hash: 0x3437bd7d01ee5000a92a32134f154e50a381aa0c72da47ab1d4342c8db1de58f

project1115$ oz call
? Pick a network development
? Pick an instance Counter at 0x88aE9Dd0e219344ff4F3Fd75472843A62518050D
? Select which function value()
✓ Method 'value()' returned: 101
101

アップグレードする際の注意点・ルール

Logic Contract

Contract間のストレージ衝突

変更の際の注意点・ルール

contract MyContract {
  uint256 private x;
  string private y;
}


contract MyContract {
  string private x;  // 型変更はできない。
  string private y;
}

contract MyContract {
  uint256 private x;
  string private y;
}


contract MyContract {
  string private y;  // 順番を入れ替えてはいけない。
  uint256 private x;
}

contract MyContract {
  uint256 private x;
  string private y;
}

contract MyContract {
  bytes private a;  // ここで宣言してはいけない
  uint256 private x;
  string private y;
}

contract MyContract {
  uint256 private x;
  string private y;
}


contract MyContract {
  string private y;
}

contract MyContract {
  uint256 private x;
  string private y;
  bytes private z;  // ここでなら宣言が可能。
}

contract MyContract {
  uint256 private x;
  string private z; // starts with the value from `y`
}

contract MyContract {
  uint256 private x;
}

// Then upgraded to...

contract MyContract {
  uint256 private x;
  string private z; // starts with the value from `y`
}

contract A {
  uint256 a;
}

contract B {
  uint256 b;
}

contract MyContract is A, B { }

contract MyContract is B, A { }  // 順番を入れ替えると変数の値が崩れる。

contract Base {
  uint256 base1;
}

contract Child is Base {
  uint256 child;
}


contract Base {
  uint256 base1;
  uint256 base2;  // 親コントラクトに変数を追加することはできない。
}

まとめ