【開發智能合約 — Solidity系列】實作篇Ep.2 — 合約中的基本組成元素

更新於 2023/05/16閱讀時間約 8 分鐘
上一篇我們談到「【開發智能合約 — 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」歡迎自行取用。
下一篇我們來談談資料型態與流程控制:
為什麼會看到廣告
avatar-img
116會員
261內容數
哈囉,我是阿Han,是一位 👩‍💻 軟體研發工程師,喜歡閱讀、學習、撰寫文章及教學,擅長以圖代文,化繁為簡,除了幫助自己釐清思路之外,也希望藉由圖解的方式幫助大家共同學習,甚至手把手帶您設計出高品質的軟體產品。
留言0
查看全部
avatar-img
發表第一個留言支持創作者!
阿Han的沙龍 的其他內容
本篇章會以實際的程式碼來說明開發Solidity的組成脈絡與重要的區塊,讓我們不再害怕閱讀艱澀難懂的程式碼,並且具備基礎知識以後也能看懂外面的合約。 開源程式碼常常會面臨到法律的問題,因此License的宣告就變得非常重要,而Solidity也考慮到這一塊,因此特別規劃了一塊License宣告的區塊
延續上一篇「【開發智能合約 — Solidity系列】開發環境準備」,我們建立好開發環境之後,為了提升開發效率與減少錯誤,因此會建議在基礎的編輯器之上加掛一些非常好用的外掛,俗話說工欲善其事,必先利其器,我們要動刀之前務必先磨好刀,接下來會建議一些必備的外掛套件以及示範如何使用,讓我們的開發功力更上
開發之前我們先來做一些前置準備,就如同一道料理在完成之前,會預先準備廚具、食材,而我們就來看看這些廚具與食材究竟能夠煮出什麼令人驚豔的料理吧! ● IDE: 基礎版(Remix)、進階版(Vscode)。 ● 程式語言: Solidity。 ● 程式碼儲存庫: Github。 這邊我們會以最簡單的方
上一篇我們介紹了智能合約的基本概念,而在開發智能合約之前, 建議先對智能合約具備基礎的概念, 往後進行開發時較容易融會貫通, 還沒閱讀的朋友可以參閱此篇「【開發智能合約 — Solidity系列】 淺談智能合約」。 理解完「智能合約」之後,相信大家已經開始手癢了吧! 應該很想開始動手完成第一個自己專
為什麼會有合約的誕生? 大家想過這個問題嗎? 試想,當陌生人與陌生人之間如果要產生與金錢相關的交易時,在沒有第三方機構的見證下,我想一般人應該也會存在著「不信任」的狀況產生,因此造就了「合約」的誕生,而這個「合約」主要目的在於確保雙方能夠在不損害對方的利益下完成交易的一種約定,其中包括了雙方的資訊、
本篇章會以實際的程式碼來說明開發Solidity的組成脈絡與重要的區塊,讓我們不再害怕閱讀艱澀難懂的程式碼,並且具備基礎知識以後也能看懂外面的合約。 開源程式碼常常會面臨到法律的問題,因此License的宣告就變得非常重要,而Solidity也考慮到這一塊,因此特別規劃了一塊License宣告的區塊
延續上一篇「【開發智能合約 — Solidity系列】開發環境準備」,我們建立好開發環境之後,為了提升開發效率與減少錯誤,因此會建議在基礎的編輯器之上加掛一些非常好用的外掛,俗話說工欲善其事,必先利其器,我們要動刀之前務必先磨好刀,接下來會建議一些必備的外掛套件以及示範如何使用,讓我們的開發功力更上
開發之前我們先來做一些前置準備,就如同一道料理在完成之前,會預先準備廚具、食材,而我們就來看看這些廚具與食材究竟能夠煮出什麼令人驚豔的料理吧! ● IDE: 基礎版(Remix)、進階版(Vscode)。 ● 程式語言: Solidity。 ● 程式碼儲存庫: Github。 這邊我們會以最簡單的方
上一篇我們介紹了智能合約的基本概念,而在開發智能合約之前, 建議先對智能合約具備基礎的概念, 往後進行開發時較容易融會貫通, 還沒閱讀的朋友可以參閱此篇「【開發智能合約 — Solidity系列】 淺談智能合約」。 理解完「智能合約」之後,相信大家已經開始手癢了吧! 應該很想開始動手完成第一個自己專
為什麼會有合約的誕生? 大家想過這個問題嗎? 試想,當陌生人與陌生人之間如果要產生與金錢相關的交易時,在沒有第三方機構的見證下,我想一般人應該也會存在著「不信任」的狀況產生,因此造就了「合約」的誕生,而這個「合約」主要目的在於確保雙方能夠在不損害對方的利益下完成交易的一種約定,其中包括了雙方的資訊、
你可能也想看
Google News 追蹤
Thumbnail
*合作聲明與警語: 本文係由國泰世華銀行邀稿。 證券服務係由國泰世華銀行辦理共同行銷證券經紀開戶業務,定期定額(股)服務由國泰綜合證券提供。   剛出社會的時候,很常在各種 Podcast 或 YouTube 甚至是在朋友間聊天,都會聽到各種市場動態、理財話題,像是:聯準會降息或是近期哪些科
Thumbnail
台股收在21858點,然後就端午節了。有好幾年都很怕端午變盤,沒想到做股票久了就也不怕了。 端午節前發現開發金有漲,查了一下,原來是改名+二王子要回來了,目前股價15元。
Thumbnail
親愛的讀者,你知道什麼是LOGO嗎? LOGO是:外來語到對標誌擁有公司的識別和推廣的作用,透過形象的logo可以讓消費者記住公司主體和品牌文化。 標誌特徵與特性: 延展性:企業logo是應用最為廣泛,出現頻率最高的視覺傳達要素,必須在各種傳播媒體上廣泛應用。logo圖形要針對印刷
Thumbnail
《經濟日報》日前於台北國際會議中心盛大舉辦「2023生技論壇」,邀請衛福部長薛瑞元、生策會副會長楊泮池、長佳智能董座陳明豐在內的多位官、商、學界專家、學者參與盛會,深入研討新冠肺炎疫情後的經濟重組;瞄準再生醫療、精準醫療、大健康領域等生技產業範疇,藉由共同發聲、齊心努力,對此應有推波助瀾之效。
Thumbnail
剛好前陣子在求職平台/人力銀行服務,一直在思考整個產品要如何進行迭代優化,以及要如何根據使用者需求來制定產品路線圖、開發優先順序,這篇會介紹求職平台的產品特點、使用者路徑、以及從產品優化的角度如何拆解。
Thumbnail
購買網站:https://shopee.tw/【樂意創客官方店】 使用方式 擴展網址:https://github.com/lzty634158/GHBit 在擴展頁面輸入“https://github.com/lzty634158/GHBit” 按下Enter 搜尋,就可以發現GHBit
Thumbnail
介紹了這麼多Solidity的函數和方法,今天來寫一個簡單的錢包,順便介紹一下payable。
此篇我們也來介紹另外一個也是蠻常用又蠻重要的Mapping,它和陣列有點像,但比較不同的是:它不能用迴圈的方式取出裡面所有的資料,但陣列可以,Mapping比較像是一個查詢系統,用key值可以取出裡面的value值。
Thumbnail
這篇我們來看一個在程式開發很常見也很常用的一個東西:Array 陣列 Array在所有的程式開發中還蠻常見的,也一定會出現,因為有很多的資料都會是一長串的,需要有一個物件來去做集中管理。
在寫程式裡面,錯誤的檢查和處理是一定要有的,也是相對重要的,但Solidity裡面並沒有ErrorMessage這種東西,有的是Require()、Revert()、Assert()這三個函數,作用大概也跟ErrorMessage差不多,這裡介紹這三種函數的用法
我們知道function除了四種可見度 (visibility) 之外,還有三種比較常見的函式修飾詞(view、pure、payable),這篇就也來認識一下這三種函式修飾詞是做什麼用的吧。
Thumbnail
*合作聲明與警語: 本文係由國泰世華銀行邀稿。 證券服務係由國泰世華銀行辦理共同行銷證券經紀開戶業務,定期定額(股)服務由國泰綜合證券提供。   剛出社會的時候,很常在各種 Podcast 或 YouTube 甚至是在朋友間聊天,都會聽到各種市場動態、理財話題,像是:聯準會降息或是近期哪些科
Thumbnail
台股收在21858點,然後就端午節了。有好幾年都很怕端午變盤,沒想到做股票久了就也不怕了。 端午節前發現開發金有漲,查了一下,原來是改名+二王子要回來了,目前股價15元。
Thumbnail
親愛的讀者,你知道什麼是LOGO嗎? LOGO是:外來語到對標誌擁有公司的識別和推廣的作用,透過形象的logo可以讓消費者記住公司主體和品牌文化。 標誌特徵與特性: 延展性:企業logo是應用最為廣泛,出現頻率最高的視覺傳達要素,必須在各種傳播媒體上廣泛應用。logo圖形要針對印刷
Thumbnail
《經濟日報》日前於台北國際會議中心盛大舉辦「2023生技論壇」,邀請衛福部長薛瑞元、生策會副會長楊泮池、長佳智能董座陳明豐在內的多位官、商、學界專家、學者參與盛會,深入研討新冠肺炎疫情後的經濟重組;瞄準再生醫療、精準醫療、大健康領域等生技產業範疇,藉由共同發聲、齊心努力,對此應有推波助瀾之效。
Thumbnail
剛好前陣子在求職平台/人力銀行服務,一直在思考整個產品要如何進行迭代優化,以及要如何根據使用者需求來制定產品路線圖、開發優先順序,這篇會介紹求職平台的產品特點、使用者路徑、以及從產品優化的角度如何拆解。
Thumbnail
購買網站:https://shopee.tw/【樂意創客官方店】 使用方式 擴展網址:https://github.com/lzty634158/GHBit 在擴展頁面輸入“https://github.com/lzty634158/GHBit” 按下Enter 搜尋,就可以發現GHBit
Thumbnail
介紹了這麼多Solidity的函數和方法,今天來寫一個簡單的錢包,順便介紹一下payable。
此篇我們也來介紹另外一個也是蠻常用又蠻重要的Mapping,它和陣列有點像,但比較不同的是:它不能用迴圈的方式取出裡面所有的資料,但陣列可以,Mapping比較像是一個查詢系統,用key值可以取出裡面的value值。
Thumbnail
這篇我們來看一個在程式開發很常見也很常用的一個東西:Array 陣列 Array在所有的程式開發中還蠻常見的,也一定會出現,因為有很多的資料都會是一長串的,需要有一個物件來去做集中管理。
在寫程式裡面,錯誤的檢查和處理是一定要有的,也是相對重要的,但Solidity裡面並沒有ErrorMessage這種東西,有的是Require()、Revert()、Assert()這三個函數,作用大概也跟ErrorMessage差不多,這裡介紹這三種函數的用法
我們知道function除了四種可見度 (visibility) 之外,還有三種比較常見的函式修飾詞(view、pure、payable),這篇就也來認識一下這三種函式修飾詞是做什麼用的吧。