Hyperledger Fabric 提供了多种语言的SDK版本,其中提出比较早、比较稳定而全面的是Node.js版本的SDK。
SDK和Chaincode的关系:
- SDK存在于客户端层面,主要用于与网络中各组件的交互,包括peer,orderer,event,channel,chaincode,提供丰富的API便于开发者编写应用程序。
- Chaincode处于更底层,提供Query,Invoke,Delete等API直接对状态数据库(world state)进行读写操作。
- SDK中的方法可以对区块及其中中的交易、通道、链码等各种信息进行查询,但是涉及状态的读写则必须通过Chaincode来完成(通过发送Proposal至背书节点)。
SDK for Node.js有三个最顶层(top-level)的模块:API, fabric-client 和 fabric-ca-client。具体细节见官方文档及源码。
1. API
该模块给开发者提供了可插拔API,以提供SDK主要接口的可替换实现,包括CryptoSuite, key, KeyValueStore。每个接口都有内置的默认实现。
2. fabric-client
该模块提供了用户客户端与Fabric区块链网络组件(peer,orderer,event等)的交互。主要功能有:
- 创建channel
- 发送信息使peer节点加入channel
- 在peer中安装(install)chaincode
- 在channel上实例化 chaincode,分为两步:提案( propose )和交易(transact)
- 提交(submit)一个交易(需要调用chaincode),和上面一样分为两步
- 多种查询功能:状态(通过chaincode),交易,区块,channel,chaincode
- 监控事件(monitoring events):包括peer,block,transactions,custom的events
- 有签名能力的用户对象( User object)的序列化(serializable)
- 配置信息的分层(hierarchical configuration settings)
- 还提供可插拔(pluggable)的日志工具(logging utility)、加密工具(CryptoSuite)和状态存储方法(State Store),可以支持与 peer 或 orderer 的 TLS / non-TLS 链接
3. fabric-ca-client
该模块主要用于成员资格的管理,主要功能如下:
- 注册(register )新用户
- 登录(enroll)用户并且获得由Fabric CA签名(CA私钥完成)的登录证书(enrollment certificate)
- 通过登录id(enrollment id)来注销 (revoke) 一个用户
- 可定制的(customizable)持久储存(persistence store)