web3.js編譯Solidity,發布,調用全部流程(手把手教程)

下面教程是打算在盡量牽涉可能少的以太坊的相關工具,主要使用web3.js這個以太坊提供的工具包,來完成合約的編譯,發布,合約方法調用的一整個流程。一方面來了解以太坊開發到底需要什么,另一方面來對web3.js的API有個基本的了解。由于所有其它工具都或多或少的是對web3.js的底層函數的包裝,所以對web3.js使用流程有個認識之后,也能更好的入門,使用相關的工具。

1. 準備工作

1.1 安裝Node.js

由于我們要使用web3.js[1]。這里使用Node來集成web3.js模塊(當然,你還可以使用其它的方式)。你可以通過參考官網文檔安裝[2]

1.1.1 Ubuntu

如果你使用ubuntu,可以使用下述命令:

//安裝Node
sudo apt-get install nodejs
//安裝Node的包管理器
sudo apt-get install npm

1.1.2 MAC

如果你使用Homebrew,可以使用下述命令:

//安裝Node
brew install node
//安裝Node的包管理器
brew install npm

1.1.3 安裝檢查

安裝成功后,可以查看下當前的版本,確認正常安裝:

$ node -v
v7.2.0

1.2 以太坊的節點

由于整個合約代碼的執行需要一個虛擬機環境,所以在開始之前,我們不得不安裝一個實現了以太坊虛擬機的節點。

可以選擇一個輕量級的節點,比如EtherumJS TestRPC,它是一個完整的在內存中的區塊鏈僅僅存在于你開發的設備上。它在執行交易時是實時返回,而不等待默認的出塊時間,這樣你可以快速驗證你新寫的代碼,當出現錯誤時,也能即時反饋給你。

npm install -g ethereumjs-testrpc

安裝好后,你就可以通過testrpc命令來啟動了,啟動與大多數以太坊節點一樣,運行在localhost:8545

如果你安裝geth這樣的客戶端也是可以的。

1.3 Web3的支持

安裝web3的模塊[1]

npm install web3

2. 合約編譯

2.1 一個簡單的合約

我們打算用來測試的合約如下:

pragma solidity ^0.4.0;

contract Calc{
  /*區塊鏈存儲*/
  uint count;

  /*執行會寫入數據,所以需要`transaction`的方式執行。*/
  function add(uint a, uint b) returns(uint){
    count++;
    return a + b;
  }

  /*執行不會寫入數據,所以允許`call`的方式執行。*/
  function getCount() constant returns (uint){
    return count;
  }
}

add()方法用來返回輸入兩個數據的和,并會對add()方法的調用次數進行計數。需要注意的是這個計數是存在區塊鏈上的,對它的調用需要使用transaction

getCount()返回add()函數的調用次數。由于這個函數不會修改區塊鏈的任何狀態,對它的調用使用call就可以了。

2.2 編譯合約

由于合約是使用Solidity編寫,所以我們可以使用web3.eth.compile.solidity來編譯合約[3]

//編譯合約
let source = "pragma solidity ^0.4.0;contract Calc{  /*區塊鏈存儲*/  uint count;  /*執行會寫入數據,所以需要`transaction`的方式執行。*/  function add(uint a, uint b) returns(uint){    count++;    return a + b;  }  /*執行不會寫入數據,所以允許`call`的方式執行。*/  function getCount() returns (uint){    return count;  }}";

let calc = web3.eth.compile.solidity(source);

如果編譯成功,結果如下:

{
    code: '0x606060405234610000575b607e806100176000396000f3606060405260e060020a6000350463771602f781146026578063a87d942c146048575b6000565b3460005760366004356024356064565b60408051918252519081900360200190f35b3460005760366077565b60408051918252519081900360200190f35b6000805460010190558181015b92915050565b6000545b9056',
    info: {
        source: 'pragma solidity ^0.4.0;contract Calc{  /*區塊鏈存儲*/  uint count;  /*執行會寫入數據,所以需要`transaction`的方式執行。*/  function add(uint a, uint b) returns(uint){    count++;    return a + b;  }  /*執行不會寫入數據,所以允許`call`的方式執行。*/  function getCount() returns (uint){    return count;  }}',
        language: 'Solidity',
        languageVersion: '0.4.6+commit.2dabbdf0.Emscripten.clang',
        compilerVersion: '0.4.6+commit.2dabbdf0.Emscripten.clang',
        abiDefinition: [
            [
                Object
            ],
            [
                Object
            ]
        ],
        userDoc: {
            methods: {
                
            }
        },
        developerDoc: {
            methods: {
                
            }
        }
    }
}

3. 發布合約

web3.js其實也像框架一樣對合約的操作進行了封裝。發布合約時,可以使用web3.eth.contractnew方法[4]

let myContractReturned = calcContract.new({
    data: deployCode,
    from: deployeAddr
}, function(err, myContract) {
    if (!err) {
        // 注意:這個回調會觸發兩次
        //一次是合約的交易哈希屬性完成
        //另一次是在某個地址上完成部署

        // 通過判斷是否有地址,來確認是第一次調用,還是第二次調用。
        if (!myContract.address) {
            console.log("contract deploy transaction hash: " + myContract.transactionHash) //部署合約的交易哈希值

            // 合約發布成功
        } else {
        }
});

部署過程中需要主要的是,new方法的回調會執行兩次,第一次是合約的交易創建完成,第二次是在某個地址上完成部署。需要注意的是只有在部署完成后,才能進行方法該用,否則會報錯TypeError: myContractReturned.add is not a function

4. 調用合約

由于web3.js封裝了合約調用的方法。我們可以使用可以使用web3.eth.contract的里的sendTransaction來修改區塊鏈數據。在這里有個坑,有可能會出現Error: invalid address,原因是沒有傳from,交易發起者的地址。在使用web3.js的API都需留意,出現這種找不到地址的,都看看from字段吧。

            //使用transaction方式調用,寫入到區塊鏈上
            myContract.add.sendTransaction(1, 2,{
                from: deployeAddr
            });

            console.log("after contract deploy, call:" + myContract.getCount.call());

需要注意的是,如果要修改區塊鏈上的數據,一定要使用sendTransaction,這會消耗gas。如果不修改區塊鏈上的數據,使用call,這樣不會消耗gas

5. 使用web3.js編譯,發布,調用的完整源碼

let Web3 = require('web3');
let web3;

if (typeof web3 !== 'undefined') {
    web3 = new Web3(web3.currentProvider);
} else {
    // set the provider you want from Web3.providers
    web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));
}

let from = web3.eth.accounts[0];

//編譯合約
let source = "pragma solidity ^0.4.0;contract Calc{  /*區塊鏈存儲*/  uint count;  /*執行會寫入數據,所以需要`transaction`的方式執行。*/  function add(uint a, uint b) returns(uint){    count++;    return a + b;  }  /*執行不會寫入數據,所以允許`call`的方式執行。*/  function getCount() constant returns (uint){    return count;  }}";
let calcCompiled = web3.eth.compile.solidity(source);

console.log(calcCompiled);
console.log("ABI definition:");
console.log(calcCompiled["info"]["abiDefinition"]);

//得到合約對象
let abiDefinition = calcCompiled["info"]["abiDefinition"];
let calcContract = web3.eth.contract(abiDefinition);

//2. 部署合約

//2.1 獲取合約的代碼,部署時傳遞的就是合約編譯后的二進制碼
let deployCode = calcCompiled["code"];

//2.2 部署者的地址,當前取默認賬戶的第一個地址。
let deployeAddr = web3.eth.accounts[0];

//2.3 異步方式,部署合約
let myContractReturned = calcContract.new({
    data: deployCode,
    from: deployeAddr
}, function(err, myContract) {
    if (!err) {
        // 注意:這個回調會觸發兩次
        //一次是合約的交易哈希屬性完成
        //另一次是在某個地址上完成部署

        // 通過判斷是否有地址,來確認是第一次調用,還是第二次調用。
        if (!myContract.address) {
            console.log("contract deploy transaction hash: " + myContract.transactionHash) //部署合約的交易哈希值

            // 合約發布成功后,才能調用后續的方法
        } else {
            console.log("contract deploy address: " + myContract.address) // 合約的部署地址

            //使用transaction方式調用,寫入到區塊鏈上
            myContract.add.sendTransaction(1, 2,{
                from: deployeAddr
            });

            console.log("after contract deploy, call:" + myContract.getCount.call());
        }

        // 函數返回對象`myContractReturned`和回調函數對象`myContract`是 "myContractReturned" === "myContract",
        // 所以最終`myContractReturned`這個對象里面的合約地址屬性也會被設置。
        // `myContractReturned`一開始返回的結果是沒有設置的。
    }
});

//注意,異步執行,此時還是沒有地址的。
console.log("returned deployed didn't have address now: " + myContractReturned.address);

//使用非回調的方式來拿到返回的地址,但你需要等待一段時間,直到有地址,建議使用上面的回調方式。
/*
setTimeout(function(){
  console.log("returned deployed wait to have address: " + myContractReturned.address);
  console.log(myContractReturned.getCount.call());
}, 20000);
*/

//如果你在其它地方已經部署了合約,你可以使用at來拿到合約對象
//calcContract.at(["0x50023f33f3a58adc2469fc46e67966b01d9105c4"]);

關于作者

專注基于以太坊(Ethereum)的相關區塊鏈(Blockchain)技術,了解以太坊,Solidity,Truffle,web3.js。

個人博客: http://me.tryblockchain.org
版權所有,轉載注明出處

參考資料


  1. https://github.com/ethereum/wiki/wiki/JavaScript-API#adding-web3 ? ?

  2. https://nodejs.org/en/download/package-manager/ ?

  3. http://web3.tryblockchain.org/Web3.js-api-refrence.html#toc_56 ?

  4. http://web3.tryblockchain.org/Web3.js-api-refrence.html#toc_51 ?

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,316評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,481評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,241評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,939評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,697評論 6 409
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,182評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,247評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,406評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,933評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,772評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,973評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,516評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,209評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,638評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,866評論 1 285
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,644評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,953評論 2 373

推薦閱讀更多精彩內容

  • 一、區塊鏈 1. 分布式去中心化 比特幣設計的初衷就是要避免依賴中心化的機構,沒有發行機構,也不可能操縱發行數量。...
    Tenny1225閱讀 33,795評論 5 35
  • 將一個UIView顯示在最前面只需要調用其父視圖的bringSubviewToFront()方法。 將一個UIVi...
    萬總有點菜閱讀 216評論 0 0
  • 世人怕老,說到底怕的是死。然而,是人終究會死掉的,這大約是誰也沒法阻擋的事情。那些故去的親人離開我們,如同出一趟遠...
    卿云lusindaen閱讀 812評論 1 1
  • 說起甄子丹,大家想到的就是他拍的葉問了,雖然是一代武打boss,但大家都覺得人不怎么樣,反觀趙文卓就不一樣了,而且...
    段子手萬千閱讀 627評論 0 0
  • 昨天聽林老師講 “微弱偏亮”原理: 大意是,只要是兩個不同的色彩產生交界線,那么就會有明暗對比,而在明的那一側邊緣...
    Hushering閱讀 445評論 0 0