-
- | 属性 |
- 名称 |
- 说明 |
-
-
- | Address |
- 地址 |
- 账户的唯一标识 |
-
-
- | RegNumber |
- 注册号 |
- 账户被注册到区块链的区块高度； |
-
-
- | TxSquenceNumber |
- 交易序列号 |
- 由账户发起的交易的序列号，初始为 0，账户每发起一个交易则增加1； |
-
-
- | ModelVersion |
- 账户模型版本 |
- 表示构成一个账户结构的属性模型的程序版本号； |
-
-
- | Version |
- 账户版本 |
- 初始为 0，对账户的每一次变更(包括对权限设置、状态和合约代码的变更)都会使账户状态版本增加 1 ；
注：交易序号的改变不会导致账户版本的增加； |
-
-
- | PrivilegeHash |
- 权限 hash |
- 权限树的根hash； |
-
-
- | PrivilegeVersion |
- 权限版本 |
- 初始为 0， 每次对权限的变更都导致版本号加 1； |
-
-
- | StateType |
- 状态类型 |
- 账户的状态类型有3种：空类型(NIL)；键值类型；对象类型； |
-
-
- | StateVersion |
- 状态版本 |
- 账户的状态类型有3种：空类型(NIL)；键值类型；对象类型； |
-
-
- | StateHash |
- 状态哈希 |
- 数据状态的 merkle tree 的根hash； |
-
-
- | CodeHash |
- 合约代码哈希 |
- 由“账户地址+合约代码版本号+合约代码内容”生成的哈希； |
-
-
- | CodeVersion |
- 代码版本 |
- 初始为 0，每次对代码的变更都使版本加 1 ； |
-
-
-
-## 五、编程接口
-
-### 1. 服务连接
-
-
-```java
- //创建服务代理
- public static BlockchainKeyPair CLIENT_CERT = BlockchainKeyGenerator.getInstance().generate();
- final String GATEWAY_IP = "127.0.0.1";
- final int GATEWAY_PORT = 80;
- final boolean SECURE = false;
- GatewayServiceFactory serviceFactory = GatewayServiceFactory.connect(GATEWAY_IP, GATEWAY_PORT, SECURE,
- CLIENT_CERT);
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
-```
+## 一、项目介绍
+JD Chain 的目标是实现一个面向企业应用场景的通用区块链框架系统，能够作为企业级基础设施，为业务创新提供高效、灵活和安全的解决方案。
-### 2. 用户注册
+## 二、部署模型
+JD Chain 主要部署组件包括以下几种：
-```java
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
- // 在本地定义注册账号的 TX；
- TransactionTemplate txTemp = service.newTransaction(ledgerHash);
- SignatureFunction signatureFunction = asymmetricCryptography.getSignatureFunction(CryptoAlgorithm.ED25519);
- CryptoKeyPair cryptoKeyPair = signatureFunction.generateKeyPair();
- BlockchainKeyPair user = new BlockchainKeyPair(cryptoKeyPair.getPubKey(), cryptoKeyPair.getPrivKey());
-
- txTemp.users().register(user.getIdentity());
+- 共识节点
- // TX 准备就绪；
- PreparedTransaction prepTx = txTemp.prepare();
- // 使用私钥进行签名；
- CryptoKeyPair keyPair = getSponsorKey();
- prepTx.sign(keyPair);
+ 共识节点即参与共识的节点，这是系统的核心组件，承担了运行共识协议、管理账本数据、运行智能合约的职责。
- // 提交交易；
- prepTx.commit();
-```
+ 一个区块链网络由多个共识节点组成，共识节点的数量范围由选择的共识协议决定。
+ 共识节点和账本是两个不同的概念，共识节点是个物理上的概念，账本是个逻辑上的概念。JD Chain 是一个多账本区块链系统，一个共识节点上可以装载运行多个账本。账本是数据维度的独立管理单元。共识节点和账本的关系，就像关系数据库系统中，数据库服务器和数据库实例的关系。
-### 3. 数据账户注册
+ 共识节点通常都部署在参与方的内部网络中，通过由网络管理员指定的安全的网络出口与其它的共识节点建立通讯连接。
+ 共识节点在形态上是服务器中的一个处理进程，背后需要连接一个本地或者内网的NoSQL数据库系统作为账本的存储。当前版本，共识节点目前是单进程的，未来版本将实现多进程以及多服务器集群模式。
-```java
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
- // 在本地定义注册账号的 TX；
- TransactionTemplate txTemp = service.newTransaction(ledgerHash);
- SignatureFunction signatureFunction = asymmetricCryptography.getSignatureFunction(CryptoAlgorithm.ED25519);
- CryptoKeyPair cryptoKeyPair = signatureFunction.generateKeyPair();
- BlockchainKeyPair dataAccount = new BlockchainKeyPair(cryptoKeyPair.getPubKey(), cryptoKeyPair.getPrivKey());
-
- txTemp.dataAccounts().register(dataAccount.getIdentity());
-
- // TX 准备就绪；
- PreparedTransaction prepTx = txTemp.prepare();
- // 使用私钥进行签名；
- CryptoKeyPair keyPair = getSponsorKey();
- prepTx.sign(keyPair);
-
- // 提交交易；
- prepTx.commit();
-```
+- 网关节点
-### 4. 写入数据
+ 网关节点是负责终端接入的节点，负责终端连接、协议转换、交易准入、本地密码运算、密钥管理等职责。
-```java
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
-
- HashDigest ledgerHash = getLedgerHash();
- // 在本地定义注册账号的 TX；
- TransactionTemplate txTemp = service.newTransaction(ledgerHash);
-
- // --------------------------------------
- // 将商品信息写入到指定的账户中；
- // 对象将被序列化为 JSON 形式存储，并基于 JSON 结构建立查询索引；
- String commodityDataAccount = "GGhhreGeasdfasfUUfehf9932lkae99ds66jf==";
- Commodity commodity1 = new Commodity();
- txTemp.dataAccount(commodityDataAccount).set("ASSET_CODE", commodity1.getCode().getBytes(), -1);
-
- // TX 准备就绪；
- PreparedTransaction prepTx = txTemp.prepare();
-
- String txHash = ByteArray.toBase64(prepTx.getHash().toBytes());
- // 使用私钥进行签名；
- CryptoKeyPair keyPair = getSponsorKey();
- prepTx.sign(keyPair);
-
- // 提交交易；
- prepTx.commit();
-```
+ 网关节点是一种轻量节点，需要绑定一个特定参与方的密钥对，连接到一个或多个共识节点。
-
-### 5. 查询数据
+ 网关节点向共识节点的连接是需要通过认证的，绑定的参与方的密钥对必须事先已经注册到区块链账本中，且得到接入授权。
-> 注：详细的查询可参考模块sdk-samples中SDK_GateWay_Query_Test_相关测试用例
+- 终端
-```java
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
-
- // 查询区块信息；
- // 区块高度；
- long ledgerNumber = service.getLedger(LEDGER_HASH).getLatestBlockHeight();
- // 最新区块；
- LedgerBlock latestBlock = service.getBlock(LEDGER_HASH, ledgerNumber);
- // 区块中的交易的数量；
- long txCount = service.getTransactionCount(LEDGER_HASH, latestBlock.getHash());
- // 获取交易列表；
- LedgerTransaction[] txList = service.getTransactions(LEDGER_HASH, ledgerNumber, 0, 100);
- // 遍历交易列表
- for (LedgerTransaction ledgerTransaction : txList) {
- TransactionContent txContent = ledgerTransaction.getTransactionContent();
- Operation[] operations = txContent.getOperations();
- if (operations != null && operations.length > 0) {
- for (Operation operation : operations) {
- operation = ClientOperationUtil.read(operation);
- // 操作类型：数据账户注册操作
- if (operation instanceof DataAccountRegisterOperation) {
- DataAccountRegisterOperation daro = (DataAccountRegisterOperation) operation;
- BlockchainIdentity blockchainIdentity = daro.getAccountID();
- }
- // 操作类型：用户注册操作
- else if (operation instanceof UserRegisterOperation) {
- UserRegisterOperation uro = (UserRegisterOperation) operation;
- BlockchainIdentity blockchainIdentity = uro.getUserID();
- }
- // 操作类型：账本注册操作
- else if (operation instanceof LedgerInitOperation) {
-
- LedgerInitOperation ledgerInitOperation = (LedgerInitOperation)operation;
- LedgerInitSetting ledgerInitSetting = ledgerInitOperation.getInitSetting();
-
- ParticipantNode[] participantNodes = ledgerInitSetting.getConsensusParticipants();
- }
- // 操作类型：合约发布操作
- else if (operation instanceof ContractCodeDeployOperation) {
- ContractCodeDeployOperation ccdo = (ContractCodeDeployOperation) operation;
- BlockchainIdentity blockchainIdentity = ccdo.getContractID();
- }
- // 操作类型：合约执行操作
- else if (operation instanceof ContractEventSendOperation) {
- ContractEventSendOperation ceso = (ContractEventSendOperation) operation;
- }
- // 操作类型：KV存储操作
- else if (operation instanceof DataAccountKVSetOperation) {
- DataAccountKVSetOperation.KVWriteEntry[] kvWriteEntries =
- ((DataAccountKVSetOperation) operation).getWriteSet();
- if (kvWriteEntries != null && kvWriteEntries.length > 0) {
- for (DataAccountKVSetOperation.KVWriteEntry kvWriteEntry : kvWriteEntries) {
- BytesValue bytesValue = kvWriteEntry.getValue();
- DataType dataType = bytesValue.getType();
- Object showVal = ClientOperationUtil.readValueByBytesValue(bytesValue);
- System.out.println("writeSet.key=" + kvWriteEntry.getKey());
- System.out.println("writeSet.value=" + showVal);
- System.out.println("writeSet.type=" + dataType);
- System.out.println("writeSet.version=" + kvWriteEntry.getExpectedVersion());
- }
- }
- }
- }
- }
- }
-
- // 根据交易的 hash 获得交易；注：客户端生成 PrepareTransaction 时得到交易hash；
- HashDigest txHash = txList[0].getTransactionContent().getHash();
- Transaction tx = service.getTransactionByContentHash(LEDGER_HASH, txHash);
- // 获取数据；
- String commerceAccount = "GGhhreGeasdfasfUUfehf9932lkae99ds66jf==";
- String[] objKeys = new String[] { "x001", "x002" };
- KVDataEntry[] kvData = service.getDataEntries(LEDGER_HASH, commerceAccount, objKeys);
-
- long payloadVersion = kvData[0].getVersion();
-
- // 获取数据账户下所有的KV列表
- KVDataEntry[] kvData = service.getDataEntries(ledgerHash, commerceAccount, 0, 100);
- if (kvData != null && kvData.length > 0) {
- for (KVDataEntry kvDatum : kvData) {
- System.out.println("kvData.key=" + kvDatum.getKey());
- System.out.println("kvData.version=" + kvDatum.getVersion());
- System.out.println("kvData.type=" + kvDatum.getType());
- System.out.println("kvData.value=" + kvDatum.getValue());
- }
- }
-```
+ 终端泛指可以提交交易的客户端，典型来说，包括人、自动化设备、链外的信息系统等。
+ 终端只能通过网关节点来提交交易。终端提交的交易需要用体现该终端身份的私钥来签署，产生一份电子签名。随后当交易提交给网关节点时，网关节点需要在把交易提交到共识节点之前，对交易请求以网关节点绑定的私钥追加一项“节点签名”。
-### 6. 合约发布
+- 备份节点
-```java
-
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
-
- // 在本地定义TX模板
- TransactionTemplate txTemp = service.newTransaction(ledgerHash);
+ 仅对账本数据提供备份，但不参与交易共识的节点。（注：目前版本中尚未实现，将在后续版本中提供）
- // 合约内容读取
- byte[] contractBytes = FileUtils.readBytes(new File(CONTRACT_FILE));
- // 生成用户
- BlockchainIdentityData blockchainIdentity = new BlockchainIdentityData(getSponsorKey().getPubKey());
+
- // 发布合约
- txTemp.contracts().deploy(blockchainIdentity, contractBytes);
- // TX 准备就绪；
- PreparedTransaction prepTx = txTemp.prepare();
+## 三、编译源代码
- // 使用私钥进行签名；
- CryptoKeyPair keyPair = getSponsorKey();
+ 1. 安装 Maven 环境
- prepTx.sign(keyPair);
+ JD Chain 当前版本以 Java 语言开发，需要安装配置 JVM 和 Maven，JDK 版本不低于1.8 。(没有特殊要求，请按标准方法安装，此处不赘述)
+
+ 2. 安装 Git 工具
+
+ 为了能够执行 git clone 命令获取代码仓库。 (没有特殊要求，请按标准方法安装，此处不赘述)
+
+ 3. 工程代码
- // 提交交易；
- TransactionResponse transactionResponse = prepTx.commit();
+ JD Chain 源代码包括 3 个代码仓库
- assertTrue(transactionResponse.isSuccess());
+ - jdchain
+ - 这是当前仓库，也是核心仓库，包含了共识节点、网关节点、SDK等一切部署组件。依赖于 explorer 和 bftsmart 这两个仓库先进行编译安装；
+
+ - explorer
+ - 这是区块链浏览器的前端Web页面的工程，需要编译成静态资源包，由网关节点集成到一起部署。
+ - 地址：git@github.com:blockchain-jd-com/explorer.git
- // 打印合约地址
- System.out.println(blockchainIdentity.getAddress().toBase58());
+ - bftsmart
+ - 这是bftsmart共识协议的工程，需要先编译安装到本地 maven 仓库；
-```
-### 7. 合约执行
+4. 命令操作
-```java
+- 编译安装 explorer 到本地 maven 仓库；
+```sh
+ $ git clone git@github.com:blockchain-jd-com/explorer.git explorer
- // 创建服务代理；
- BlockchainService service = serviceFactory.getBlockchainService();
+ $ cd explorer
- // 在本地定义TX模板
- TransactionTemplate txTemp = service.newTransaction(ledgerHash);
+ $ git checkout master
- // 合约地址
- String contractAddressBase58 = "";
-
- // 使用接口方式调用合约
- TransferContract transferContract = txTpl.contract(contractAddress, TransferContract.class);
-
- // 使用decode方式调用合约内部方法（create方法）
- // 返回GenericValueHolder可通过get方法获取结果，但get方法需要在commit调用后执行
- GenericValueHolder