利用Hyperledger Fabric开发第一个区块链应用
利用Hyperledger Fabric開發第一個區塊鏈應用
- Fabric入門
- ?
- Fabric
我們通過一個簡單的示例程序來了解Fabric應用是如何運行的。在這個例子中使用的應用程序和智能合約(鏈碼)統稱為FabCar。這個例子很好地提供了一個開始用于理解Hyperledger Fabric。在這里,你將學會如何開發一個應用程序和智能合約來查詢和更新賬本,如何利用CA來生成一個應用程序需要的用于和區塊鏈交互
本文示例源于fabric-samples中的fabcar
在這個例子中,我們通過一個簡單的示例程序來了解 Fabric 應用是如何運行的。在這個例子中使用的應用程序和智能合約(鏈碼)統稱為FabCar。這個例子很好地提供了一個開始用于理解Hyperledger Fabric。在這里,你將學會如何開發一個應用程序和智能合約來查詢和更新賬本,如何利用CA來生成一個應用程序需要的用于和區塊鏈交互的 X.509 證書。
我們使用應用程序 SDk 來執行智能合約中的查詢更新賬本的操作,這些操作在智能合約中借助底層接口實現。
我們將通過 3 個步驟來進行講解:
?
學習一個簡單的智能合約:FabCar。我們使用JavaScript開發智能合約。我們通過查看智能合約來學習應用程序如何使用智能合約發送交易,如何使用智能合約來查詢和更新賬本。
使用 FabCar 開發一個簡單的應用程序。我們的應用程序會使用FabCar智能合約來查詢及更新賬本上的汽車資產。我們將進入應用程序的代碼中去了解如何創建交易,包括查詢一輛汽車的信息,查詢一批汽車的信息以及創建一輛汽車。
設置區塊鏈網絡
注意:下面的部分需要進入你克隆到本地的fabric-samples倉庫的first-network子目錄。
如果你已經學習了 Building Your First Network,你應該已經下載了fabric-samples而且已經運行起了一個網絡。在你進行本教程之前,你需要停止這個網絡:
./byfn.sh down如果你之前運行過這個教程,使用下面的命令關掉所有停止或者運行的容器。注意,這將關掉所有的容器,不論是否和 Fabric 有關。
docker rm -f $(docker ps -aq) docker rmi -f $(docker images | grep fabcar | awk '{print $3}')如果你沒有這個網絡和應用相關的開發環境和構件,請訪問?Prerequisites頁面(或參考),確保你的機器安裝了必要的依賴。
接下來,如果你還沒有這樣做的話,請瀏覽?Install Samples, Binaries and Docker Images頁面,跟著上面的操作進行。當你克隆了fabric-samples倉庫,下載了最新的穩定版 Fabric 鏡像和相關工具之后回到教程。
如果你使用的是 Mac OS 和 Mojava,你需要安裝Xcode。
啟動網絡
下面的部分需要進入fabric-samples倉庫的fabcar子目錄。
使用startFabric.sh來啟動你的網絡。這個命令將啟動一個區塊鏈網絡,這個網絡由 peer 節點、排序節點、證書授權服務等組成。同時也將安裝和初始化 JavaScript 版本的FabCar智能合約,我們的應用程序將通過它來操作賬本。我們將通過本教程學習更過關于這些組件的內容。
./startFabric.sh javascript現在,我們已經運行起來了一個示例網絡,還安裝和初始化了FabCar智能合約。為了運行我們的應用程序,我們需要安裝一些依賴,同時讓我們看一下它們是如何工作的。
安裝應用程序
注意:下邊的章節需要進入你克隆到本地的fabric-samples倉庫的fabcar/javascript子目錄。
下面的命令來安裝應用程序所需的 Fabric 有關的依賴。大概將話費 1 分鐘左右的時間:
這個指令用于安裝應用程序所需的依賴,這些依賴被定義在package.json中。其中最重要的是fabric-network類;它使得應用程序可以使用身份、錢包和連接到通道的網關,以及提交交易和等待通知。本教程也將使用fabric-ca-client類來注冊用戶以及他們的授權證書,生成一個fabric-network使用的合法的身份。
一旦npm install執行成功,運行應用程序所需的一切就準備好了。在這個教程中,你將主要使用fabcar/javascript目錄下的 JavaScript 文件來操作應用程序。讓我們來了解一下里面有哪些文件:
ls你將看到下列文件:
enrollAdmin.js node_modules package.json registerUser.js invoke.js package-lock.json query.js wallet里面也有一些其他編程語言的文件,比如fabcar/typescript目錄中。當你使用過 JavaScript 示例之后-其實都是類似的。
如果你在使用 Mac OS 而且運行的是 Mojava 你需要[安裝Xcode](https://hyperledger-fabric.readthedocs.io/en/latest/tutorial/installxcode.html)。
登記管理員用戶
下面的部分涉及執行和 CA 服務器通訊的過程。你在執行下面的程序的時候,打開一個終端執行docker logs -f ca.example.com來查看 CA 的日志,會是十分有幫助的。
當我們創建網絡的時候,一個叫admin的用戶已經被授權服務器(CA)創建為登記員。我們第一步要做的是使用enroll.js程序為admin生成私鑰,公鑰和 x.509 證書。這個程序使用一個證書簽名請求 (CSR)--先在本地生成私鑰和公鑰,然后把公鑰發送到 CA,CA 會發布一個應用程序使用的證書。這三個憑證會保存在錢包中,以便于我們以管理員的身份使用 CA。
接下來我們會注冊和登記一個新的應用程序用戶,我們將使用這個用戶來通過應用程序和區塊鏈進行交互。
讓我們登記一個admin用戶:
node enrollAdmin.js這個命令將 CA 管理員證書保存在wallet目錄。
注冊和登記user1
現在我們在錢包里放了管理員的證書,我們可以登記一個新用戶--user1--用這個用戶來查詢和更新賬本:
node registerUser.js和登記管理員類似,這個程序使用了 CSR 來登記user1并把它的證書保存到admin所在的錢包中。現在我們有了 2 個獨立的用戶--admin和user1--它們都將用于我們的應用程序。
接下來是賬本交互時間...
查詢賬本
區塊鏈網絡中的每個節點都擁有一個賬本的副本,應用程序可以通過執行智能合約查詢賬本上的最新舒徐來實現查詢賬本操作,將結果返回給應用程序。
這是一個如何查詢的簡單闡述:
?
應用程序使用查詢從 ledger 讀取數據。最常見的就是查詢當前賬本中的最新值--世界狀態。世界狀態是一個鍵值對的集合,應用程序可以根據一個鍵或者多個鍵來查詢數據。而且,當鍵值對是以 JSON 形式存在的時候,世界狀態可以通過配置使用數據庫(例如 CouchDB)來支持富查詢。這個特性對于查詢匹配特定的鍵的值是很有幫助的,比如查詢一個人的所有汽車。
首先,讓我們使用query.js程序來查詢賬本上的所有汽車。這個程序使用我們的第二個身份--user1--來操作賬本。
node query.js輸出結果如下:
Wallet path: ...fabric-samples/fabcar/javascript/wallet Transaction has been evaluated, result is: [{"Key":"CAR0", "Record":{"colour":"blue","make":"Toyota","model":"Prius","owner":"Tomoko"}}, {"Key":"CAR1", "Record":{"colour":"red","make":"Ford","model":"Mustang","owner":"Brad"}}, {"Key":"CAR2", "Record":{"colour":"green","make":"Hyundai","model":"Tucson","owner":"Jin Soo"}}, {"Key":"CAR3", "Record":{"colour":"yellow","make":"Volkswagen","model":"Passat","owner":"Max"}}, {"Key":"CAR4", "Record":{"colour":"black","make":"Tesla","model":"S","owner":"Adriana"}}, {"Key":"CAR5", "Record":{"colour":"purple","make":"Peugeot","model":"205","owner":"Michel"}}, {"Key":"CAR6", "Record":{"colour":"white","make":"Chery","model":"S22L","owner":"Aarav"}}, {"Key":"CAR7", "Record":{"colour":"violet","make":"Fiat","model":"Punto","owner":"Pari"}}, {"Key":"CAR8", "Record":{"colour":"indigo","make":"Tata","model":"Nano","owner":"Valeria"}}, {"Key":"CAR9", "Record":{"colour":"brown","make":"Holden","model":"Barina","owner":"Shotaro"}}]讓我們近距離看一下這個程序。使用文本編輯器(如 atom 或者 visual studio)打開query.js。
應用程序開始的時候就從fabric-network模塊引入了兩個關鍵的類FileSystemWallet和Gateway。這兩個類將用于定位錢包中user1的身份,并且使用這個身份連接網絡:
const { FileSystemWallet, Gateway } = require('fabric-network');應用程序使用網關連接網絡:
const gateway = new Gateway(); await gateway.connect(ccp, { wallet, identity: 'user1' });這段代碼創建了一個新的網關,然后通過它來讓應用程序連接網絡。cpp描述了網關通過wallet中的user1來連接網絡。打開?../../basic-network/connection.json來查看cpp是如何解析一個 JSON 文件的:
const ccpPath = path.resolve(__dirname, '..', '..', 'basic-network', 'connection.json'); const ccpJSON = fs.readFileSync(ccpPath, 'utf8'); const ccp = JSON.parse(ccpJSON);如果你想了解更多關于連接配置文件的結構以及它是怎么定義網絡的,請查閱?the connection profile topic
一個網絡可以被拆分成很多個通道,代碼中下一個很重要的地方是將應用程序連接到特定的通道mychannel上:
在這個通道中,我們可以通過fabcar智能合約來和賬本進行交互:
const contract = network.getContract('fabcar');在fabcar中有許多不同的交易,我們的應用程序先使用queryAllCars交易來查詢賬本的世界狀態:
const result = await contract.evaluateTransaction('queryAllCars');evaluateTransaction方法呈現了一種和區塊鏈網絡中的智能合約交互的最簡單的方法。它只是根據配置文件中的定義連接一個節點,然后向節點發送請求,在節點內執行該請求。智能合約查詢了節點賬本上的所有汽車,然后把結果返回給應用程序。這次交互并沒有更新賬本。
FabCar 智能合約
讓我們看一看FabCar智能合約里的交易。進入fabric-samples下的子目錄chaincode/fabcar/javascript/lib,然后用你的編輯器打開fabcar.js。
看一下我們的智能合約是如何通過Contract類來定義的:
class FabCar extends Contract {...在這個類結構中,你將看到定義了以下交易:?initLedger,queryCar,queryAllCars,createCar和changeCarOwner。例如:
async queryCar(ctx, carNumber) {...} async queryAllCars(ctx) {...}讓我們更進一步看一下 queryAllCars ,看一下它是怎么和賬本交互的。
async queryAllCars(ctx) {const startKey = 'CAR0';const endKey = 'CAR999';const iterator = await ctx.stub.getStateByRange(startKey, endKey);這段代碼定義了 queryAllCars 將要從賬本獲取的汽車的范圍。從 CAR0 到 CAR999 的每一輛車 -- 一共 1000 輛車,假定每個鍵都被合適地錨定了 -- 將會作為查詢結果被返回。 代碼中剩下的部分,通過迭代將查詢結果打包成 JSON 并返回給應用。
下邊將展示應用程序如何調用智能合約中的不同交易。每一個交易都使用一組 API 比如 getStateByRange 來和賬本進行交互。了解更多 API 請閱讀文檔。
?
你可以看到我們的queryAllCars交易,還有另一個叫做createCar。我們稍后將在教程中使用他們來更新賬本,和添加新的區塊。
但是在那之前,返回到query程序,更改evaluateTransaction的請求來查詢為CAR4。query程序現在如下:
const result = await contract.evaluateTransaction('queryCar', 'CAR4');保存程序,然后返回到fabcar/javascript目錄。現在,再次運行query程序:
node query.js你應該會看到如下所示:
Wallet path: ...fabric-samples/fabcar/javascript/wallet Transaction has been evaluated, result is: {"colour":"black","make":"Tesla","model":"S","owner":"Adriana"}如果你查看一下之前queryAllCars的交易結果,你會看到CAR4是Adriana的黑色 Tesla model S,也就是這里返回的結果,是一樣的。
我們可以使用queryCar交易來查詢任意汽車,使用它的鍵(比如CAR0)得到車輛的制造商、型號、顏色和車主等相關信息。
非常好。現在你應該已經了解了智能合約中基礎的查詢交易,也手動修改了查詢程序中的參數。
是時候進行更新賬本了。
更新賬本
現在我們已經完成一些賬本的查詢操作,添加了一些代碼,我們已經準備好更新賬本了。我們進行更新操作了,但是我們從創建一輛新車開始。
從一個應用程序的角度來說,更新一個賬本很簡單。應用程序向區塊鏈網絡提交一個交易, 當交易被驗證和提交后,應用程序會收到一個交易成功的提醒。但是在底層,區塊鏈網絡中各組件中不同的共識程序協同工作,來保證賬本的每一個更新提案都是合法的,而且有一個大家一致認可的順序。
?
上圖中,我們可以看到完成這項工作的主要組件。同時,多個節點中每一個節點都擁有一份賬本的副本,并可選的擁有一份智能合約的副本,網絡中也有一個排序服務。排序服務保證網絡中交易的一致性;它也將連接到網絡中不同的應用程序的交易以定義好的順序生成區塊。
我們對賬本的的第一個更新是創建一輛新車。我們有一個單獨的程序叫做invoke.js,用來更新賬本。和查詢一樣,使用一個編輯器打開程序定位到我們構建和提交交易到網絡的代碼段:
await contract.submitTransaction('createCar', 'CAR12', 'Honda', 'Accord', 'Black', 'Tom');看一下應用程序如何調用智能合約的交易createCar來創建一輛車主為 Tom 的黑色 Honda Accord 汽車。我們使用CAR12作為這里的鍵,這也說明了我們不必使用連續的鍵。
保存并運行程序:
node invoke.js如果執行成功,你將看到類似輸出:
Wallet path: ...fabric-samples/fabcar/javascript/wallet 2018-12-11T14:11:40.935Z - info: [TransactionEventHandler]: _strategySuccess: strategy success for transaction "9076cd4279a71ecf99665aed0ed3590a25bba040fa6b4dd6d010f42bb26ff5d1" Transaction has been submitted注意inovke程序使用的是submitTransactionAPI 和區塊鏈網絡交互的,而不是evaluateTransaction。
await contract.submitTransaction('createCar', 'CAR12', 'Honda', 'Accord', 'Black', 'Tom');submitTransaction比evaluateTransaction要復雜的多。不只是和單個節點交互,SDK 將把submitTransaction提案發送到區塊鏈網絡中每一個必要的組織的節點。每一個節點都將根據這個提案執行請求的智能合約,并生成一個該節點簽名的交易響應并返回給 SDK 。SDK 將所有經過簽名的交易響應收集到一個交易中,這個交易將會被發送到排序節點。排序節點搜集并排序每個應用的交易,并把這些交易放入到一個交易區塊。然后排序節點將這些區塊分發到網絡中的節點,每一筆交易都會在節點中進行驗證和提交。最后,SDK 會后到提醒,并把控制權返回給應用程序。
submitTransaction也會包括一個監聽器用于確保交易已經被校驗和提交到賬本里了。應用程序需要利用監聽器或者使用submitTransaction接口,它內部已經實現了監聽器。如果沒有監聽器,你可能無法確定交易是否被排序校驗以及提交。
應用程序中的這些工作由submitTransaction完成!應用程序、智能合約、節點和排序服務一起工作來保證網絡中賬本一致性的程序被稱為共識。
為了查看這個被寫入賬本的交易,返回到query.js并將參數CAR4更改為CAR12。
換句話說就是將:
const result = await contract.evaluateTransaction('queryCar', 'CAR4');改為:
const result = await contract.evaluateTransaction('queryCar', 'CAR12');再次保存,然后查詢:
node query.js將返回:
Wallet path: ...fabric-samples/fabcar/javascript/wallet Transaction has been evaluated, result is: {"colour":"Black","make":"Honda","model":"Accord","owner":"Tom"}恭喜。你創建了一輛汽車并驗證了它記錄在賬本上!
現在我們已經完成了,我們假設 Tom 很大方,想把他的 Honda Accord 送給一個叫 Dave 的人。
為了完成這個,返回到invoke.js然后利用輸入的參數,將智能合約的交易從createCar改為changeCarOwner:
await contract.submitTransaction('changeCarOwner', 'CAR12', 'Dave');第一個參數 ---CAR12--- 表示將要易主的車。第二個參數 ---Dave--- 表示車的新主人。
再次保存并執行程序:
node invoke.js現在我們來再次查詢賬本,以確定 Dave 和CAR12鍵已經關聯起來了:
node query.js將返回如下結果:
Wallet path: ...fabric-samples/fabcar/javascript/wallet Transaction has been evaluated, result is: {"colour":"Black","make":"Honda","model":"Accord","owner":"Dave"}CAR12的主人已經從 Tom 變成了 Dave。
在實際的應用中,智能合約有權限控制邏輯。舉個例子,只有有權限的用戶可以創建新車,只有車子的擁有者可以轉移車輛所屬權。
總結
現在我們已經完成了賬本的查詢和更新,你也應該比較了解如何通過智能合約和區塊鏈進行交互來查詢賬本和更新賬本了。在教程中已經講解了查詢和更新的智能合約,API 和 SDK,想必你對其他商業場景也有了一定的了解和認識。
通過FabCar這個例子,我們可以快速學習如何基于Node SDK開發應用程序。
本文首發于我的博客:TopJohn’s Blog
?
- ?發表于 2019-04-22 11:04
- ?
- 閱讀 ( 3396 )
- ?
總結
以上是生活随笔為你收集整理的利用Hyperledger Fabric开发第一个区块链应用的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Hyperledger Besu企业以太
- 下一篇: 4.4 开发模式下的测试:简化我们对链码