ChainMaker Go SDK README

1 基本概念

• Node（节点）：代表一个链节点的基本信息，包括：节点地址、连接数、是否启用TLS认证等信息

• ChainClient（链客户端）：所有客户端对链节点的操作接口都来自ChainClient

• 压缩证书：可以为ChainClient开启证书压缩功能，开启后可以减小交易包大小，提升处理性能

2 下载安装

$ git clone --recursive -b v1.2.5 https://git.chainmaker.org.cn/chainmaker/chainmaker-sdk-go.git

3 使用示例

3.1 创建节点

// 创建节点
func createNode(nodeAddr string, connCnt int) *NodeConfig {
	node := NewNodeConfig(
		// 节点地址，格式：127.0.0.1:12301
		WithNodeAddr(nodeAddr),
		// 节点连接数
		WithNodeConnCnt(connCnt),
		// 节点是否启用TLS认证
		WithNodeUseTLS(true),
		// 根证书路径，支持多个
		WithNodeCAPaths(caPaths),
		// TLS Hostname
		WithNodeTLSHostName(tlsHostName),
	)

	return node
}

3.2 创建ChainClient

// 创建ChainClient
func createClient() (*ChainClient, error) {
	if node1 == nil {
		// 创建节点1
		node1 = createNode(nodeAddr1, connCnt1)
	}

	if node2 == nil {
		// 创建节点2
		node2 = createNode(nodeAddr2, connCnt2)
	}

	chainClient, err := NewChainClient(
		// 设置归属组织
		WithChainClientOrgId(chainOrgId),
		// 设置链ID
		WithChainClientChainId(chainId),
		// 设置logger句柄，若不设置，将采用默认日志文件输出日志
		WithChainClientLogger(getDefaultLogger()),
		// 设置客户端用户私钥路径
		WithUserKeyFilePath(userKeyPath),
		// 设置客户端用户证书
		WithUserCrtFilePath(userCrtPath),
		// 添加节点1
		AddChainClientNodeConfig(node1),
		// 添加节点2
		AddChainClientNodeConfig(node2),
		)

	if err != nil {
		return nil, err
	}

	//启用证书压缩（开启证书压缩可以减小交易包大小，提升处理性能）
	err = chainClient.EnableCertHash()
	if err != nil {
		log.Fatal(err)
	}

	return chainClient, nil
}

3.3 接口调用

具体接口调用示例，请参看单元测试用例中的用法。

功能	单测代码
用户合约	sdk_user_contract_test.go
系统合约	sdk_system_contract_test.go
链配置	sdk_chain_config_test.go
证书管理	sdk_cert_manage_test.go
消息订阅	sdk_subscribe_test.go

4 接口说明

4.1 用户合约接口

4.1.1 创建合约待签名payload生成

参数说明

• contractName: 合约名

• version: 版本号

• byteCode: 支持传入合约二进制文件路径或Base64编码的二进制内容

• runtime: 合约运行环境

• kvs: 合约初始化参数

CreateContractCreatePayload(contractName, version, byteCode string, runtime common.RuntimeType, kvs []*common.KeyValuePair) ([]byte, error)

4.1.2 升级合约待签名payload生成

参数说明

• contractName: 合约名

• version: 版本号

• byteCode: 支持传入合约二进制文件路径或Base64编码的二进制内容

• runtime: 合约运行环境

• kvs: 合约升级参数

CreateContractUpgradePayload(contractName, version, byteCode string, runtime common.RuntimeType, kvs []*common.KeyValuePair) ([]byte, error)

4.1.3 冻结合约payload生成

参数说明

• contractName: 合约名

CreateContractFreezePayload(contractName string) ([]byte, error)

4.1.4 解冻合约payload生成

参数说明

• contractName: 合约名

CreateContractUnfreezePayload(contractName string) ([]byte, error)

4.1.5 吊销合约payload生成

参数说明

• contractName: 合约名

CreateContractRevokePayload(contractName string) ([]byte, error)

4.1.6 合约管理获取Payload签名

参数说明

• payloadBytes: 待签名payload

SignContractManagePayload(payloadBytes []byte) ([]byte, error)

4.1.7 合约管理Payload签名收集&合并

参数说明

• signedPayloadBytes: 已签名payload列表

MergeContractManageSignedPayload(signedPayloadBytes [][]byte) ([]byte, error)

4.1.8 发送合约管理请求（创建、更新、冻结、解冻、吊销）

参数说明

• multiSignedPayload: 多签结果

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

SendContractManageRequest(mergeSignedPayloadBytes []byte, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.1.9 合约调用

此方法为通用接口，常用功能建议使用上述已封装好的接口实现 参数说明

• contractName: 合约名称

• method: 合约方法

• txId: 交易ID 格式要求：长度为64字节，字符在a-z0-9 可为空，若为空字符串，将自动生成txId

• params: 合约参数

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

InvokeContract(contractName, method, txId string, params map[string]string, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.1.10 合约查询接口调用

此方法为通用接口，常用功能建议使用上述已封装好的接口实现 参数说明

• contractName: 合约名称

• method: 合约方法

• params: 合约参数

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

QueryContract(contractName, method string, params map[string]string, timeout int64) (*common.TxResponse, error)

4.1.11 构造待发送交易体

参数说明

• contractName: 合约名称

• method: 合约方法

• txId: 交易ID 格式要求：长度为64字节，字符在a-z0-9 可为空，若为空字符串，将自动生成txId

• params: 合约参数

GetTxRequest(contractName, method, txId string, params map[string]string) (*common.TxRequest, error)

4.1.12 发送已构造好的交易体

参数说明

• txRequest: 已构造好的交易体

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

SendTxRequest(txRequest *common.TxRequest, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.2 系统合约接口

4.2.1 根据交易Id查询交易

参数说明

• txId: 交易ID

GetTxByTxId(txId string) (*common.TransactionInfo, error)

4.2.2 根据区块高度查询区块

参数说明

• blockHeight: 指定区块高度，若为-1，将返回最新区块

• withRWSet: 是否返回读写集

GetBlockByHeight(blockHeight int64, withRWSet bool) (*common.BlockInfo, error)

4.2.3 根据区块高度查询完整区块

参数说明

• blockHeight: 指定区块高度，若为-1，将返回最新区块

• withRWSet: 是否返回读写集

GetFullBlockByHeight(blockHeight int64) (*store.BlockWithRWSet, error)

4.2.4 根据区块哈希查询区块

参数说明

• blockHash: 指定区块Hash

• withRWSet: 是否返回读写集

GetBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

4.2.5 根据交易Id查询区块

参数说明

• txId: 交易ID

• withRWSet: 是否返回读写集

GetBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

4.2.6 查询最新的配置块

参数说明

• withRWSet: 是否返回读写集

GetLastConfigBlock(withRWSet bool) (*common.BlockInfo, error)

4.2.7 查询最新区块

参数说明

• withRWSet: 是否返回读写集

GetLastBlock(withRWSet bool) (*common.BlockInfo, error)

4.2.8 查询节点加入的链信息

• 返回ChainId清单

GetNodeChainList() (*discovery.ChainList, error)

4.2.9 查询链信息

• 包括：当前链最新高度，链节点信息

GetChainInfo() (*discovery.ChainInfo, error)

4.2.10 根据交易Id获取区块高度

参数说明

• txId: 交易ID

GetBlockHeightByTxId(txId string) (int64, error)

4.2.11 根据区块Hash获取区块高度

参数说明

• blockHash: 指定区块Hash

GetBlockHeightByHash(blockHash string) (int64, error)

4.2.12 查询当前最新区块高度

GetCurrentBlockHeight() (int64, error)

4.2.13 根据区块高度查询区块头

参数说明

• blockHeight: 指定区块高度，若为-1，将返回最新区块头

GetBlockHeaderByHeight(blockHeight int64) (*common.BlockHeader, error)

4.2.14 系统合约调用

此方法为通用接口，常用功能建议使用上述已封装好的接口实现 参数说明

• contractName: 合约名称

• method: 合约方法

• txId: 交易ID 格式要求：长度为64字节，字符在a-z0-9 可为空，若为空字符串，将自动生成txId

• params: 合约参数

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

InvokeSystemContract(contractName, method, txId string, params map[string]string, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.2.15 系统合约查询接口调用

此方法为通用接口，常用功能建议使用上述已封装好的接口实现 参数说明

• contractName: 合约名称

• method: 合约方法

• params: 合约参数

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

QuerySystemContract(contractName, method string, params map[string]string, timeout int64) (*common.TxResponse, error)

4.3 链配置接口

4.3.1 查询最新链配置

GetChainConfig() (*config.ChainConfig, error)

4.3.2 根据指定区块高度查询最近链配置

• 如果当前区块就是配置块，直接返回当前区块的链配置

GetChainConfigByBlockHeight(blockHeight int) (*config.ChainConfig, error)

4.3.3 查询最新链配置序号Sequence

• 用于链配置更新

GetChainConfigSequence() (int, error)

4.3.4 链配置更新获取Payload签名

SignChainConfigPayload(payloadBytes []byte) ([]byte, error)

4.3.5 链配置更新Payload签名收集&合并

MergeChainConfigSignedPayload(signedPayloadBytes [][]byte) ([]byte, error)

4.3.6 发送链配置更新请求

• mergeSignedPayloadBytes: 待签名payload 可以是合并后的payload也可以是单个payload

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

SendChainConfigUpdateRequest(mergeSignedPayloadBytes []byte, timeout int64, withSyncResult bool) (*common.TxResponse, error)

以下CreateChainConfigXXXXXXPayload方法，用于生成链配置待签名payload，在进行多签收集后(需机构Admin权限账号签名)，用于链配置的更新

4.3.7 更新Core模块待签名payload生成

参数说明

• txSchedulerTimeout: 交易调度器从交易池拿到交易后, 进行调度的时间，其值范围为[0, 60]，若无需修改，请置为-1

• txSchedulerValidateTimeout: 交易调度器从区块中拿到交易后, 进行验证的超时时间，其值范围为[0, 60]，若无需修改，请置为-1

CreateChainConfigCoreUpdatePayload(txSchedulerTimeout, txSchedulerValidateTimeout int) ([]byte, error)

4.3.8 更新Core模块待签名payload生成

参数说明

• txTimestampVerify: 是否需要开启交易时间戳校验

• (以下参数，若无需修改，请置为-1)

• txTimeout: 交易时间戳的过期时间(秒)，其值范围为[600, +∞)

• blockTxCapacity: 区块中最大交易数，其值范围为(0, +∞]

• blockSize: 区块最大限制，单位MB，其值范围为(0, +∞]

• blockInterval: 出块间隔，单位:ms，其值范围为[10, +∞]

CreateChainConfigBlockUpdatePayload(txTimestampVerify bool, txTimeout, blockTxCapacity, blockSize, blockInterval int) ([]byte, error)

4.3.9 添加信任组织根证书待签名payload生成

参数说明

• trustRootOrgId: 组织Id

• trustRootCrt: 根证书

CreateChainConfigTrustRootAddPayload(trustRootOrgId, trustRootCrt string) ([]byte, error)

4.3.10 更新信任组织根证书待签名payload生成

参数说明

• trustRootOrgId: 组织Id

• trustRootCrt: 根证书

CreateChainConfigTrustRootUpdatePayload(trustRootOrgId, trustRootCrt string) ([]byte, error)

4.3.11 删除信任组织根证书待签名payload生成

参数说明

• trustRootOrgId: 组织Id

CreateChainConfigTrustRootDeletePayload(trustRootOrgId string) ([]byte, error)

4.3.12 添加权限配置待签名payload生成

参数说明

• permissionResourceName: 权限名

• policy: 权限规则

CreateChainConfigPermissionAddPayload(permissionResourceName string, policy *accesscontrol.Policy) ([]byte, error)

4.3.13 更新权限配置待签名payload生成

参数说明

• permissionResourceName: 权限名

• policy: 权限规则

CreateChainConfigPermissionUpdatePayload(permissionResourceName string, policy *accesscontrol.Policy) ([]byte, error)

4.3.14 删除权限配置待签名payload生成

参数说明

• permissionResourceName: 权限名

CreateChainConfigPermissionDeletePayload(permissionResourceName string) ([]byte, error)

4.3.15 添加共识节点地址待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

• nodeIds: 节点Id

CreateChainConfigConsensusNodeIdAddPayload(nodeOrgId string, nodeIds []string) ([]byte, error)

4.3.16 更新共识节点地址待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

• nodeOldNodeId: 节点原Id

• nodeNewNodeId: 节点新Id

CreateChainConfigConsensusNodeIdUpdatePayload(nodeOrgId, nodeOldNodeId, nodeNewNodeId string) ([]byte, error)

4.3.17 删除共识节点地址待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

• nodeId: 节点Id

CreateChainConfigConsensusNodeIdDeletePayload(nodeOrgId, nodeId string) ([]byte, error)

4.3.18 添加共识节点待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

• nodeIds: 节点Id

CreateChainConfigConsensusNodeOrgAddPayload(nodeOrgId string, nodeIds []string) ([]byte, error)

4.3.19 更新共识节点待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

• nodeIds: 节点Id

CreateChainConfigConsensusNodeOrgUpdatePayload(nodeOrgId string, nodeIds []string) ([]byte, error)

4.3.20 删除共识节点待签名payload生成

参数说明

• nodeOrgId: 节点组织Id

CreateChainConfigConsensusNodeOrgDeletePayload(nodeOrgId string) ([]byte, error)

4.3.21 添加共识扩展字段待签名payload生成

参数说明

• kvs: 字段key、value对

CreateChainConfigConsensusExtAddPayload(kvs []*common.KeyValuePair) ([]byte, error)

4.3.22 添加共识扩展字段待签名payload生成

参数说明

• kvs: 字段key、value对

CreateChainConfigConsensusExtUpdatePayload(kvs []*common.KeyValuePair) ([]byte, error)

4.3.23 添加共识扩展字段待签名payload生成

参数说明

• keys: 待删除字段

CreateChainConfigConsensusExtDeletePayload(keys []string) ([]byte, error)

4.4 证书管理接口

4.4.1 用户证书添加

参数说明

• 在common.TxResponse.ContractResult.Result字段中返回成功添加的certHash

AddCert() (*common.TxResponse, error)

4.4.2 用户证书删除

参数说明

• certHashes: 证书Hash列表

DeleteCert(certHashes []string) (*common.TxResponse, error)

4.4.3 用户证书查询

参数说明

• certHashes: 证书Hash列表

返回值说明

• *common.CertInfos: 包含证书Hash和证书内容的列表

QueryCert(certHashes []string) (*common.CertInfos, error)

4.4.4 获取用户证书哈希

GetCertHash() ([]byte, error)

4.4.5 生成证书管理操作Payload（三合一接口）

参数说明

• method: CERTS_FROZEN(证书冻结)/CERTS_UNFROZEN(证书解冻)/CERTS_REVOCATION(证书吊销)

• kvs: 证书管理操作参数

CreateCertManagePayload(method string, kvs []*common.KeyValuePair) ([]byte, error)

4.4.6 生成证书冻结操作Payload

参数说明

• certs: X509证书列表

CreateCertManageFrozenPayload(certs []string) ([]byte, error)

4.4.7 生成证书解冻操作Payload

参数说明

• certs: X509证书列表

CreateCertManageUnfrozenPayload(certs []string) ([]byte, error)

4.4.8 生成证书吊销操作Payload

参数说明

• certs: X509证书列表

CreateCertManageRevocationPayload(certCrl string) ([]byte, error)

4.4.9 待签payload签名

一般需要使用具有管理员权限账号进行签名 参数说明

• payloadBytes: 待签名payload

SignCertManagePayload(payloadBytes []byte) ([]byte, error)

4.4.10 证书管理Payload签名收集&合并

参数说明

• signedPayloadBytes: 已签名payload列表

MergeCertManageSignedPayload(signedPayloadBytes [][]byte) ([]byte, error)

4.4.11 发送证书管理请求（证书冻结、解冻、吊销）

参数说明

• multiSignedPayload: 多签结果

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

SendCertManageRequest(mergeSignedPayloadBytes []byte, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.5 在线多签接口(该功能尚不支持)

4.5.1 待签payload签名

一般需要使用具有管理员权限账号进行签名 参数说明

• payloadBytes: 待签名payload

SignMultiSignPayload(payloadBytes []byte) (*common.EndorsementEntry, error)

4.5.2 多签请求

参数说明

• txType: 多签payload交易类型

• payloadBytes: 待签名payload

• endorsementEntry: 签名收集信息

• deadlineBlockHeight: 过期的区块高度，若设置为0，表示永不过期

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

返回值说明

• 若成功调用，common.TxResponse.ContractResult.Result为txId

SendMultiSignReq(txType common.TxType, payloadBytes []byte, endorsementEntry *common.EndorsementEntry,
	deadlineBlockHeight int, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.5.3 多签投票

参数说明

• voteStatus: 投票状态（赞成、反对）

• multiSignReqTxId: 多签请求交易ID(txId或payloadHash至少填其一，txId优先)

• payloadHash: 待多签payload hash(txId或payloadHash至少填其一，txId优先)

• payloadBytes: 待签名payload

• endorsementEntry: 签名收集信息

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

• withSyncResult: 是否同步获取交易执行结果 当为true时，若成功调用，common.TxResponse.ContractResult.Result为common.TransactionInfo 当为false时，若成功调用，common.TxResponse.ContractResult.Result为txId

返回值说明

• 若成功调用，common.TxResponse.ContractResult.Result为txId

SendMultiSignVote(voteStatus common.VoteStatus, multiSignReqTxId, payloadHash string,
	endorsementEntry *common.EndorsementEntry, timeout int64, withSyncResult bool) (*common.TxResponse, error)

4.5.4 投票查询

参数说明

• multiSignReqTxId: 多签请求交易ID(txId或payloadHash至少填其一，txId优先)

• payloadHash: 待多签payload hash(txId或payloadHash至少填其一，txId优先)

QueryMultiSignResult(multiSignReqTxId, payloadHash string) (*common.TxResponse, error)

4.6 消息订阅接口

4.6.1 区块订阅

参数说明

• startBlock: 订阅起始区块高度，若为-1，表示订阅实时最新区块

• endBlock: 订阅结束区块高度，若为-1，表示订阅实时最新区块

• withRwSet: 是否返回读写集

SubscribeBlock(ctx context.Context, startBlock, endBlock int64, withRwSet bool) (<-chan interface{}, error)

4.6.2 交易订阅

参数说明

• startBlock: 订阅起始区块高度，若为-1，表示订阅实时最新区块

• endBlock: 订阅结束区块高度，若为-1，表示订阅实时最新区块

• txType: 订阅交易类型,若为common.TxType(-1)，表示订阅所有交易类型

• txIds: 订阅txId列表，若为空，表示订阅所有txId

SubscribeTx(ctx context.Context, startBlock, endBlock int64, txType common.TxType, txIds []string) (<-chan interface{}, error)

4.6.3 合约事件订阅

参数说明

• topic ：指定订阅主题

• contractName ：指定订阅的合约名称

SubscribeContractEvent(ctx context.Context, topic string, contractName string) (<-chan interface{}, error)

4.6.4 多合一订阅

参数说明

• txType: 订阅交易类型，目前已支持：区块消息订阅(common.TxType_SUBSCRIBE_BLOCK_INFO)、交易消息订阅(common.TxType_SUBSCRIBE_TX_INFO)

• payloadBytes: 消息订阅参数payload

Subscribe(ctx context.Context, txType common.TxType, payloadBytes []byte) (<-chan interface{}, error)

4.7 证书压缩

开启证书压缩可以减小交易包大小，提升处理性能

4.7.1 启用压缩证书功能

EnableCertHash() error

4.7.2 停用压缩证书功能

DisableCertHash() error

4.8 工具类

4.8.1 将EasyCodec编码解码成map

EasyCodecItemToParamsMap(items []*serialize.EasyCodecItem) map[string]string

4.8.2 根据X.509证书路径得到EVM地址

参数说明

• certFilePath: 证书文件路径

GetEVMAddressFromCertPath(certFilePath string) (string, error)

4.8.3 根据X.509证书内容得到EVM地址

参数说明

• certBytes: 证书内容

GetEVMAddressFromCertBytes(certBytes []byte) (string, error)

4.9 层级属性加密类接口

注意：层级属性加密模块 Id 使用 / 作为分隔符，例如： Org1/Ou1/Member1

4.9.1 生成层级属性参数初始化交易 payload

参数说明

• orgId: 参与方组织 id

• hibeParams: 传入序列化后的hibeParams byte数组

CreateHibeInitParamsTxPayloadParams(orgId string, hibeParams []byte) (map[string]string, error)

4.9.2 生成层级属性加密交易 payload，加密参数已知

参数说明

• plaintext: 待加密交易消息明文

• receiverIds: 消息接收者 id 列表，需和 paramsList 一一对应

• paramsBytesList: 消息接收者对应的加密参数，需和 receiverIds 一一对应

• txId: 以交易 Id 作为链上存储 hibeMsg 的 Key, 如果不提供存储的信息可能被覆盖

• keyType: 对明文进行对称加密的方法，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法

CreateHibeTxPayloadParamsWithHibeParams(plaintext []byte, receiverIds []string, paramsBytesList [][]byte, txId string,
	keyType crypto.KeyType) (map[string]string, error)

4.9.3 生成层级属性加密交易 payload，参数由链上查询得出

参数说明

• contractName: 合约名

• queryParamsMethod: 链上查询 hibe.Params 的合约方法

• plaintext: 待加密交易消息明文

• receiverIds: 消息接收者 id 列表，需和 paramsList 一一对应

• paramsList: 消息接收者对应的加密参数，需和 receiverIds 一一对应

• receiverOrgIds: 链上查询 hibe Params 的 Key 列表，需要和 receiverIds 一一对应

• txId: 以交易 Id 作为链上存储 hibeMsg 的 Key, 如果不提供存储的信息可能被覆盖

• keyType: 对明文进行对称加密的方法，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法

• timeout: （内部查询 HibeParams 的）超时时间，单位：s，若传入-1，将使用默认超时时间：10s

CreateHibeTxPayloadParamsWithoutHibeParams(contractName, queryParamsMethod string, plaintext []byte, receiverIds []string,
	receiverOrgIds []string, txId string, keyType crypto.KeyType, timeout int64) (map[string]string, error)

4.9.4 查询某一组织的加密公共参数，返回其序列化后的byte数组

参数说明

• contractName: 合约名

• method: 查询的合约方法名

• orgId: 参与方 id

• timeout: 查询超时时间，单位：s，若传入-1，将使用默认超时时间：10s

QueryHibeParamsWithOrgId(contractName, method, orgId string, timeout int64) ([]byte, error)

4.9.5 已知交易id，根据私钥解密密文交易

参数说明

• localId: 本地层级属性加密 id

• hibeParams: hibeParams 序列化后的byte数组

• hibePrivKey: hibe私钥序列化后的byte数组

• txId: 层级属性加密交易 id

• keyType: 对加密信息进行对称解密的方法，请和加密时使用的方法保持一致，请传入 common 中 crypto 包提供的方法，目前提供AES和SM4两种方法

DecryptHibeTxByTxId(localId string, hibeParams []byte, hibePrvKey []byte, txId string, keyType crypto.KeyType) ([]byte, error)

4.10 数据归档接口

4.10.1 获取已归档区块高度

参数说明

• 输出已归档的区块高度

GetArchivedBlockHeight() (int64, error)

4.10.2 构造数据归档区块Payload

参数说明

• targetBlockHeight: 归档目标区块高度

CreateArchiveBlockPayload(targetBlockHeight int64) ([]byte, error)

4.10.3 构造归档归档数据恢复Payload

参数说明

• fullBlock: 完整区块数据（对应结构：store.BlockWithRWSet）

CreateRestoreBlockPayload(fullBlock []byte) ([]byte, error)

4.10.4 获取归档操作Payload签名

参数说明

• payloadBytes: 待签名payload

SignArchivePayload(payloadBytes []byte) ([]byte, error)

4.10.5 发送归档请求

参数说明

• mergeSignedPayloadBytes: 签名结果

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

SendArchiveBlockRequest(mergeSignedPayloadBytes []byte, timeout int64) (*common.TxResponse, error)

4.10.6 归档数据恢复

参数说明

• mergeSignedPayloadBytes: 签名结果

• timeout: 超时时间，单位：s，若传入-1，将使用默认超时时间：10s

SendRestoreBlockRequest(mergeSignedPayloadBytes []byte, timeout int64) (*common.TxResponse, error)

4.10.7 根据交易Id查询已归档交易

参数说明

• txId: 交易ID

GetArchivedTxByTxId(txId string) (*common.TransactionInfo, error)

4.10.8 根据区块高度查询已归档区块

参数说明

• blockHeight: 指定区块高度，若为-1，将返回最新区块

• withRWSet: 是否返回读写集

GetArchivedBlockByHeight(blockHeight int64, withRWSet bool) (*common.BlockInfo, error)

4.10.9 根据区块高度查询已归档完整区块(包含：区块数据、读写集、合约事件日志)

参数说明

• blockHeight: 指定区块高度，若为-1，将返回最新区块

GetArchivedFullBlockByHeight(blockHeight int64) (*store.BlockWithRWSet, error)

4.10.10 根据区块哈希查询已归档区块

参数说明

• blockHash: 指定区块Hash

• withRWSet: 是否返回读写集

GetArchivedBlockByHash(blockHash string, withRWSet bool) (*common.BlockInfo, error)

4.10.11 根据交易Id查询已归档区块

参数说明

• txId: 交易ID

• withRWSet: 是否返回读写集

GetArchivedBlockByTxId(txId string, withRWSet bool) (*common.BlockInfo, error)

4.11 隐私计算系统合约接口

4.11.1 保存隐私合约计算结果，包括合约部署

参数说明

• contractName: 合约名称

• contractVersion: 合约版本号

• isDeployment: 是否是部署合约

• codeHash: 合约字节码hash值

• reportHash: Enclave report hash值

• result: 隐私合约执行结果

• codeHeader: solodity合部署合约时合约字节码的header数据

• txId: 交易Id

• rwSet: 隐私合约执行产生的读写集

• sign: Enclave对执行结果数据的结果签名

• events: 合约执行产生的事件

• privateReq: 用户调用隐私计算请求时的request序列化字节数组

• withSyncResult: 是否同步返回调用结果

• timeout: 发送交易的超时时间

SaveData(contractName string, contractVersion string, isDeployment bool, codeHash []byte, reportHash []byte,
	result *common.ContractResult, codeHeader []byte, txId string, rwSet *common.TxRWSet, sign []byte,
	events *common.StrSlice, privateReq []byte, withSyncResult bool, timeout int64) (*common.TxResponse, error)

4.11.2 保存远程证明

参数说明

• proof: 远程证明

• txId: 交易Id

• withSyncResult: 是否同步返回调用结果

• timeout: 交易发送超时时间

SaveRemoteAttestationProof(proof, txId string, withSyncResult bool, timeout int64) (*common.TxResponse, error)

4.11.3 保存Encalve CA证书

参数说明

• caCert: Enclave CA证书

• txId: 交易Id

• withSyncResult: 是否同步返回调用结果

• timeout: 交易发送超时时间

SaveEnclaveCACert(caCert, txId string, withSyncResult bool, timeout int64) (*common.TxResponse, error)

4.11.4 获取Encalve CA证书

GetEnclaveCACert() ([]byte, error)

4. 11.5 隐私计算调用者权限验证

参数说明

• payload: 用户签名验证的payload内容

• orgIds: 组织Id的slice，注意和signPairs里面SignInfo的证书顺序一致

• signPairs: 用户多签的签名和证书slice

CheckCallerCertAuth(payload string, orgIds []string, signPairs []*common.SignInfo) (*common.TxResponse, error)

4. 11.6 获取Enclave的report

参数说明

• enclaveId: Enclave的Id，当前固定为

GetEnclaveReport(enclaveId string) ([]byte, error)

4.11.7 获取隐私证明材

参数说明

• enclaveId: Enclave的Id，当前固定为

GetEnclaveProof(enclaveId string) ([]byte, error)

4.11.8 获取隐私合约计算结果

参数说明

• contractName: 合约名称

• key: 计算结果对应的键值

GetData(contractName, key string) ([]byte, error)

4.11.9 保存隐私目录

参数说明

• orderId: 隐私目录的主键，供以后查询使用

• txId: 交易ID

• privateDir:

• withSyncResult: 是否同步等待交易结果

• timeout: 等待交易结果的超时时间

SaveDir(orderId, txId string, privateDir *common.StrSlice, withSyncResult bool, timeout int64) (*common.TxResponse, error)

4.11.10 获取用户部署的隐私合约

参数说明

• contractName: 合约名称

• codeHash: 代码哈希

GetContract(contractName, codeHash string) (*common.PrivateGetContract, error)

4.11.11 获取用户的隐私目录

参数说明

• orderId: 隐私目录的主键

GetDir(orderId string) ([]byte, error)

4.11.12 上传隐私计算环境的report

参数说明

• enclaveId: 隐私计算环境的标识

• report: 隐私计算环境的report

• txId: 交易ID

• withSyncResult: 是否同步等待交易结果

• timeout: 等待交易结果的超时时间

SaveEnclaveReport(enclaveId, report, txId string, withSyncResult bool, timeout int64) (*common.TxResponse, error)

4.11.13 获取隐私计算环境的加密公钥

参数说明

• enclaveId: 隐私计算环境的标识

GetEnclaveEncryptPubKey(enclaveId string) ([]byte, error)

4.11.14 获取隐私计算环境的验签公钥

参数说明

• enclaveId: 隐私计算环境的标识

GetEnclaveVerificationPubKey(enclaveId string) ([]byte, error)

4.11.15 获取隐私证明材料中的Challenge

参数说明

• enclaveId: 隐私计算环境的标识

GetEnclaveChallenge(enclaveId string) ([]byte, error)

4.11.16 获取隐私证明材料中的Signature

参数说明

• enclaveId: 隐私计算环境的标识

GetEnclaveSignature(enclaveId string) ([]byte, error)

4.12 系统类接口

4.12.1 SDK停止接口

关闭连接池连接，释放资源

Stop() error

4.12.2 获取链版本

GetChainMakerServerVersion() (string, error)