不像你在其他地方看到的紙質合約，以太坊的智慧合約是程式碼組成的，需要你以非常謹慎的態度去對待它。

（這是一件好事，想象下如果現實世界的合同需要編譯的話會更清晰麼？）

如果我們的合同沒有被正確的編碼出來, 我們的交易可能會失敗，導致以太幣的損失(以 gas 的形式)，更不用說浪費時間和精力。

幸運的是，Truffle (版本 4 以上) 內建了逐步除錯的功能，所以一旦發生錯誤，你可以很快發現並修復它。

在本教程中,我們將在測試的區塊鏈環境中部署一個基礎的合同，並引入一些錯誤，通過 Truffle 內建偵錯程式修復它們。

一個基礎的智慧合約

一個最基礎的合同是一個簡單的儲存型別的智慧合約。（這個例子改編自 Solidity documentation

pragma solidity ^0.4.17;

contract SimpleStorage {
  uint myVariable;

  function set(uint x) public {
    myVariable = x;
  }

  function get() constant public returns (uint) {
    return myVariable;
  }
}

此合約做了兩件事：

• 允許你設定一個變數（myVariable）為特定整數值。
• 允許你查詢一個選定的值。

這不是一個非常有趣的合約，但是這不是重點。我們想看看出錯後會發生什麼當事情。

首先我們配置環境。

部署智慧合約

1. 首先為我們的合約建立一個新的本地目錄:

mkdir simple-storage
cd simple-storage

2. 建立一個空的 Truffle 專案

truffle init

這個命令將建立目錄，比如contracts/和migrations/,並生成一些檔案用於幫助部署合約到區塊鏈。

3.contracts/目錄中有一個Store.sol檔案。

pragma solidity ^0.4.17;
contract SimpleStorage {
  uint myVariable;
function set(uint x) public {
    myVariable = x;
  }
function get() constant public returns (uint) {
    return myVariable;
  }
}

這是我們需要除錯的合約，詳細的合約內容的解釋超出了本教程的範圍，注意我們有一個名為SimpleStorage的合約，裡面有個數字型別的變數myVariable和兩個函式set()和get()。第一個函式設定變數內容，第二個獲取變數。

4. migrations/ 目錄下，有個 2_deploy_contracts.js 檔案。

var SimpleStorage = artifacts.require("SimpleStorage");
module.exports = function(deployer) {
  deployer.deploy(SimpleStorage);
};

這個檔案是管理部署SimpleStorage合約的。

5. 在終端中，編譯此合約

truffle compile

6. 再開一個終端，執行 truffle develop ，開啟 truffle 內建的測試區塊鏈，這樣我們可以使用它來測試合約。

truffle develop

這個命令將出現提示符 truffle(develop)>， 從現在開始，所有的命令都在此提示符下輸入（特殊情況會說明）

7. 當開發控制檯執行起來後，我們可以部署我們的合約了。

migrate

下面的相應有些類似，除了 id 不同。

Running migration: 1_initial_migration.js
   Replacing Migrations...
   ... 0xe4f911d95904c808a81f28de1e70a377968608348b627a66efa60077a900fb4c
   Migrations: 0x3ed10fd31b3fbb2c262e6ab074dd3c684b8aa06b
 Saving successful migration to network...
   ... 0x429a40ee574664a48753a33ea0c103fc78c5ca7750961d567d518ff7a31eefda
 Saving artifacts...
 Running migration: 2_deploy_contracts.js
   Replacing SimpleStorage...
   ... 0x6783341ba67d5c0415daa647513771f14cb8a3103cc5c15dab61e86a7ab0cfd2
   SimpleStorage: 0x377bbcae5327695b32a1784e0e13bedc8e078c9c
 Saving successful migration to network...
   ... 0x6e25158c01a403d33079db641cb4d46b6245fd2e9196093d9e5984e45d64a866
 Saving artifacts...

和基礎的智慧合約互動

智慧合約通過truffle develop部署到了測試網路中，執行 console 而不是 Ganache，一個內建在 Truffle 的本地區塊鏈。

1. 在truffle develop執行的終端中，輸入如下命令：

SimpleStorage.deployed().then(function(instance){return instance.get.call();}).then(function(value){return value.toNumber()});

這個命令找到 SimpleStorage 合約，然後呼叫get()命令，通常返回一個字串並轉化為數字。

0

myVariable被設定為 0，儘管我們還沒給它賦值。這是因為 Solidity 數值型變數會自動被賦值為 0，不像其他語言會是NULL和undefined。

2. 現在我們執行一條交易命令，呼叫set()設定我們的變數為其他值。

SimpleStorage.deployed().then(function(instance){return instance.set(4);});

設定變數為 4，返回的資訊包括交易（交易 id ，交易receipt 和一些交易的時間 log）

{ tx: '0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42',
   receipt:
{ transactionHash: '0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42',
  transactionIndex: 0,
  blockHash: '0x60adbf0523622dc1be52c627f37644ce0a343c8e7c8955b34c5a592da7d7c651',
  blockNumber: 5,
  gasUsed: 41577,
  cumulativeGasUsed: 41577,
  contractAddress: null,
  logs: [] },
   logs: [] }

最重要的是交易的 id (在這裡是 tx 和 transactionHash)。我們需要賦值這個值用來除錯。

3. 想驗證值是否已經改變，執行get()

SimpleStorage.deployed().then(function(instance){return instance.get.call();}).then(function(value){return value.toNumber()});

輸出

4

除錯錯誤

上文展示了智慧合約如何工作，現在我們引入一些錯誤到合約中。

針對如下幾個錯誤

• 無限迴圈
• 無效錯誤檢查
• 無錯誤，但是函式沒有按預期執行

錯誤 #1: 無限迴圈

在以太坊區塊鏈中，交易不能永遠執行下去。

一個交易會一直執行到 gas 用盡。一旦發生這種情況，交易會返回out of gas錯誤。

因為 gas 是以以太幣計費的，所以會造成真實的資產損失，所以修復這種錯誤迫在眉睫。

引入錯誤

1. 在編輯器開啟contracts/目錄中的Store.sol
2. 替換set()

function set(uint x) public {
  while(true) {
    myVariable = x;
  }
}

因為while(true)所以函式永遠不會退出。

測試合約

Truffle 的開發終端不重啟就可以重新部署合約。我們可以通過migrate一步編譯和部署合約

1. Truffle 的開發終端中，更新合約

migrate --reset

2. 為了更好的捕獲錯誤，我們開啟第二個終端

truffle develop --log

然後回到之前的終端中

3. 現在我們可以執行交易了，執行set()命令

SimpleStorage.deployed().then(function(instance){return instance.set(4);});

捕獲到錯誤

Error: VM Exception while processing transaction: out of gas

在 log 的終端中，我們可以看到更多資訊

develop:testrpc eth_sendTransaction +0ms
 develop:testrpc  +1s
 develop:testrpc   Transaction: 0xe493340792ab92b95ac40e43dca6bc88fba7fd67191989d59ca30f79320e883f +2ms
 develop:testrpc   Gas usage: 4712388 +11ms
 develop:testrpc   Block Number: 6 +15ms
 develop:testrpc   Runtime Error: out of gas +0ms
 develop:testrpc  +16ms

通過這些資訊，我們可以除錯這個交易

除錯錯誤

調出 debug 的命令是在 Truffle 開發終端輸入debug <Transaction ID>或者直接在終端中輸入truffle debug <Transaction ID>，現在讓我們開始吧!

1. 在 Truffle 開發終端中，複製貼上交易 id 到 debug 命令後

debug 0xe493340792ab92b95ac40e43dca6bc88fba7fd67191989d59ca30f79320e883f

你將看到如下輸出

Gathering transaction data...
Addresses affected:
     0x377bbcae5327695b32a1784e0e13bedc8e078c9c - SimpleStorage
Commands:
   (enter) last command entered (step next)
   (o) step over, (i) step into, (u) step out, (n) step next
   (;) step instruction, (p) print instruction, (h) print this help, (q) quit
Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:
1: pragma solidity ^0.4.17;
   2:
   3: contract SimpleStorage {
      ^^^^^^^^^^^^^^^^^^^^^^^
debug(develop:0xe4933407...)>

這是個互動式命令列，你可以用列出的命令和程式互動

1. 最常用的命令是 `step next`，命令執行一次往下一行程式碼，快捷鍵是 `Enter` 或者 `n`
輸出

 Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:
    4:   uint myVariable;
    5:
    6: function set(uint x) public {
       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

注意程式已經移動到了下一個命令，第六行中。
2. 鍵入回車

 Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        5:
        6: function set(uint x) public {
        7:   while(true) {
        ^^^^^^^^^^^^

3. 不斷按回車

 Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        5:
        6: function set(uint x) public {
        7:   while(true) {
               ^^^^

        debug(develop:0xe4933407...)>

        Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        5:
        6: function set(uint x) public {
        7:   while(true) {
         ^^^^^^^^^^^^

        debug(develop:0xe4933407...)>

        Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        6: function set(uint x) public {
        7:   while(true) {
        8:     myVariable = x;
                        ^

        debug(develop:0xe4933407...)>

        Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        6: function set(uint x) public {
        7:   while(true) {
        8:     myVariable = x;
           ^^^^^^^^^^

        debug(develop:0xe4933407...)>

        Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        6: function set(uint x) public {
        7:   while(true) {
        8:     myVariable = x;
           ^^^^^^^^^^^^^^

        debug(develop:0xe4933407...)>

        Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

        5:
        6: function set(uint x) public {
        7:   while(true) {
         ^^^^^^^^^^^^

請注意，最終步驟會一直重複。事實上，按回車會永遠重複那些交易(直到用完 gas )。而這會告訴你問題在哪裡。

錯誤 #2: 無效錯誤檢查

智慧合約可以用 assert() 來保證必要特定條件會出現。這種和合約狀態的衝突是不可調和的。
引入錯誤
現在我們來引入這個錯誤，看看偵錯程式如何發現它。
1. 再次開啟 `Store.sol`
2. 替換 `set()` 函式

 function set(uint x) public {
      assert(x == 0);
      myVariable = x;
    }

和前一個版本一樣，只是多了 `assert()` 函式，保證 `x == 0`，如果我們設定 x 為其他值，我們就會發現錯誤。

測試合約
和之前一樣，我們重置下合約
1. migrate --reset
2. SimpleStorage.deployed().then(function(instance){return instance.set(4);});
我們會看到如下錯誤

 Error: VM Exception while processing transaction: invalid opcode

除錯錯誤
1. 複製交易 id 到 debug 命令下

debug 0xe493340792ab92b95ac40e43dca6bc88fba7fd67191989d59ca30f79320e883f

回到偵錯程式

Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:
1: pragma solidity ^0.4.17;
   2:
   3: contract SimpleStorage {
      ^^^^^^^^^^^^^^^^^^^^^^^
debug(develop:0xe4933407...)>

1. 鍵入回車

Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:

    5:
    6:   function set(uint x) public {
    7:     assert(x == 0);
           ^^^^^^^^^^^^^^

    debug(develop:0x7e060037...)>

    Transaction halted with a RUNTIME ERROR.

    This is likely due to an intentional halting expression, like 
    assert(), require() or revert(). It can also be due to out-of-gas
    exceptions. Please inspect your transaction parameters and 
    contract code to determine the meaning of this error.

我們可以看到最後的事件中觸發了錯誤.

錯誤 #3: 無錯誤，但是函式沒有按預期執行

有時候，錯誤不一定是真正的錯誤，它在執行時間內不會引起問題，只是不會按預期執行。
舉個例子，一個事件將會在變數是奇數的時候執行，而另一個事件在偶數的時候執行。如果我們調換了這個條件，讓相反的事件執行了。它斌不會觸發錯誤，然而，合約會不按照我們的預期執行下去。
我們再次用偵錯程式來找出錯誤。
引入錯誤
1. 再次開啟 `Store.sol`
2. 替換 `set()` 函式

 event Odd();

    event Even();

    function set(uint x) public {
      myVariable = x;
      if (x % 2 == 0) {
        Odd();
      } else {
        Even();
      }
    }

程式碼有兩個假的事件，`Odd()` 和 `Even()` 是否執行取決於 x 是否能被 2 整除。
但是我們發現 x 能被 2 整除時， `Odd()` 事件觸發了。
測試合約
1. migrate --reset
2. SimpleStorage.deployed().then(function(instance){return instance.set(4);});
沒有錯誤產生，輸出如下

{ tx: '0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42',
  receipt:
   { transactionHash: '0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42',
     transactionIndex: 0,
     blockHash: '0x08d7c35904e4a93298ed5be862227fcf18383fec374759202cf9e513b390956f',
     blockNumber: 5,
     gasUsed: 42404,
     cumulativeGasUsed: 42404,
     contractAddress: null,
     logs: [ [Object] ] },
  logs:
   [ { logIndex: 0,
       transactionIndex: 0,
       transactionHash: '0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42',
       blockHash: '0x08d7c35904e4a93298ed5be862227fcf18383fec374759202cf9e513b390956f',
       blockNumber: 5,
       address: '0x377bbcae5327695b32a1784e0e13bedc8e078c9c',
       type: 'mined',
       event: 'Odd',
       args: {} } ] }

logs 裡面顯示呼叫了 Odd 事件，這是不對的，我們的任務是找到這個事件為什麼會被觸發。
除錯錯誤
1. 複製交易 id 到 debug 命令下

debug 0x7f799ad56584199db36bd617b77cc1d825ff18714e80da9d2d5a0a9fff5b4d42

2. 鍵入回車幾次，最後我們將看到呼叫 Odd 事件的條件

Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:
10:   function set(uint x) public {
11:     myVariable = x;
12:     if (x % 2 == 0) {
        ^^^^^^^^^^^^^^^^
debug(develop:0x7f799ad5...)>
Store.sol | 0x377bbcae5327695b32a1784e0e13bedc8e078c9c:
11:     myVariable = x;
12:     if (x % 2 == 0) {
13:       Odd();
          ^^^^^
debug(develop:0x7f799ad5...)>

錯誤找到了，這個條件導致了錯誤的事件呼叫。

結論

有了在 Truffle 中的除錯能力，你可以編寫更健壯的智慧合約。