序言
本文是 Solidity 文檔(以太坊官方 Solidity 開發(fā)手冊)中文版連載的第四部分。這個(gè)連載的前三部分是智能合約概述、安裝 Solidity 編譯器和結(jié)合實(shí)例學(xué)習(xí) Solidity龙助。
這份文檔的英文原文可以在以太坊官網(wǎng)的最下方 Solidity 鏈接中找到。官方的英文版本文檔中有中譯版鏈接,即是本連載內(nèi)容的出處幻馁。這個(gè)連載將按照英文文檔的先后順序進(jìn)行洗鸵。
Solidity 是以太坊官方的智能合約開發(fā)高級語言。這份中文譯本是由 Hiblock 社區(qū)組織貢獻(xiàn)的仗嗦,官方 Github:https://github.com/etherchina/solidity-doc-cn膘滨。
我本人于 3 月初加入本項(xiàng)目,目前作為管理員稀拐、貢獻(xiàn)者和校訂人利用業(yè)余時(shí)間參與日常工作火邓;截至到 4 月底,翻譯工作已完成大半德撬。有興趣的朋友請直接在以太坊官網(wǎng)的鏈接中查看最新中文版本狀態(tài)铲咨,或者關(guān)注上述中文譯本的 Github repository。
出于單獨(dú)閱讀的需要蜓洪,我在連載中會刪除原文里的 rst 控制標(biāo)簽纤勒、文內(nèi)鏈接和部分外部鏈接。
本文是在具體介紹 Solidity 語法隆檀、語言特性之前的鋪墊摇天,介紹了 Solidity 源文件中除具體合約代碼以外的其他要素。
Solidity 源文件結(jié)構(gòu)
源文件中可以包含任意多個(gè)合約定義恐仑、導(dǎo)入指令和雜注指令闸翅。
版本雜注
為了避免未來被可能引入不兼容變更的編譯器所編譯,源文件可以(也應(yīng)該)被所謂的版本雜注所注解菊霜。
我們力圖把這類變更做到盡可能小坚冀,特別是,我們需要以一種當(dāng)修改語義時(shí)必須同步修改語法的方式引入變更鉴逞,當(dāng)然這有時(shí)候也難以做到记某。
因此,至少對含重大變更的版本构捡,通讀變更日志永遠(yuǎn)是好辦法液南。
這些版本的版本號始終是 0.x.0
或者 x.0.0
的形式。
版本雜注使用如下
pragma solidity ^0.4.0;
這樣勾徽,源文件將既不允許低于 0.4.0 版本的編譯器編譯滑凉,
也不允許高于(包含)0.5.0
版本的編譯器編譯(第二個(gè)條件因使用 ^
被添加)。
這種做法的考慮是喘帚,編譯器在 0.5.0 版本之前不會有重大變更畅姊,所以可確保源代碼始終按預(yù)期被編譯。
上面例子中不固定編譯器的具體版本號吹由,因此編譯器的補(bǔ)丁版也可以使用若未。
可以使用更復(fù)雜的規(guī)則來指定編譯器的版本,表達(dá)式遵循 npm 版本語義倾鲫。
Pragma 是 pragmatic information 的簡稱粗合,微軟 Visual C++ 文檔 中譯為雜注萍嬉。
Solidity 中沿用 C ,C++ 等中的編譯指令概念隙疚,用于告知編譯器 如何 編譯壤追。
——譯者注
導(dǎo)入其他源文件
語法與語義
雖然 Solidity 不知道“default export”為何物,
但是 Solidity 所支持的導(dǎo)入語句供屉,其語法同 JavaScript(從 ES6 起)非常類似行冰。
ES6 即 ECMAScript 6.0,ES6是 JavaScript 語言的下一代標(biāo)準(zhǔn)贯卦,已經(jīng)在 2015 年 6 月正式發(fā)布资柔。
——譯者注
在全局層面上,可使用如下格式的導(dǎo)入語句:
import "filename";
此語句將從“filename”中導(dǎo)入所有的全局符號到當(dāng)前全局作用域中(不同于 ES6撵割,Solidity 是向后兼容的)贿堰。
import * as symbolName from "filename";
...創(chuàng)建一個(gè)新的全局符號 symbolName
,其成員均來自 "filename"
中全局符號啡彬。
import {symbol1 as alias, symbol2} from "filename";
...創(chuàng)建新的全局符號 alias
和 symbol2
羹与,分別從 "filename"
引用 symbol1
和 symbol2
。
另一種語法不屬于 ES6庶灿,但或許更簡便:
import "filename" as symbolName;
這條語句等同于 import * as symbolName from "filename";
纵搁。
路徑
上文中的 filename 總是會按路徑來處理,以 /
作為目錄分割符往踢、以 .
標(biāo)示當(dāng)前目錄腾誉、以 ..
表示父目錄。
當(dāng) .
或 ..
后面跟隨的字符是 /
時(shí)峻呕,它們才能被當(dāng)做當(dāng)前目錄或父目錄利职。
只有路徑以當(dāng)前目錄 .
或父目錄 ..
開頭時(shí),才能被視為相對路徑瘦癌。
用 import "./x" as x;
語句導(dǎo)入當(dāng)前源文件同目錄下的文件 x
猪贪。
如果用 import "x" as x;
代替,可能會引入不同的文件(在全局 include directory
中)讯私。
最終導(dǎo)入哪個(gè)文件取決于編譯器(見下文)到底是怎樣解析路徑的热押。
通常,目錄層次不必嚴(yán)格映射到本地文件系統(tǒng)斤寇,
它也可以映射到能通過諸如 ipfs桶癣,http 或者 git 發(fā)現(xiàn)的資源。
在實(shí)際的編譯器中使用
當(dāng)運(yùn)行編譯器時(shí)抡驼,它不僅能指定如何發(fā)現(xiàn)路徑的第一個(gè)元素鬼廓,還可指定路徑前綴重映射。
例如致盟,github.com/ethereum/dapp-bin/library
會被重映射到 /usr/local/dapp-bin/library
碎税,
此時(shí)編譯器將從重映射位置讀取文件。如果重映射到多個(gè)路徑馏锡,優(yōu)先嘗試重映射路徑最長的一個(gè)雷蹂。
這允許將比如 ""
被映射到 "/usr/local/include/solidity"
來進(jìn)行“回退重映射”。
同時(shí)杯道,這些重映射可取決于上下文匪煌,允許你配置要導(dǎo)入的包,比如同一個(gè)庫的不同版本党巾。
solc:
對于 solc(命令行編譯器)萎庭,這些重映射以 context:prefix=target
形式的參數(shù)提供。
其中齿拂,context:
和 =target
部分是可選的(此時(shí) target 默認(rèn)為 prefix )驳规。
所有重映射的值都是被編譯過的常規(guī)文件(包括他們的依賴),這個(gè)機(jī)制完全是向后兼容的(只要文件名不包含 = 或 : )署海,
因此這不是一個(gè)破壞性修改吗购。
在 content
目錄或其子目錄中的源碼文件中,所有導(dǎo)入語句里以 prefix
開頭的導(dǎo)入文件都將被用 target
替換 prefix
來重定向砸狞。
舉個(gè)例子捻勉,如果你已克隆 github.com/ethereum/dapp-bin/
到本地 /usr/local/dapp-bin
,
可在源文件中使用:
import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;
然后運(yùn)行編譯器:
solc github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ source.sol
舉個(gè)更復(fù)雜的例子刀森,假設(shè)你依賴了一些使用了非常舊版本的 dapp-bin 的模塊踱启。
舊版本的 dapp-bin 已經(jīng)被 checkout 到 /usr/local/dapp-bin_old
,此時(shí)你可使用:
solc module1:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin/ \
module2:github.com/ethereum/dapp-bin/=/usr/local/dapp-bin_old/ \
source.sol
這樣研底, module2
中的所有導(dǎo)入都指向舊版本埠偿,而 module1
中的導(dǎo)入則獲取新版本。
注意飘哨, solc 只允許包含來自特定目錄的文件:它們必須位于顯式地指定的源文件目錄(或子目錄)中胚想,或者重映射的目標(biāo)目錄(或子目錄)中。
如果你想直接用絕對路徑來包含文件芽隆,只需添加重映射 =/
浊服。
如果有多個(gè)重映射指向一個(gè)有效文件,那么具有最長公共前綴的重映射會被選用胚吁。
Remix:
Remix 提供一個(gè)為 github 源代碼平臺的自動重映射牙躺,它將通過網(wǎng)絡(luò)自動獲取文件:
比如,你可以使用 import "github.com/ethereum/dapp-bin/library/iterable_mapping.sol" as it_mapping;
導(dǎo)入一個(gè) map 迭代器腕扶。
未來孽拷,Remix 可能支持其他源代碼平臺。
注釋
可以使用單行注釋(//
)和多行注釋(/*...*/
)
// 這是一個(gè)單行注釋半抱。
/*
這是一個(gè)
多行注釋脓恕。
*/
此外膜宋,有另一種注釋稱為 natspec 注釋,其文檔還尚未編寫炼幔。
它們是用三個(gè)反斜杠(///
)或雙星號開頭的塊(/** ... */
)書寫秋茫,它們應(yīng)該直接在函數(shù)聲明或語句上使用。
可在注釋中使用 Doxygen 樣式的標(biāo)簽來文檔化函數(shù)乃秀、
標(biāo)注形式校驗(yàn)通過的條件肛著,和提供一個(gè)當(dāng)用戶試圖調(diào)用一個(gè)函數(shù)時(shí)顯示給用戶的 確認(rèn)文本。
在下面的例子中跺讯,我們記錄了合約的標(biāo)題胁塞、兩個(gè)入?yún)⒑蛢蓚€(gè)返回值的說明:
pragma solidity ^0.4.0;
/** @title 形狀計(jì)算器担钮。 */
contract shapeCalculator {
/** @dev 求矩形表明面積與周長惊橱。
* @param w 矩形寬度最住。
* @param h 矩形高度。
* @return s 求得表面積火本。
* @return p 求得周長危队。
*/
function rectangle(uint w, uint h) returns (uint s, uint p) {
s = w * h;
p = 2 * (w + h);
}
}