圖片來源

上一篇我們談到「【開發智能合約 — Solidity系列】實作篇Ep.1 — 看懂智能合約的脈絡」，大致上理解每個檔案的每份合約都是一個個的區塊，而這一個篇章主要著重於合約中的每個區塊的組成元素進行分項說明。

今天的範例會以簡單的銀行存款與提款流程進行示範，過程中將一步步的使用上述7種元素完成功能，這七種功能也是未來撰寫合約時非常常用的技巧。

State Variables(狀態變數)

「狀態變數」主要在儲存一份合約之中的變化值，銀行中會變化的就是我們的「錢」，而「錢」在我們的合約裡面就是一種狀態變數，我們也會記錄擁有者是誰，大抵如下：

...
contract Bank {
    /// @notice 記載存款數字
    /// @dev State Variables(狀態變數)
    uint private value;
    /// @notice 記載存款擁有者
    /// @dev State Variables(狀態變數)
    address private owner;
}

上面的程式碼範例中可以看到private關鍵字，這是可視範圍(Visibility and Getters)的宣告，而uint、address…關鍵字則是型別(Types)。

Functions(功能)

銀行最基本的功能就是存款與提款，而存款這個功能會將原本的「錢」進行增加的動作，因此每個功能裡面都包含著一個個的動作，而這些動作通常會改變我們的變數值。

...
contract Bank {
   ...
    /// @dev Functions(功能): 存款並增加總資產
    function deposit(uint amount){
        value += amount;
    }
}

Function Modifiers(修飾函式)

通常我們在進行某項功能之前，根據法規會有一些限制，舉例來說： 存款前務必檢查是否為本人，而這個事前檢查就是所謂的「修飾函式」。

...
contract Bank {
    ...
    /// @dev Function Modifiers(修飾函式): 務必只能存款擁有者...
    /// msg.sender: 訊息的發送者（或這說是發出這個呼叫的人）
    modifier onlyOwner {
        require(owner == msg.sender);
        _;
    }
    /// @dev Functions(功能): 存款並增加總資產
    function deposit(uint amount) public onlyOwner {
        value += amount;
    }
}

Events(事件)

我們生活在這世界上無時無刻都在發生事件，而事件的觸發必然會有一些前兆，當某個動作被觸發時，我們就將之視為事件，並發送事件通知，如此一來就能更全面的掌握每一個動作相對應的處置方式，那麼在智能合約中如果有了事件通知會是什麼樣的場景呢？

試想，當智能合約發生「存款」的動作時，對於使用者來說最在意的莫過於「成功存款」的通知了，而智能合約也提供了事件通知機制，做完某件事情後，可以主動發送事件通知，等待通知結果並進行下一步動作，以下的範例將以「存款」為出發點來說明事件的通知。

...
contract Bank {
		...
    /// @dev 已存款的事件
    /// @param addr 存款者的地址
    /// @param amount 存多少金額
    event Deposited(address addr, uint amount);
    /// @dev Functions(功能): 存款並增加總資產
    /// @param amount 欲存款的金額數量
    function deposit(uint amount) public onlyOwner {
        value += amount;
        // 觸發已存款的事件
        emit Deposited(msg.sender, amount); 
    }
}

那我們可能會好奇，這樣的事件發送了，事件送去哪裡？ 做了什麼處理？

通常會與前端的顯示進行互動，前端可以透過監聽事件的方式，接收來自智能合約的事件推播，詳細請參考「Events」。

Errors(錯誤處理)

假設我們要提款時，發現提款的金額大於我們的總資產時，這時候理論上應該是不能提款的，畢竟銀行也不是慈善事業免費送錢給我們，因此這樣的條件就是一種錯誤，此時可以透過錯誤處理來告知提款者「您的存款不足」，讓提款者可以知曉為什麼無法提款。

...
contract Bank {
    ...
    /// @dev 自訂錯誤類型: 資金不足
    /// @param requested 要求的資金
    /// @param available 可用的資金
    error NotEnoughFunds(uint requested, uint available);
    /// @dev Errors(錯誤處理): 提款並減少總資產
    function withdraw(uint amount) public onlyOwner {
        if (amount > value)
            revert NotEnoughFunds(amount, value);
        value -= amount;
    }
}

更多的錯誤處理類型請參考「Errors and the Revert Statement」。

Struct Types(結構型別)

隨著智能合約越來越複雜，我們的狀態變數也隨之越來越多，如此一來很容易導致合約過於雜亂，因此我們可以把相關的狀態變數整理在一起，放在同一個區塊，例如以下的範例，帳號的組成會有戶名、帳號識別碼…，將相關的狀態變數彙整於一起。

...
contract Bank {
		...
    // @dev 帳號的組成內容
    struct Account {
        // @dev 帳號的用戶名
        string username;
        // @dev 帳號的識別碼
        string id;
    }
    // @dev 帳號的變數宣告
    Account private account;
}

Enum Types(列舉型別)

除了基礎型態以外，我們也可以自訂型別，舉例來說，銀行在進行交易時會有幾種狀態，開始交易、交易中、完成交易，而這三種狀態通常不會在Solidity預設的型態中，因此我們可以自訂這樣的狀態型別，便於實作狀態的變化。

...
contract Bank {
		...
    /// @notice 交易狀態
    /// @dev 狀態定義包含Start、Doing、Done
    enum Status  { Start, Doing, Done } 
    /// @notice 狀態
    /// @dev 狀態的變數宣告
    Status private status;
    /// @notice 更新狀態
    /// @dev 將內部的狀態更新為外部指定的狀態
    function set(Status _status) public {
        status = _status;
    }
}

結語

藉由基礎元素的了解，我們可以學習到撰寫智能合約的一些技巧與用詞，這一篇僅將大元素做個基本介紹，其實每個元素的用法還能再延伸額外的篇章進行詳細說明，一個篇章如果隱含太多資訊相信初學的過程很容易就放棄，因此細節其實可以留待真正實作一份合約時再一一查詢即可，我們只要懂得大架構如何在腦中浮現即可。

以上的範例皆親自學習並且進行修改，每段註解亦是閱讀詳細文檔過後的整理，過程非常耗時，希望這樣的篇章說明能夠對您有所幫助，如果有任何錯誤需要修正的也歡迎留言讓我們共同學習開發智能合約，讓技術更加普及。

今天的範例都在這裡「solidity-remix-toturial/Ep2」歡迎自行取用。

下一篇我們來談談資料型態與流程控制：

⏭️【開發智能合約 — Solidity系列】實作篇Ep.3 -資料型態的特性與流程控制

📚 更多關於Solidity的文章請看這裡…

喜歡撰寫文章的你，不妨來了解一下：

Web3.0時代下為創作者、閱讀者打造的專屬共贏平台 — 為什麼要加入？

 歡迎加入一起練習寫作，賺取知識，累積財富！