hyperledger fabric超級賬本java sdk樣例e2e程式碼流程分析
阿新 • • 發佈:2018-12-05
一 checkConfig Before
1.1 private static final TestConfig testConfig = TestConfig.getConfig();
這裡載入一個配置檔案(test路徑/src/test/java/org/hyperledger/fabric/sdk/testutils.properties,檔案不存在就載入程式碼中寫死的預設配置),
配置檔案需要設定peer,orderer,ca,eventhub的地址,組織mspid,組織域名。解析配置檔案,將資訊載入到sampleOrgs中,如果與CA通訊
啟用了tls,需要在sampleOrg中(欄位caProperties)儲存與CA通訊的tls證書位置(src/test/fixture/sdkintegration/e2e-2Orgs/$(FAB_CONFIG_GEN_VERS)/crypto-config/peerOrganizations/$(DNAME)/ca/ca.$(DNAME)-cert.pem),用於之後為組織建立CA客戶端,
當前樣例中與CA通訊預設沒有啟用TLS。
****注意sampleOrgs是一個重要的變數,儲存了所有的配置資訊,並且之後加入組織的成員資訊也儲存到sampleOrgs中,sampleOrgs集合中一
個典型組織結構如下:
1.2 為每個組織設定CA客戶端
從testConfig中獲取到sampleOrgs到testSampleOrgs中,遍歷每個組織並設定每個組織建立CA客戶端,使用者之後訪問CA伺服器。
二 setup Test
setup為測試主要流程實現,包括建立user,admin,peerAdmin,為每個使用者獲取CA證書,建立channel,安裝鏈碼,例項化鏈碼,設定事件,進行交易
幾個部分。
2.1 為每個組織建立使用者,也儲存在sampleOrgs中
組織的使用者資訊與常規配置不同,在程式執行區間會有動態新增使用者的需求,並且程式在執行時,需要儲存使用者的資訊。樣例中為了簡單,將使用者例項物件序列化到檔案中,所以這裡第一步先去檔案中恢復使用者資訊到sampleOrg中。
反序列化本地快取的使用者物件(/tmp/HFCSampletest)到sampleStore中
sampleStore = new SampleStore(sampleStoreFile);
enrollUsersSetup(sampleStore); //This enrolls users with fabric ca and setups sample store to get users later.
1) 先獲取組織的CA客戶端例項;
2) 設定CA例項的加密套件,用於加解密和驗證;
3) 建立使用者,並通過ca.enroll(user, secret) 向CA服務端申請證書。
keypair = cryptoSuite.keyGen(); // generate ECDSA keys: signing and encryption keys,非對稱加密生成私鑰
//url:ca地址; body:通過kvpair和user生成; 加上user和secret去申請證書,最後從response中解析出證書
String responseBody = httpPost(url + HFCA_ENROLL, body, new UsernamePasswordCredentials(user, secret));
這裡需要例項化三種使用者。
首先是admin,即登陸ca的管理員使用者,預設賬號密碼"admin", "adminpw"。這個使用者在ca伺服器啟動時就有,先嚐試從使用者儲存檔案中獲取,沒有的話直接從CA中獲取keypair和證書即可。所有的使用者抽象為sampleUser的結構,如下圖,keypaire和證書儲存在enrollment中。另外所有的使用者都儲存到sampleOrg中。
2) 將sampleOrg下所有的orderer地址,例項化orderer物件,做成orderers集合
然後是普通使用者,普通使用者可以有多個,先嚐試從序列化後的使用者儲存檔案中獲取,沒有的話需要先從CA註冊,再建立keypair,申請證書。最後儲存到sampleOrg欄位usermap中
sampleOrg sampleorg: 組織集合,包括orderer的地址(與orderer通訊時使用的tls證書是啟動CA後去申請的),peer地址,user,admin,peerAdmin Orderers集合: tls證書和orderer地址 HFCCient client: cryptoSuite加密解密元件, channel(需要通過tx配置,組織envelope,用peerAdmin簽名後,用orderer物件原子廣播生成channel), userContext(對最後要傳送的envelpe做簽名,如在建立channel時就是用peerAdmin物件的金鑰去做簽名,那就設定為peerAdmin, 如果是傳送一筆普通交易,則可以用普通user做簽名) channel fooChannel: runFabricTest 1 建立HFClient,一個client配一個channel例項 設定client的加密元件,用於加密,解密,驗證。 2 建立channel 獲取org1的例項sampleOrg 建立channel例項,傳入client和sampleOrg Channel fooChannel = constructChannel(FOO_CHANNEL_NAME, client, sampleOrg); 1) 設定userContext client.setUserContext(sampleOrg.getPeerAdmin());orderers.add(client.newOrderer(orderName, sampleOrg.getOrdererLocation(orderName), ordererProperties)); 3) 選擇集合中的第一個orderer去建立channel 先讀取[channel name].tx配置檔案到ChannelConfiguration channelConfiguration物件中 然後建立channel,依據channel建立策略去建立channel,這裡只需要peerAdmin的簽名,如果策略需要更多,則需要指定更多 public Channel newChannel(String name, Orderer orderer, ChannelConfiguration channelConfiguration, byte[]... channelConfigurationSignatures) Channel newChannel = client.newChannel(name, anOrderer, channelConfiguration, client.getChannelConfigurationSignature(channelConfiguration, sampleOrg.getPeerAdmin())); newChannnel實現流程,[channelName].tx實際就是一個envelope結構體,先發序列化出來
反序列化payload
反序列化payload的header中的channelheader
校驗下header的值,common.java中定義了type的值:public enum HeaderType,這裡我們tx中應該為CONFIG_UPDATE(2),表示一筆更新channel配置的交易
接著反序列化payload的data域,configUpdateEnv
獲取其中的configUpdate欄位內容,傳送 從中會重新構建一個envelope,做簽名後,再用orderer物件傳送(傳送給orderer物件中儲存的地址,使用其tls證書) private void sendUpdateChannel(byte[] configupdate, byte[][] signers, Orderer orderer) 這裡就要建立channel了 1) 先構建一個交易上下文 TransactionContext transactionContext = getTransactionContext(); 從中呼叫new TransactionContext(this, userContext, client.getCryptoSuite());返回交易上下文物件
cryptoPrimititives: client.getCrytoSuite() 加密解密驗證套件, userContext(即2-1中定義,主要是使用其公私鑰來給envelope做簽名),channel當前的channel物件,identity身份認證資訊
2)構建上下文物件後,要構建envelope,會使用上下文物件來作簽名。重要:上下文物件中包含client的usercontext,這裡要區別開建立channel傳進來的signer,signer是直接把序列化的證書byte存到了envelope中的payload中的data域(data域為一個configupdateenv結構,包含了signatures欄位)。而上下文物件中的client的usercontext則是用來對envelope各個部分做簽名(包括payload整體做簽名(放到envelope的開始),payload的header,payload的data) 猜測:signer可以自己設定任意使用者,任意多個簽名byte,即指定channel設定的一個策略??????? 2-1)建立configupdateenv,同上面的configUpdateEnvelope結構,這裡重新構建信封結構,添加簽名。 這裡簽名只有peerAdmin的簽名。configupdateEnv將作為envelope payload結構中data域 2-2)然後設定envelope payload結構的header域,header域包括channel header(包含type,是普通交易還是channel配置等等和交易txid),signatureheader(簽名頭) final ByteString sigHeaderByteString = getSignatureHeaderAsByteString(transactionContext); //signatureheader由交易上下文生成 final ChannelHeader payloadChannelHeader = ProtoUtils.createChannelHeader(HeaderType.CONFIG_UPDATE, transactionContext.getTxID(), name, transactionContext.getEpoch(), transactionContext.getFabricTimestamp(), null, null); //channel header final Header payloadHeader = Header.newBuilder().setChannelHeader(payloadChannelHeader.toByteString()) .setSignatureHeader(sigHeaderByteString).build(); //設定envelope payload的header 2-3)設定envelope payload的data域 final ByteString payloadByteString = Payload.newBuilder() .setHeader(payloadHeader) .setData(configUpdateEnvBuilder.build().toByteString()) .build().toByteString(); 2-4)設定整個envelope ByteString payloadSignature = transactionContext.signByteStrings(payloadByteString); Envelope payloadEnv = Envelope.newBuilder() .setSignature(payloadSignature) .setPayload(payloadByteString).build(); 2-5)根據orderer中設定的orderer地址和tls,使用原子廣播發送信封 BroadcastResponse trxResult = orderer.sendTransaction(payloadEnv); 至此channel建立完畢,將建立的channel加入到去安居channels變數中 後續參見End2endIT.java 844 // Set peer to not be all roles but eventing. 1) newChannel.joinPeer(peer, createPeerOptions().setPeerRoles(PeerRole.NO_EVENT_SOURCE)); 新增所有的peer到channel中,peer物件的屬性在sampleOrg中儲存 2) for (Orderer orderer : orderers) { //add remaining orderers if any. newChannel.addOrderer(orderer); } 新增所有的orderer到channel中 3) 設定eventhub,其實是設定與eventhub服務端的連線,後面去交易的時候才去設定監聽的事件 3 回到End2endIT.java 206行,在建立channel後安裝例項化鏈碼 sampleStore.saveChannel(fooChannel); 在sampleStore中本地序列化儲存建立的channel物件 然後runChannel runChannel(client, fooChannel, true, sampleOrg, 0); 3-1) 註冊了chaincode事件 3-1) 第一步,先安裝鏈碼,所有的peer都要安裝,安裝鏈碼只需要封裝proposal傳送給peers就可以了 Collection<Peer> peers = channel.getPeers(); numInstallProposal = numInstallProposal + peers.size(); responses = client.sendInstallProposal(installProposalRequest, peers); 3-2) 例項化鏈碼 responses = channel.sendInstantiationProposal(instantiateProposalRequest, channel.getPeers()); //封裝proposal併發送給peer 3-3) 傳送交易,例項化鏈碼也當作一筆交易處理,需要進行orderer排序,commiter驗證提交 channel.sendTransaction(successful, createTransactionOptions() //Basically the default options but shows it's usage. .userContext(client.getUserContext()) //could be a different user context. this is the default. .shuffleOrders(false) // don't shuffle any orderers the default is true. .orderers(channel.getOrderers()) // specify the orderers we want to try this transaction. Fails once all Orderers are tried. .nOfEvents(nOfEvents) // The events to signal the completion of the interest in the transaction ) successful是所有交易提案的結果集合 在sendTransaction中,封裝一個envelope,不同於channel建立中的envelope,這個envelope中payload封裝為交易提案response,response為 多個背書節點的響應,這裡拿出來一個,ed是所有背書的集合(讀寫集簽名),proposalResponsePayload為提案結果payload,共同作為payload for (ProposalResponse sdkProposalResponse : proposalResponses) { ed.add(sdkProposalResponse.getProposalResponse().getEndorsement()); if (proposal == null) { proposal = sdkProposalResponse.getProposal(); proposalTransactionID = sdkProposalResponse.getTransactionID(); proposalResponsePayload = sdkProposalResponse.getProposalResponse().getPayload(); } } Payload transactionPayload = transactionBuilder .chaincodeProposal(proposal) .endorsements(ed) .proposalResponsePayload(proposalResponsePayload).build(); Envelope transactionEnvelope = createTransactionEnvelope(transactionPayload, userContext) resp = orderer.sendTransaction(transactionEnvelope); 3118行,傳送信封,這裡會逐個orderer依次傳送,哪個返回success,就break。 4 執行chaincode client.setUserContext(sampleOrg.getUser(TESTUSER_1_NAME)); //重要:執行交易使用普通使用者對envelope做簽名即可 /////////////// /// Send transaction proposal to all peers TransactionProposalRequest transactionProposalRequest = client.newTransactionProposalRequest(); transactionProposalRequest.setChaincodeID(chaincodeID); transactionProposalRequest.setChaincodeLanguage(CHAIN_CODE_LANG); //transactionProposalRequest.setFcn("invoke"); transactionProposalRequest.setFcn("move"); transactionProposalRequest.setProposalWaitTime(testConfig.getProposalWaitTime()); transactionProposalRequest.setArgs("a", "b", "100") 掠過交易提案過程,這裡獲取到所有提案結果successful後,設定併發送envelope給orderer 634 out("Sending chaincode transaction(move a,b,100) to orderer."); eturn channel.sendTransaction(successful).get(testConfig.getTransactionWaitTime(), TimeUnit.SECONDS); 執行到sendTransaction channel.java 3079 return sendTransaction(proposalResponses, createTransactionOptions().orderers(orderers).userContext(userContext)); 然後同例項化鏈碼一樣,3179行,封裝envelope併發送給orderer public CompletableFuture<TransactionEvent> sendTransaction(Collection<ProposalResponse> proposalResponses,TransactionOptions transactionOptions)