[EN] Sync up with neo-project#809 (neo-project#810)

* [EN] Sync up with neo-project#809 [EN] Sync up with neo-project#809 * minor update * fix some
simplitech · May 16, 2019 · 108079c · 108079c
1 parent 4da237c
commit 108079c
Show file tree

Hide file tree

Showing 7 changed files with 101 additions and 0 deletions.
diff --git a/en-us/sc/tutorial/assets/migrate_m1.png b/en-us/sc/tutorial/assets/migrate_m1.png
diff --git a/en-us/sc/tutorial/assets/migrate_m2.png b/en-us/sc/tutorial/assets/migrate_m2.png
diff --git a/en-us/sc/tutorial/assets/migrate_m3.png b/en-us/sc/tutorial/assets/migrate_m3.png
diff --git a/en-us/sc/tutorial/assets/migrate_m4.png b/en-us/sc/tutorial/assets/migrate_m4.png
diff --git a/en-us/sc/tutorial/assets/migrate_m5.png b/en-us/sc/tutorial/assets/migrate_m5.png
diff --git a/en-us/sc/tutorial/migrate.md b/en-us/sc/tutorial/migrate.md
@@ -0,0 +1,99 @@
+# Migrating Smart Contracts
+
+In some cases you want to upgrade the smart contracts deployed on the blockchain or migrate the storage of a contract into another new contract, you need to migrate smart contracts.
+
+This tutorial is based on:
+
+- The example created in Visual Studio 2017
+- NeoSmartContractPlugin v2.9.3
+- The latest [Neo-GUI](https://github.com/neo-project/neo-gui/releases)
+
+## Implementing the migrate interface
+To enable migration function, you need to implement the migrate interface in the contract, as shown below:
+```c#
+       	...
+	public static object Main(string method, params object[] args)
+        {
+
+            ...
+            if (method == "migrate")
+            {
+                if (args.Length < 9) return false;
+                byte[] script = (byte[])args[0];
+                byte[] plist = (byte[])args[1];
+                byte rtype = (byte)args[2];
+                ContractPropertyState cps = (ContractPropertyState)args[3];
+                string name = (string)args[4];
+                string version = (string)args[5];
+                string author = (string)args[6];
+                string email = (string)args[7];
+                string description = (string)args[8];
+                return Migrate(script, 
+                               plist, 
+                               rtype, 
+                               cps, 
+                               name, 
+                               version, 
+                               author, 
+                               email, 
+                               description);
+            }
+            ...
+        }
+	private static Boolean Migrate(byte[] script, 
+            byte[] plist, 
+            byte rtype, 
+            ContractPropertyState cps, 
+            string name, 
+            string version, 
+            string author, 
+            string email, 
+            string description)
+        {
+            var contract = Contract.Migrate(script, 
+                plist,
+                rtype, 
+                cps, 
+                name, 
+                version,
+                author, 
+                email, 
+                description);
+            return true;
+        }
+       	... // Some code segments are omitted
+```
+
+If you want to migrate the contract later, you must implement the migrate interface in the contract prior to deployment. For more information, refer to [Deploying and Invoking Smart Contracts](../quickstart/deploy-invoke.md).
+
+## Migrating the contract
+With your new contract in hand, let's invoke the migrate interface in your old contract using NEO-GUI.
+
+> [!Note]
+>
+> To obtain the contract script and scripthash, you can go to NEO-GUI, click `Advanced` > `Deploy Contract`，and then `Load` the contract, copy all content of the contract and scripthash for later use.
+
+1. In NEO-GUI, click `Advanced` > `Invoke Contract`，and enter the old contract ScriptHash. The deployed contract information is displayed.
+
+   ![调用合约](assets/migrate_m1.png)
+
+2. Click `Invoke` and then enter necessary parameters required for invoking the migrate interface. Here I use content of new contract as the first parameter.
+
+   ![输入参数](assets/migrate_m2.png)
+
+3. Once completed, click `Test` to view the result.
+
+   You will find the value 1-True is returned and the invoking fee is 491 GAS.
+
+   ![](assets/migrate_m3.png)
+
+4. Click `Invoke` and wait for blockchain's verification.
+5. Once the transaction confirmed, enter the new contract ScriptHash in the Invoke Contract window. The new contract information is displayed. 
+
+   ![新合约](assets/migrate_m4.png)
+
+6. Enter the old contract ScriptHash again，you will no longer find the information displayed. 
+
+   ![旧合约](assets/migrate_m5.png)
+
+That indicates the storage has been migrated from the old contract into the new contract, and meanwhile the old contract has been destroyed.
diff --git a/en-us/toc.yml b/en-us/toc.yml
@@ -409,6 +409,8 @@
         href: sc/tutorial/verify.md
       - name: Deploying a Lock Contract
         href: sc/tutorial/Lock2.md
+      - name: Migrating Smart Contracts
+        href: sc/tutorial/migrate.md
     - name: Parameters and Return Values
       href: sc/Parameter.md
     - name: Contract Triggers