区块链可装配系统模块编程接口规范.docxVIP

1

区块链可装配系统模块编程接口规范

1范围

本文件主要内容包括：

a）规定了可装配区块链各模块的最小接口集合；

b）规定了可装配区块链各模块的各个接口的具体功能。

本文件适用于：

a）指导区块链服务提供方进行各模块的具体开发工作；

b）指导对可装配区块链各模块具体实现进行评估。

2规范性引用文件

下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中，注日期的引用文件，仅该日期对应的版本适用于本文件；不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。

T/CESA6001-2016区块链参考架构

T/CESAxxxx区块链可装配系统装配规范

T/CESAxxxx区块链可装配系统流程规范

3术语和定义

T/CESA6001-2016，T/CESAxxxx和T/CESAxxxx界定的术语和定义适用于本文件。

3.1区块block

区块链中存储交易和交易相关的数据的单元，通常由区块头和区块体组成。

3.2区块头blockhead

应包含当前区块的属性信息和链接信息。属性信息通常包括时间戳、区块版本等。链接信息通常包括能唯一标识前一个区块特征的哈希值和能唯一标识区块体特征的哈希值。

3.3区块体blockbody

区块中存储交易和交易相关的数据的主要部分。

2

3.4交易transaction

也称为事务，区块链上的一次原子性账本数据状态变更及其过程和结果记录,。

3.5读写集read-writeset

区块链上的一条交易执行过程中，被读取和被修改或写入的状态数据的集合。

3.6交易快照transactionsnapshot

记录区块链某一高度的状态数据集合。

4接口描述

4.1交易缓存模块接口

4.1.1数据类型定义

组件类型Transaction为复合类型，描述一条交易。其包括：

contractId合约ID字段

method调用合约的方法

parameters交易参数

refTxType，交易类型

其余内容可依据区块链场景或应用需求进行定义。

组件类型TxSource为枚举类型，描述交易来源。可取值为：

RPC服务接收端口

P2PP2P广播

INTERNAL内部

4.1.2交易缓存接口

继承：无

属性：无

方法：

anyAddTx(inTransactiontx,inTxSourcesource)

说明：增加一条交易。

参数：tx为需加入缓存的交易，source为交易来源。

返回：错误对象。

sequence*TransactionFetchTxBatch(inshortblockHeight);

说明：获取供打包的一批交易。

参数：blockHeight为区块高度。

返回：一批交易。

anyRemoveTxs(sequence*TransactionremoveTxs);

3

说明：移除已打包过的一批交易。

参数：removeTxs为要移除的交易集合。

返回：错误对象。

4.2区块提议模块接口

4.2.1数据类型定义

组件类型TxPoolSignal为复合类型，描述交换缓存提议信号结构。其包含：signalType信号类型

chainTag链标识

4.2.2区块提议接口

继承：无

属性：无

方法：

TxPoolSignal(in*TxPoolSignalproposeSignal);

说明：响应来自交易缓存模块的区块提议信号，进行打包规则验证，通过后执行打包操作。参数：proposeSignal为从交易缓存模块接收到的区块提议信号。

返回：无。

ProposeStatusChange(inbooleanproposeStatus);

说明：处理来自共识算法模块的区块提议状态通知。

参数：proposeStatus为是否进入区块提议状态。

返回：无。

4.3交易调度模块接口

4.3.1数据类型定义

组件类型Block为复合类型，描述区块结构，其包括：

header区块头

Transactions交易集

组件类型Snapshot为复合类型，区块链交易快照保存只读的世界状态数据，其包括：status世界状态数据。

4.3.2交易调度接口

继承：无

属性：无

方法：

anySchedule(in*Blockb,insequence*TransactiontxBatch,inSnapshotsnapshot);说明：调度交易的执行，并修改候选区块，由区块提议模块调用。

4

参数：b为候选区块（已含部分字段），txBatch为待调度执行的一批交易，snapshot为交易快照。

返回：结果读写集，错误对象。