2021-9-24 前端達人
web3.js是以太坊提供的一個Javascript庫,它封裝了以太坊的JSON RPC API,提供了一系列與區(qū)塊鏈交互的Javascript對象和函數(shù),包括查看網(wǎng)絡狀態(tài),查看本地賬戶、查看交易和區(qū)塊、發(fā)送交易、編譯/部署智能合約、調(diào)用智能合約等,其中最重要的就是與智能合約交互的API。
下面就介紹如何使用web3.js提供的接口調(diào)用智能合約。
系統(tǒng)和軟件
-
Ubuntu 16.04 64位
-
nodejs 6.10.0
-
npm 3.10.10
示例合約
本文以下面的MetaCoin合約為例,說明在應用中使用web3.js操作智能合約的方法。
-
// 本文中用到的MetaCoin合約
-
pragma solidity ^0.4.2;
-
-
contract MetaCoin {
-
mapping (address => uint) balances;
-
-
event Transfer(address indexed _from, address indexed _to, uint256 _value);
-
-
function MetaCoin() {
-
balances[tx.origin] = 10000;
-
}
-
-
function sendCoin(address receiver, uint amount) returns(bool sufficient) {
-
if (balances[msg.sender] < amount) return false;
-
balances[msg.sender] -= amount;
-
balances[receiver] += amount;
-
Transfer(msg.sender, receiver, amount);
-
return true;
-
}
-
-
function getBalance(address addr) returns(uint) {
-
return balances[addr];
-
}
-
}
這個合約有三個函數(shù):
MetaCoin:構(gòu)造函數(shù),在合約被部署到區(qū)塊鏈時執(zhí)行
getBalance:返回某賬戶的余額,它只讀數(shù)據(jù),不會修改數(shù)據(jù)
sendCoin:向另一個賬戶發(fā)送指定數(shù)量的MetaCoin,它會改變狀態(tài)變量balances
啟動一個以太坊節(jié)點,將上面的合約部署到區(qū)塊鏈中,并記錄下合約的地址,可以通過truffle部署,具體參考這篇文章。 接下來就可以按照下面的步驟在項目中通過web3.js來使用這個合約。
添加web3到項目中
首先新建一個Nodejs項目并初始化:
-
$ mkdir web3test && cd web3test
-
$ npm init
會提示輸入項目信息,全部默認即可。
接下來下載web3.js到項目中:
$ npm install web3 --save
以上命令會將web3.js下載到web3test/node_modules目錄下,其中–save參數(shù)會web3.js添加到package.json配置文件中。
創(chuàng)建web3對象
要使用web3.js與區(qū)塊鏈交互,需要先創(chuàng)建web3對象,然后連接到以太坊節(jié)點。 在web3test目錄下新建index.js文件,在其中輸入以下代碼:
-
var Web3 = require("web3");
-
// 創(chuàng)建web3對象
-
var web3 = new Web3();
-
// 連接到以太坊節(jié)點
-
web3.setProvider(new Web3.providers.HttpProvider("http://localhost:8545"));
獲取已部署的合約實例
要使用智能合約,必須先從區(qū)塊鏈中獲取到合約實例,獲取合約實例需要合約的ABI和合約的地址:
-
// 合約ABI
-
var abi = [{"constant":false,"inputs":[{"name":"receiver","type":"address"},{"name":"amount","type":"uint256"}],"name":"sendCoin","outputs":[{"name":"sufficient","type":"bool"}],"payable":false,"type":"function"},{"constant":false,"inputs":[{"name":"addr","type":"address"}],"name":"getBalance","outputs":[{"name":"","type":"uint256"}],"payable":false,"type":"function"},{"inputs":[],"payable":false,"type":"constructor"},{"anonymous":false,"inputs":[{"indexed":true,"name":"_from","type":"address"},{"indexed":true,"name":"_to","type":"address"},{"indexed":false,"name":"_value","type":"uint256"}],"name":"Transfer","type":"event"}];
-
// 合約地址
-
var address = "0xb2cdd356e58280906ce53e1665697b50f88aac56";
-
// 通過ABI和地址獲取已部署的合約對象
-
var metacoin = web3.eth.contract(abi).at(address);
metacoin就是獲取到的合約對象實例,此時metacoin對象中就包含了與合約函數(shù)同名的Javascript函數(shù),之后就可以通過metacoin對象來調(diào)用合約中的函數(shù)了。
調(diào)用合約函數(shù)
MetaCoin合約中有兩個函數(shù):getBalance和sendCoin,可以通過metacoin對象直接調(diào)用這兩個函數(shù)。
首先來看getBalance,由于getBalance函數(shù)只是從區(qū)塊鏈中讀數(shù)據(jù),而不修改數(shù)據(jù),因此我們通過在getBalance后面加上.call()的方式調(diào)用:
-
var account_one = web3.eth.accounts[0];
-
var account_one_balance = metacoin.getBalance.call(account_one);
-
console.log("account one balance: ", account_one_balance.toNumber());
這里:
在getBalance后加上.call()來顯式指明用call的方式調(diào)用
通過call的方式調(diào)用可以得到getBalance函數(shù)的返回值
通過call的方式調(diào)用的函數(shù)只在節(jié)點本地虛擬機中執(zhí)行,不會產(chǎn)生交易,不會花費費用,不會修改數(shù)據(jù)
下面來看sendCoin函數(shù),由于sendCoin要修改合約內(nèi)部的數(shù)據(jù),所以要使sendCoin生效,必須要向區(qū)塊鏈發(fā)送交易,可以在sendCoin后面加上.sendTransaction()來指明這是一筆交易:
-
var account_one = web3.eth.accounts[0];
-
var account_two = web3.eth.accounts[1];
-
// 提交交易到區(qū)塊鏈,會立即返回交易hash,但是交易要等到被礦工收錄到區(qū)塊中后才生效
-
var txhash = metacoin.sendCoin.sendTransaction(account_two, 100, {from:account_one});
-
console.log(txhash);
這里:
在sendCoin函數(shù)后加上.sendTransaction()指明要向區(qū)塊鏈發(fā)送交易
合約代碼中sendCoin函數(shù)只有兩個參數(shù),而在web3中通過.sendTransaction()調(diào)用合約函數(shù)的時候需要增加最后一個參數(shù),它是一個javascript對象,里面可以指定from/value/gas等屬性,上面的例子用from來指定交易的發(fā)送者
上面的調(diào)用語句執(zhí)行后,會向區(qū)塊鏈提交一筆交易,這筆交易的發(fā)送者是account_one,接收者是metacoin的地址,交易的作用是以account_two和100作為參數(shù)執(zhí)行合約的sendCoin函數(shù)
函數(shù)會立即返回交易的hash,表明交易已經(jīng)提交到區(qū)塊鏈,但是并不知道交易何時處理完成,交易要等到被曠工收錄到區(qū)塊中后才會生效
監(jiān)聽合約事件
當通過.sendTransaction()調(diào)用合約的時候,交易會被提交到區(qū)塊鏈進行處理,這個處理需要一定的時間,如果需要等交易完成之后再執(zhí)行其他操作,就必須要知道交易何時完成,那么如何知道交易何時完成呢?可以通過監(jiān)聽合約事件來實現(xiàn)。
在合約中可以定義事件,事件可以帶有參數(shù),在合約函數(shù)內(nèi)部完成某些操作時,可以觸發(fā)事件,向外界傳達一些信息。例如,在MetaCoin合約中定義了一個事件叫做Transfer,表示一個轉(zhuǎn)賬的事件,它帶有三個參數(shù):交易的發(fā)送者、接受者、轉(zhuǎn)賬數(shù)量。在sendCoin函數(shù)中,轉(zhuǎn)賬成功后就會觸發(fā)Transfer事件,將對應的參數(shù)傳給該事件,這樣外部監(jiān)聽到事件后,可以取出事件的參數(shù)來獲得交易發(fā)送者、接收者、數(shù)量。同時事件中還帶有其他信息,比如交易hash等。
在web3中使用事件,要首先獲取事件對象,然后監(jiān)聽事件,如果事件發(fā)生,就會在回調(diào)函數(shù)中獲取到事件信息:
-
// 獲取事件對象
-
var myEvent = metacoin.Transfer();
-
// 監(jiān)聽事件,監(jiān)聽到事件后會執(zhí)行回調(diào)函數(shù)
-
myEvent.watch(function(err, result) {
-
if (!err) {
-
console.log(result);
-
} else {
-
console.log(err);
-
}
-
myEvent.stopWatching();
-
});
-
-
// 輸出:
-
{ address: '0xb2cdd356e58280906ce53e1665697b50f88aac56',
-
blockNumber: 651,
-
transactionIndex: 0,
-
transactionHash: '0xcc71bc2824cc84d1ee831c46189e3a80cf0af05697ba0370693aa97390c8067b',
-
blockHash: '0x1d53f04206f3926d0f311b1230a9dd0b0c5aadac35b169a6a609e384ab130c6f',
-
logIndex: 0,
-
removed: false,
-
event: 'Transfer',
-
args:
-
{ _from: '0x68b73956d704007514e9257813bdc58cdf3c969a',
-
_to: '0x9c3c1a2f5ef913fac44f0348a78f68d835f3f26e',
-
_value: { [String: '100'] s: 1, e: 2, c: [Object] } } }
從輸出可以看出,獲取到的事件信息包括事件的參數(shù)、事件名、區(qū)塊號、交易hash等。
通過檢測事件中的transactionHash與調(diào)用合約函數(shù)返回的交易hash是否一致,可以判定某一筆交易是否已完成:
-
var account_one = web3.eth.accounts[0];
-
var account_two = web3.eth.accounts[1];
-
-
var account_one_balance = metacoin.getBalance.call(account_one);
-
console.log("account one balance:", account_one_balance.toNumber());
-
-
var txhash = metacoin.sendCoin.sendTransaction(account_two, 100, { from: account_one });
-
-
var myEvent = metacoin.Transfer();
-
myEvent.watch(function (err, result) {
-
if (!err) {
-
if (result.transactionHash == txhash) {
-
var account_one_balance = metacoin.getBalance.call(account_one);
-
console.log("account one balance after sendCoin:", account_one_balance.toNumber());
-
}
-
} else {
-
console.log(err);
-
}
-
myEvent.stopWatching();
-
});
-
-
// 輸出:
-
account one balance: 7000
-
account one balance after sendCoin: 6900
watch中的回調(diào)函數(shù)如果被執(zhí)行,說明事件已被觸發(fā),也就是說某筆交易已經(jīng)處理完,檢查交易hash是否一致,可以判定產(chǎn)生這個事件的交易是否是自己發(fā)送的交易,如果是,就可以進行其他操作,比如查詢最新的余額
分享此文一切功德,皆悉回向給文章原作者及眾讀者.
轉(zhuǎn)自:csdn
免責聲明:藍藍設計尊重原作者,文章的版權歸原作者。如涉及版權問題,請及時與我們?nèi)〉寐?lián)系,我們立即更正或刪除。
藍藍設計( m.91whvog3.cn )是一家專注而深入的界面設計公司,為期望卓越的國內(nèi)外企業(yè)提供卓越的UI界面設計、BS界面設計 、 cs界面設計 、 ipad界面設計 、 包裝設計 、 圖標定制 、 用戶體驗 、交互設計、 網(wǎng)站建設 、平面設計服務
藍藍設計的小編 http://m.91whvog3.cn