跨链数据连接服务 开发文档

By | 2021年4月23日

蚂蚁区块链跨链服务是面向智能合约提供的链上数据服务,本服务在客户区块链环境中部署跨链服务合约/链码,并且提供 API 接口供用户合约/链码进行调用。跨链接服务目前提供 账本数据访问合约消息推送 两类服务及其对应的 API 接口。账本数据访问服务可以帮助用户智能合约获取其他区块链账本上的数据,包括但不限于区块头,完整区块、交易等。合约消息推送服务可以帮助部署了跨链数据服务的不同区块链上的智能合约进行消息通信,满足跨链业务关联处理等场景。

账本数据访问服务

目前,账本数据访问服务仅支持蚂蚁区块链合约访问蚂蚁区块链账本数据,同时支持 Solidity 和 C++ 语言开发的智能合约。

Mychain/Solidity 合约

Solidity 合约开发流程

用户智能合约使用账本数据访问 API 接口,开发流程如下:

  1. 在 Baas 平台上获取账本数据合约名称。
  2. 获取账本数据访问 API 接口定义(ChainDataInterface.sol,见 API 接口定义 章节)。
  3. 在用户合约中引入账本数据访问 API 定义。
  4. 用户合约实现回调接口,用于异步接收账本数据回调使用。
  5. 用户合约构建账本数据访问请求(ChainDataCmdHelper.sol)。
  6. 用户合约向账本数据合约发送请求,具体参考 API 使用示例
  7. 账本数据服务返回数据为 JSON 格式,具体格式参考 账本数据结构 部分。

API 使用流程

  1. 用户合约调用账本数据合约的账本数据访问接口发起查询请求,账本数据合约同步返回查询请求句柄,即请求单据号(reqeust_id)。
  2. 账本数据合约获取到查询结果数据后,异步回调用户合约的回调接口。

API 接口定义

ChainDataInterface.sol 中定义了账本数据合约提供的账本数据访问接口,用户通过调用账本数据合约 ChainDataRequest 接口发送请求。用户合约需要实现 ChainDataCallbackResponse 接口,用于接收账本数据合约的查询账本数据结果。

  
  1. pragma solidity ^0.4.22;
  2. interface ChainDataInterface {
  3. /**
  4. * function: chainDataRequest
  5. * usage: 用户合约调用账本数据合约发送跨链账本数据访问请求
  6. * parameters:
  7. * _biz_id :用户自定义的业务请求 ID
  8. * _chain_data_cmd :账本数据访问命令,参考账本数据访问命令说明
  9. * _if_callback :是否需要账本数据合约将请求结果回调用户合约
  10. * _callback_identity :账本数据合约请求结果回调的合约 ID,可以是发送请求的合约,也可以是其他合约
  11. * _delay_time :该特性未激活,填 0 即可
  12. * return value :查询请求 ID,是账本数据合约为本次请求生成的唯一请求 ID
  13. */
  14. function chainDataRequest(bytes32 _biz_id, string _chain_data_cmd, bool _if_callback, identity _callback_identity, uint256 _delay_time) external returns (bytes32);
  15. /**
  16. * function: chainDataCallbackResponse
  17. * usage: 用户合约需要实现的接口,供账本数据合约合约回调
  18. * parameters:
  19. * _request_id :账本数据访问请求 ID(在发送账本数据请求时账本数据合约会返回此 ID)
  20. * _biz_id :用户合约的业务请求 ID
  21. * _error_code :请求结果码,如果值是 0,则表示预言机请求处理成功;如果是其他值,则为请求处理失败,详见合约错误码表
  22. * _resp_body :账本数据body
  23. * _call_identity :发起该请求的合约 ID
  24. * return value :无
  25. */
  26. function chainDataCallbackResponse (bytes32 _request_id, bytes32 _biz_id, uint32 _error_code, bytes _resp_body, identity _call_identity) external returns (bool);
  27. }

API 参数说明

账本数据访问接口需要用户指定要访问的区块链域名、资源类型和资源 ID,以及对于资源数据的加工处理。详细命令语法格式如下。

  
  1. NAME
  2. udag
  3. VERSION
  4. 1.0.0_BETA
  5. SYNOPSIS
  6. udag udag://udag-domain/CID[/path] [options]
  7. 其中 udag-domain 为目标区块链域名,CID 为区块链资源描述 ID,建议使用提供 ChainDataCmdHelper 进行拼装。path为内容提取路径,不建议使用,建议使用--json-path替代。
  8. DESCRIPTION
  9. udag 命令是跨链数据服务的账本数据访问服务提供的接口必要传入参数之一。udag命令描述了指定访问目的区块链资源的URI,以及其他可选配置项。
  10. OPTIONS
  11. --json-path <value>
  12. 指定了对 http 原始响应 body 进行 jsonpath 处理,仅限于对 json 数据进行加工。
  13. jsonpath 语法说明:https://goessner.net/articles/JsonPath/
  14. 目前支持:$.[]*
  15. e.g.
  16. --json-path '$.obj' 取子对象
  17. --json-path '$[0]' 从数组取下标
  18. --json-path "$['obj']" 取子对象
  19. --json-path '$[0,1].obj' 取多个对象

为方便用户使用账本数据访问服务,本服务提供了便于用户拼装命令的辅助库 ChainDataCmdHelper.sol 协助用户快速开发。

  
  1. pragma solidity ^0.4.22;
  2. library ChainDataCmdHelper {
  3. enum Base {BASE16, BASE58, BASE64}
  4. enum Hash {SHA2_256, SHA3_256, KECCAK256}
  5. enum Content {MYCHAIN010_BLOCK, MYCHAIN010_TX, MYCHAIN010_HEADER}
  6. bytes1 constant udag_cid_version = hex'01';
  7. string constant base16_codec = "f";
  8. string constant base58_codec = "b";
  9. string constant base64_codec = "m";
  10. bytes1 constant sha2_256_codec = hex'32';
  11. bytes1 constant sha3_256_codec = hex'35';
  12. bytes1 constant keccak256_codec = hex'39';
  13. bytes1 constant MYCHAIN010_block_codec = hex'a5';
  14. bytes1 constant MYCHAIN010_tx_codec = hex'a6';
  15. bytes1 constant MYCHAIN010_header_codec = hex'a8';
  16. /**
  17. * @dev build mychain010 block content id
  18. * @param _hash bytes
  19. */
  20. function buildMychain010BlockCID(bytes _hash) internal pure returns (string){
  21. uint8 hash_length = uint8(_hash.length);
  22. bytes memory multihash = concat(concat(varintEncoding(uint8(sha2_256_codec)), varintEncoding(hash_length)), _hash);
  23. bytes memory multicontent = concat(concat(varintEncoding(uint8(udag_cid_version)), varintEncoding(uint8(MYCHAIN010_block_codec))), multihash);
  24. string memory multibase = bytesToHexString(multicontent);
  25. string memory content_id = strJoin(base16_codec, multibase);
  26. return content_id;
  27. }
  28. /**
  29. * @dev build mychain010 tx content id
  30. * @param _hash bytes
  31. */
  32. function buildMychain010TxCID(bytes _hash) internal pure returns (string){
  33. uint8 hash_length = uint8(_hash.length);
  34. bytes memory multihash = concat(concat(varintEncoding(uint8(sha2_256_codec)), varintEncoding(hash_length)), _hash);
  35. bytes memory multicontent = concat(concat(varintEncoding(uint8(udag_cid_version)), varintEncoding(uint8(MYCHAIN010_tx_codec))), multihash);
  36. string memory multibase = bytesToHexString(multicontent);
  37. string memory content_id = strJoin(base16_codec, multibase);
  38. return content_id;
  39. }
  40. /**
  41. * @dev build mychain010 blockheader content id
  42. * @param _hash bytes
  43. */
  44. function buildMychain010HeaderCID(bytes _hash) internal pure returns (string){
  45. uint8 hash_length = uint8(_hash.length);
  46. bytes memory multihash = concat(concat(varintEncoding(uint8(sha2_256_codec)), varintEncoding(hash_length)), _hash);
  47. bytes memory multicontent = concat(concat(varintEncoding(uint8(udag_cid_version)), varintEncoding(uint8(MYCHAIN010_header_codec))), multihash);
  48. string memory multibase = bytesToHexString(multicontent);
  49. string memory content_id = strJoin(base16_codec, multibase);
  50. return content_id;
  51. }
  52. /**
  53. * @dev build udag command
  54. * @param _domain string
  55. * @param _cid string
  56. * @param _path string
  57. * @param _parser_cmd string
  58. *
  59. */
  60. function buildCommand(string _domain, string _cid, string _path, string _parser_cmd) internal pure returns(string){
  61. string memory udag_cmd;
  62. string memory udag_url;
  63. string memory udag_url_path;
  64. var path_slice = strings.toSlice(_path);
  65. var parser_slice = strings.toSlice(_parser_cmd);
  66. var slash_slice = strings.toSlice("/");
  67. if(strings.empty(path_slice) && strings.empty(parser_slice)){
  68. udag_cmd = strJoin("udag://", _domain, "/", _cid);
  69. }
  70. else if(strings.empty(path_slice)){
  71. udag_url = strJoin("udag://", _domain, "/", _cid);
  72. udag_cmd = strJoin(udag_url," --json-path ", _parser_cmd);
  73. }
  74. else if(strings.empty(parser_slice)){
  75. udag_url = strJoin("udag://", _domain, "/", _cid);
  76. if(strings.startsWith(path_slice, slash_slice)){
  77. udag_cmd = strJoin(udag_url, _path);
  78. }else{
  79. udag_cmd = strJoin(udag_url,"/", _path);
  80. }
  81. }
  82. else{
  83. udag_url = strJoin("udag://", _domain, "/", _cid);
  84. if(strings.startsWith(path_slice, slash_slice)){
  85. udag_url_path = strJoin(udag_url, _path);
  86. }else{
  87. udag_url_path = strJoin(udag_url,"/", _path);
  88. }
  89. udag_cmd = strJoin(udag_url_path," --json-path ", _parser_cmd);
  90. }
  91. return udag_cmd;
  92. }
  93. /**
  94. * @dev generate udag content id
  95. * @param _hash bytes
  96. * @param _hash_codec UDAGHashList
  97. * @param _content_codec UDAGContentList
  98. * @param _base_codec UDAGBaseList
  99. */
  100. function generateCID(bytes _hash,
  101. Hash _hash_codec,
  102. Content _content_codec,
  103. Base _base_codec) internal pure returns (string){
  104. string memory content_id;
  105. uint8 hash_length = uint8(_hash.length);
  106. bytes1 hash_codec;
  107. bytes1 content_codec;
  108. string memory base_codec;
  109. if (_hash_codec == Hash.SHA2_256){
  110. hash_codec = sha2_256_codec;
  111. }
  112. else if (_hash_codec == Hash.SHA3_256){
  113. hash_codec = sha3_256_codec;
  114. }
  115. else if(_hash_codec == Hash.KECCAK256){
  116. hash_codec = keccak256_codec;
  117. }
  118. if (_base_codec == Base.BASE16){
  119. base_codec = base16_codec;
  120. }
  121. else if (_base_codec == Base.BASE58){
  122. base_codec = base58_codec;
  123. }
  124. else if(_base_codec == Base.BASE64){
  125. base_codec = base64_codec;
  126. }
  127. if (_content_codec == Content.MYCHAIN010_BLOCK){
  128. content_codec = MYCHAIN010_block_codec;
  129. }
  130. else if(_content_codec == Content.MYCHAIN010_TX){
  131. content_codec = MYCHAIN010_tx_codec;
  132. }
  133. else if (_content_codec == Content.MYCHAIN010_HEADER){
  134. content_codec = MYCHAIN010_header_codec;
  135. }
  136. bytes memory multihash = concat(concat(varintEncoding(uint8(hash_codec)), varintEncoding(hash_length)), _hash);
  137. bytes memory multicontent = concat(concat(varintEncoding(uint8(udag_cid_version)), varintEncoding(uint8(content_codec))), multihash);
  138. string memory multibase;
  139. if(_base_codec == Base.BASE16){
  140. multibase = bytesToHexString(multicontent);
  141. }
  142. else if(_base_codec == Base.BASE64){
  143. bool ret_code;
  144. (ret_code, multibase) = base64_encode(bytesToHexString(multicontent));
  145. if(!ret_code){
  146. revert("BASE_ENCODE_ERROR: Registering oracle node failed. encoding base64 AVR failed");
  147. }
  148. }
  149. content_id = strJoin(base_codec, multibase);
  150. return content_id;
  151. }
  152. /**
  153. * @dev encode unsigned varint
  154. * @param _n uint8
  155. */
  156. function varintEncoding(uint8 _n) internal pure returns (bytes){
  157. bytes memory varint1;
  158. bytes memory varint2;
  159. for (uint32 i = 0; i < 2; i++) {
  160. uint8 a = (_n & 0x7F);
  161. _n = _n >> 7;
  162. if (_n == 0) {
  163. varint1 = uint8ToBytes(a);
  164. if(i == 0){
  165. return varint1;
  166. }
  167. else{
  168. return concat(varint2, varint1);
  169. }
  170. } else {
  171. varint2 = uint8ToBytes(a | 0x80);
  172. }
  173. }
  174. }
  175. function concat(bytes memory _preBytes, bytes memory _postBytes) internal pure returns (bytes) {
  176. bytes memory tempBytes;
  177. assembly {
  178. tempBytes := mload(0x40)
  179. let length := mload(_preBytes)
  180. mstore(tempBytes, length)
  181. let mc := add(tempBytes, 0x20)
  182. let end := add(mc, length)
  183. for {
  184. let cc := add(_preBytes, 0x20)
  185. } lt(mc, end) {
  186. mc := add(mc, 0x20)
  187. cc := add(cc, 0x20)
  188. } {
  189. mstore(mc, mload(cc))
  190. }
  191. length := mload(_postBytes)
  192. mstore(tempBytes, add(length, mload(tempBytes)))
  193. mc := end
  194. end := add(mc, length)
  195. for {
  196. let cc := add(_postBytes, 0x20)
  197. } lt(mc, end) {
  198. mc := add(mc, 0x20)
  199. cc := add(cc, 0x20)
  200. } {
  201. mstore(mc, mload(cc))
  202. }
  203. mstore(0x40, and(
  204. add(add(end, iszero(add(length, mload(_preBytes)))), 31),
  205. not(31) // Round down to the nearest 32 bytes.
  206. ))
  207. }
  208. return tempBytes;
  209. }
  210. function uint8ToBytes(uint8 input) internal pure returns (bytes) {
  211. bytes memory b = new bytes(1);
  212. byte temp = byte(input);
  213. b[0] = temp;
  214. return b;
  215. }
  216. function bytesToHexString(bytes bs) internal pure returns(string) {
  217. bytes memory tempBytes = new bytes(bs.length * 2);
  218. uint len = bs.length;
  219. for (uint i = 0; i < len; i++) {
  220. byte b = bs[i];
  221. byte nb = (b & 0xf0) >> 4;
  222. tempBytes[2 * i] = nb > 0x09 ? byte((uint8(nb) + 0x37)) : (nb | 0x30);
  223. nb = (b & 0x0f);
  224. tempBytes[2 * i + 1] = nb > 0x09 ? byte((uint8(nb) + 0x37)) : (nb | 0x30);
  225. }
  226. return string(tempBytes);
  227. }
  228. function strJoin(string _a, string _b, string _c, string _d, string _e) internal pure returns (string){
  229. bytes memory _ba = bytes(_a);
  230. bytes memory _bb = bytes(_b);
  231. bytes memory _bc = bytes(_c);
  232. bytes memory _bd = bytes(_d);
  233. bytes memory _be = bytes(_e);
  234. string memory abcde = new string(_ba.length + _bb.length + _bc.length + _bd.length + _be.length);
  235. bytes memory babcde = bytes(abcde);
  236. uint k = 0;
  237. for (uint i = 0; i < _ba.length; i++) babcde[k++] = _ba[i];
  238. for (i = 0; i < _bb.length; i++) babcde[k++] = _bb[i];
  239. for (i = 0; i < _bc.length; i++) babcde[k++] = _bc[i];
  240. for (i = 0; i < _bd.length; i++) babcde[k++] = _bd[i];
  241. for (i = 0; i < _be.length; i++) babcde[k++] = _be[i];
  242. return string(babcde);
  243. }
  244. function strJoin(string _a, string _b, string _c, string _d) internal pure returns (string) {
  245. return strJoin(_a, _b, _c, _d, "");
  246. }
  247. function strJoin(string _a, string _b, string _c) internal pure returns (string) {
  248. return strJoin(_a, _b, _c, "", "");
  249. }
  250. function strJoin(string _a, string _b) internal pure returns (string) {
  251. return strJoin(_a, _b, "", "", "");
  252. }
  253. }

API 使用示例

  
  1. pragma solidity ^0.4.0;
  2. pragma experimental ABIEncoderV2;
  3. import './ChainDataInterface.sol'
  4. import './ChainDataCmdHelper.sol'
  5. // 实现一个 demo 合约
  6. contract BizContract {
  7. // 账本数据合约
  8. identity ibc_base_address;
  9. // 业务 ID 与账本数据访问请求 ID 的关联关系
  10. mapping(bytes32 => bytes32) requests;
  11. // 权限控制
  12. modifier onlyIbcBase() {
  13. require(msg.sender == ibc_base_address, "PERMISSION_ERROR: Permission denied!");
  14. _;
  15. }
  16. // 配置账本数据合约 ID
  17. function setIbcBaseAddress(identity _addr) public {
  18. ibc_base_address = _addr;
  19. }
  20. // 调用账本数据合约的账本数据访问接口访问目标区块链指定一笔交易
  21. function chainDataRequest(bytes32 biz_id, string domain, bytes block_hash, string path, string parser) public {
  22. // 1. 跨合约调用,需要通过合约接口定义及账本数据合约 ID 生成一个合约对象
  23. ChainDataInterface ibc = ChainDataInterface(ibc_base_address);
  24. // 2. 拼装账本数据访问命令,拼装区块链头查询命令
  25. string cid = ChainDataCmdHelper.buildMychain010HeaderCID(block_hash);
  26. string cmd = ChainDataCmdHelper.buildCommand(domain, cid, path, parser);
  27. // 3. 发送账本数据访问请求
  28. bytes32 request_id = ibc.chainDataRequest(biz_id, cmd, true, this, 0);
  29. // 4. 记录账本数据合约返回的 request id
  30. requests[biz_id] = request_id;
  31. // 5. 请求阶段结束,等待回调
  32. return;
  33. }
  34. // 业务合约用于接收账本数据合约的账本数据访问请求结果回调
  35. function chainDataCallbackResponse (bytes32 _request_id, bytes32 _biz_id, uint32 _error_code, bytes _resp_body, identity _call_identity) onlyIbcBase external returns (bool) {
  36. // 业务处理返回账本数据
  37. return true;
  38. }
  39. }

Mychain/C++ 合约

C++ 合约开发流程

用户智能合约使用账本数据访问 API 接口,开发流程如下:

  1. 在 BaaS 平台上获取账本数据合约名称。
  2. 获取账本数据访问 API 接口定义(见 API 接口定义 章节)。
  3. 用户合约构建账本数据访问请求。
  4. 用户合约实现回调接口,用于异步接收账本数据进行回调。
  5. 用户合约向账本数据合约发送请求,具体参考 API 使用示例
  6. 账本数据服务返回数据为 JSON 格式,具体格式参考 账本数据结构 章节。

API 使用流程

用户合约调用账本数据合约的账本数据访问接口发起查询请求,账本数据合约同步返回查询请求句柄,即请求单据号(reqeust_id)。账本数据合约获取到查询结果数据后,异步回调用户合约的回调接口。

API 接口定义

账本数据合约实现 ChainDataRequest 接口;客户合约调用账本数据合约的 ChainDataRequest 接口发送请求。客户合约实现 ChainDataCallbackResponse 接口,用于接收账本数据合约的查询账本数据结果。账本数据合约回调客户合约 ChainDataCallbackResponse 接口,返回账本数据。

  
  1. /**
  2. * function: ChainDataRequest
  3. * usage: 用户合约调用账本数据合约发送跨链账本数据访问请求
  4. * parameters:
  5. * _biz_id :用户自定义的业务请求 ID
  6. * _chain_data_cmd :账本数据访问命令,参考参数说明部分参数改造说明
  7. * _if_callback :是否需要账本数据合约将请求结果回调用户合约
  8. * _callback_identity :账本数据合约请求结果回调的合约 ID,可以是发送请求的合约,也可以是其他合约
  9. * _delay_time :该特性未激活,填 0 即可
  10. * return value :查询请求 ID,是账本数据合约为本次请求生成的唯一请求 ID
  11. */
  12. INTERFACE std::string ChainDataRequest(
  13. const std::string& _biz_id,
  14. const std::string& _chain_data_cmd,
  15. const bool& _if_callback,
  16. const std::string& _callback_identity,
  17. const uint32_t& _delay_time);
  18. /**
  19. * function: ChainDataCallbackResponse
  20. * usage: 用户合约需要实现的接口,供账本数据合约合约回调
  21. * parameters:
  22. * _request_id :账本数据访问请求 ID(在发送账本数据请求时账本数据合约会返回此 ID)
  23. * _biz_id :用户合约的业务请求 ID
  24. * _error_code :请求结果码,如果值是 0,则表示预言机请求处理成功;如果是其他值,则为请求处理失败,详见合约错误码表
  25. * _resp_body :账本数据 body
  26. * _call_identity :发起该请求的合约 ID
  27. * return value :无
  28. */
  29. INTERFACE void ChainDataCallbackResponse (
  30. const std::string& _request_id,
  31. const std::string& _biz_id,
  32. const uint32_t& _error_code,
  33. const std::string& _resp_body,
  34. const std::string& _call_identity);

API 参数说明

下面是针对 chain_data_cmd 的构造说明。账本数据访问接口需要用户指定要访问的区块链域名、资源类型和资源 ID,以及对于资源数据的加工处理。详细命令语法格式如下。

  
  1. 语法:
  2. udag udag://udag-domain/CID [options]
  3. 其中 udag-domain 为目标区块链域名,CID 为区块链资源描述 IDoptions 是可选参数。
  4. 描述:
  5. udag 命令是跨链数据服务的账本数据访问服务提供的接口必要传入参数之一。udag 命令描述了指定访问目的区块链资源的 URI,以及其他可选配置项。
  6. 选项:
  7. --json-path <value>
  8. 指定了对账本数据进行 jsonpath 处理。
  9. jsonpath 语法说明:https://goessner.net/articles/JsonPath/
  10. 目前支持:$.[]*
  11. e.g.
  12. --json-path '$.obj' 取子对象
  13. --json-path '$[0]' 从数组取下标
  14. --json-path "$['obj']" 取子对象
  15. --json-path '$[0,1].obj' 取多个对象

API 使用示例

以下是账本数据访问服务的客户合约示例。

  
  1. #include <mychainlib/contract.h>
  2. using namespace mychain;
  3. class ChainDataRequestDemo:public Contract {
  4. public:
  5. // 跨链账本数据访问接口的 API 定义
  6. const std::string CHAIN_DATA_REQUEST_API = "ChainDataRequest";
  7. /**
  8. * 调用账本数据合约的账本数据访问接口访问目标区块链指定一笔交易
  9. **/
  10. INTERFACE void ChainDataRequest(const std::string& ibc_base_address, const std::string& biz_id, const std::string& chain_data_cmd){
  11. // 1. 调用跨链合约接口,发送请求
  12. Identity address(ibc_base_address);
  13. auto ret = CallContract<std::string>(address, CHAIN_DATA_REQUEST_API, 0, 0,
  14. biz_id,
  15. chain_data_cmd,
  16. true,
  17. GetSelf().to_hex(),
  18. 0);
  19. // 2. 调用结果校验
  20. Require(ret.code == 0, "call corss_chain_contract fail " + address.to_hex() + " : " + ret.msg);
  21. // 3. 处理请求信息
  22. // 一般保存请求 ID,即 ret.result 字段
  23. // 4. 请求阶段结束,等待回调
  24. return;
  25. }
  26. /**
  27. * 业务合约用于接收账本数据合约的账本数据访问请求结果回调
  28. **/
  29. INTERFACE void ChainDataCallbackResponse (const std::string& _request_id,
  30. const std::string& _biz_id,
  31. const uint32_t& _error_code,
  32. const std::string& _resp_body,
  33. const std::string& _call_identity){
  34. // 业务自定义的逻辑,处理返回账本数据
  35. // ...
  36. return true;
  37. }
  38. }

账本数据结构

  • Mychain 区块头结构
  
  1. {
  2. "Hash": "750a1ae6f4053ff141bd243e48713130501eb19c00ad04e0befe9dcb0f69381c",
  3. "Number": 64259,
  4. "Version": 0,
  5. "ParentHash": "4ebbbb964fec85dfbe8fbb2e800944bba0532042b08fc5978da4e619cc101f1e",
  6. "TransactionRoot": "36b8d9e7834fb09cdc62fdd73dfa96ee447b5a346417cb9d913277a9b67639c0",
  7. "ReceiptRoot": "2ffb03de688b2163960aa86a408caf49dc8d0f984d9b22134c561371074d0e8f",
  8. "StateRoot": "faf6f0bad73aa4bf11e60552e3b53242b7d7983ba408ca485ae7bf3799fd17b0",
  9. "GasUsed": 20690,
  10. "Timestamp": 1539921657732
  11. }
  • Mychain 交易结构
  
  1. {
  2. "Hash": "36b8d9e7834fb09cdc62fdd73dfa96ee447b5a346417cb9d913277a9b67639c0",
  3. "Type": 0,
  4. "Timestamp": 1539921657722,
  5. "Nonce": 13717934618841259934,
  6. "Period": 1539921657722,
  7. "From": "cb84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  8. "To": "cb84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  9. "Value": 0,
  10. "Gas": 1000000,
  11. "Data": "f843b840fdbc52f9acdd26a8382b1384c831f88b99a0c19716e386b0899c9fee43befcf0b2eba0cdabc71506be74f1de93d9752023ebe999eac323f60d7c1717fed9128f64",
  12. "Signatures": ["9ddd1019e85b8857989503de5d4aa7c5520467265e3d0dda2b3d461a60dea2906c079264bc65b04e7ffe7c6c3f60ed96c313d9c2bff57cac36835c397712e46101"]
  13. }
  • Mychain 区块结构
  
  1. {
  2. "Hash": "750a1ae6f4053ff141bd243e48713130501eb19c00ad04e0befe9dcb0f69381c",
  3. "Number": 64259,
  4. "Version": 0,
  5. "ParentHash": "4ebbbb964fec85dfbe8fbb2e800944bba0532042b08fc5978da4e619cc101f1e",
  6. "TransactionRoot": "36b8d9e7834fb09cdc62fdd73dfa96ee447b5a346417cb9d913277a9b67639c0",
  7. "ReceiptRoot": "2ffb03de688b2163960aa86a408caf49dc8d0f984d9b22134c561371074d0e8f",
  8. "StateRoot": "faf6f0bad73aa4bf11e60552e3b53242b7d7983ba408ca485ae7bf3799fd17b0",
  9. "GasUsed": 20690,
  10. "Timestamp": 1539921657732,
  11. "ConsensusProof": "MNrjZ54NPsJzcYv3XPfqW7kR7WjRkF8udkTJ3qbZ2OcA=",
  12. "Txs": [{
  13. "Hash": "36b8d9e7834fb09cdc62fdd73dfa96ee447b5a346417cb9d913277a9b67639c0",
  14. "Type": 0,
  15. "Timestamp": 1539921657722,
  16. "Nonce": 13717934618841259934,
  17. "Period": 1539921657722,
  18. "From": "cb84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  19. "To": "cb84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  20. "Value": 0,
  21. "Gas": 1000000,
  22. "Data": "f843b840fdbc52f9acdd26a8382b1384c831f88b99a0c19716e386b0899c9fee43befcf0b2eba0cdabc71506be74f1de93d9752023ebe999eac323f60d7c1717fed9128f64",
  23. "Signatures": ["9ddd1019e85b8857989503de5d4aa7c5520467265e3d0dda2b3d461a60dea2906c079264bc65b04e7ffe7c6c3f60ed96c313d9c2bff57cac36835c397712e46101"]
  24. }],
  25. "Receipts": [{
  26. "Offset": "0",
  27. "Result": "SUCCESS",
  28. "GasUsed": "20690",
  29. "Output": "0",
  30. "LogEntries": [{
  31. "From": "cb84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  32. "To": "b84ac09120827b41e01de5494cd25bb06fd7b709879a34f72b8e44b0e6b276f",
  33. "Topics": ["7570646174655f617574685f6d6170"],
  34. "LogData": ""
  35. }]
  36. }]
  37. }

错误码

下表汇总了使用账本数据访问服务过程中的账本数据合约相关错误码:

错误码 16 进制错误码 10 进制错误 描述 解决方法
OE_SUCCESS 0x0000 0 查询成功
OE_UNKNOWN_ERROR 0x0002 2 未知错误 联系管理员
OE_UDAG_QUERY_FAILED 0x3000 12288 查询失败 联系管理员
OE_UDAG_DOMAIN_ERROR 0x3010 12304 域名不存在 检查域名正确性
OE_UDAG_CID_ERROR 0x3012 12306 CID 错误 检查账本数据哈希是否正确

合约消息推送服务

目前,合约消息推送服务支持的客户智能合约语言包括 Mychain 平台的 Solidity 和 C++ 语言;Hyperledger Fabric 平台不限语言。

Mychain/Solidity 合约

Solidity 合约开发流程

用户智能合约使用合约消息推送服务 API 接口,开发流程如下:

  1. 在 BaaS 平台上获取消息合约名称。
  2. 获取合约消息推送 API 接口定义(见 API 接口定义 章节)。
  3. 在用户合约中引入合约消息推送 API 接口。
  4. 用户合约实现接收消息接口,供跨链消息收发合约调用。
  5. 用户合约调用跨链消息收发合约发送消息接口。

API 接口定义

InterContractMessageInterface.sol 中定义了跨链消息收发合约提供的合约消息推送 API 接口,用户合约调用跨链消息收发合约sendMessage 接口发送消息。用户合约实现 recvMessage接口,用于接收跨链消息。

  
  1. pragma solidity ^0.4.22;
  2. interface InterContractMessageInterface {
  3. /**
  4. * function: sendMessage
  5. * usage: 用户合约call 跨链消息收发合约发送跨链消息
  6. * parameters:
  7. * _destination_domain :目标区块链域名
  8. * _receiver :接收消息的合约账号,根据合约名称或者链码名计算sha256获得
  9. * _message :消息内容
  10. * return value :无
  11. */
  12. function sendMessage(string _destination_domain, identity _receiver, bytes _message) external;
  13. /**
  14. * function: recvMessage
  15. * usage: 用户合约需要实现的接口,供跨链消息收发合约合约调用,接收跨链消息
  16. * parameters:
  17. * _from_domain :消息来源区块链
  18. * _sender :消息来源的合约账号名称/链码名的sha256哈希值
  19. * _message :消息内容
  20. * return value :无
  21. */
  22. function recvMessage(string _from_domain, identity _sender, bytes _message) external ;
  23. }

API 使用示例

  
  1. pragma solidity ^0.4.0;
  2. pragma experimental ABIEncoderV2;
  3. import './InterContractMessageInterface.sol'
  4. // 实现一个 demo 合约
  5. contract BizContract {
  6. // 消息合约
  7. identity ibc_msg_address;
  8. // 权限控制
  9. modifier onlyIbcMsg() {
  10. require(msg.sender == ibc_msg_address, "PERMISSION_ERROR: Permission denied!");
  11. _;
  12. }
  13. // 配置消息合约 ID
  14. function setIbcMsgAddress(identity _addr) public {
  15. ibc_msg_address = _addr;
  16. }
  17. // 调用消息合约的发送消息接口,发送一笔消息给目标区块链上特定合约
  18. function sendRemoteMsg (string _domain, identity _receiver, bytes _msg) public {
  19. // 1. 跨合约调用,需要通过合约接口定义及消息合约 ID 生成一个合约对象
  20. InterContractMessageInterface ibc = InterContractMessageInterface(ibc_msg_address);
  21. // 2. 发送跨链消息
  22. ibc.sendMessage(_domain, _receiver, _msg);
  23. // 3. 发送消息结束
  24. return;
  25. }
  26. // 业务合约用于接收账本数据合约的账本数据访问请求结果回调
  27. function recvMessage ( string _from_domain, identity _sender, bytes _message ) onlyIbcMsg external {
  28. // 业务处理接收到的跨链消息
  29. return true;
  30. }
  31. }

Mychain/C++ 合约

C++ 合约开发流程

用户智能合约使用合约消息推送服务 API 接口,开发流程如下:

  1. 在 BaaS 平台上获取消息合约名称。
  2. 获取合约消息推送 API 接口定义(见 API 接口定义 章节)。
  3. 在用户合约中引入合约消息推送 API 接口。
  4. 用户合约实现接收消息接口,供跨链消息收发合约调用。
  5. 用户合约调用跨链消息收发合约发送消息接口。

API 接口定义

以下是合约消息推送服务的 C++ 合约 API 接口定义。用户合约调用跨链消息收发合约 SendMessage 接口发送消息。用户合约实现 RecvMessage 接口,用于接收跨链消息。

  
  1. /**
  2. * function: SendMessage
  3. * usage: 用户合约调用跨链消息收发合约发送跨链消息
  4. * parameters:
  5. * _destination_domain :目标区块链域名
  6. * _receiver :接收消息的合约账号,根据合约名称或者链码名计算 SHA256 的 hex 值
  7. * _message :消息内容
  8. * return value :无
  9. */
  10. INTERFACE void SendMessage(const string& _destination_domain, const string& _receiver,
  11. const string& _message);
  12. /**
  13. * function: RecvMessage
  14. * usage: 用户合约需要实现的接口,供跨链消息收发合约合约调用,接收跨链消息
  15. * parameters:
  16. * _from_domain :消息来源区块链
  17. * _sender :消息来源的合约账号名称/链码名的 SHA256 的 hex 值
  18. * _message :消息内容
  19. * return value :无
  20. */
  21. INTERFACE void RecvMessage(const string& _from_domain, const string& _sender,
  22. const string& _message);

API 使用示例

以下是合约消息推送服务的客户合约示例。

  
  1. #include <mychainlib/contract.h>
  2. using namespace mychain;
  3. class BizContract:public Contract {
  4. public:
  5. // 调用消息合约的发送消息接口,发送一笔消息给目标区块链上特定合约
  6. INTERFACE void sendRemoteMsg(const std::string& domain, const std::string& receiver, const std::string& msg, const std::string& p2p_msg_address){
  7. // 1.1 声明跨链消息合约的合约地址
  8. Identity p2p(p2p_msg_address);
  9. // 1.2 调用消息合约
  10. auto ret = CallContract<void>(p2p, "SendMessage", 0, 0,
  11. domain, // 目标区块链域名
  12. receiver, // 接收者 蚂蚁链合约名称/Fabric链码名称,经过sha256 计算后的地址
  13. msg // 跨链消息内容
  14. );
  15. // 2. 校验是否发送成功
  16. Require(ret.code == 0, "call p2p fail." + ret.msg);
  17. // 3. 发送消息结束
  18. return;
  19. }
  20. // 业务合约用于接收账本数据合约的账本数据访问请求结果回调
  21. INTERFACE void RecvMessage(const std::string& _from_domain, const std::string& _sender, const std::string& _message) {
  22. // 业务自定义逻辑,处理接收到的跨链消息
  23. return true;
  24. }
  25. };

Fabric 合约(不限语言)

智能合约开发流程

用户智能合约使用合约消息推送服务 API 接口,开发流程如下:

  1. 在 Baas 平台上获取跨链链码名称。
  2. 用户链码实现接收消息接口,供跨链链码调用,接收跨链消息。
  3. 用户链码调用跨链链码发送消息接口。

API 接口定义

  
  1. # 跨链链码实现,用户链码调用
  2. functionsendMessage
  3. usage: 客户链码调用跨链链码发送消息
  4. params: args []string
  5. args[0] 目的地区块链的域名(必选)
  6. args[1] 目的地合约账号(必选),十六进制字符串,长度 64
  7. args[2] 消息内容(必选)
  8. args[3] 消息nounce(可选),区分同一笔交易内发送多个消息的标识
  9. # 用户链码实现,跨链链码调用
  10. functionrecvMessage
  11. usage: 跨链链码调用用户链码接收消息
  12. params: args []string
  13. args[0] 源区块链的域名(必选)
  14. args[1] 源合约账号(必选),十六进制字符串,长度为 64
  15. args[2] 消息内容(必选)

API 使用示例(Go 语言)

Fabric 平台提供的 API 是链码间调用 API,客户链码可以使用任意语言来实现其业务。以下是以 Go 语言开发的客户链码示例。

  
  1. package main
  2. import (
  3. "fmt"
  4. "github.com/hyperledger/fabric/core/chaincode/shim"
  5. pb "github.com/hyperledger/fabric/protos/peer"
  6. )
  7. // 实例化合约
  8. func main() {
  9. if err := shim.Start(NewCrossChainTest()); err != nil {
  10. fmt.Printf("Error starting Biz chaincode: %s", err)
  11. }
  12. }
  13. // 跨链合约数据结构
  14. type CrossChainTest struct {
  15. }
  16. // 构造跨链合约
  17. func NewCrossChainTest() *CrossChainTest {
  18. return &CrossChainTest{
  19. }
  20. }
  21. // 初始化 Init 函数
  22. func (bs *CrossChainTest) Init(stub shim.ChaincodeStubInterface) pb.Response {
  23. return shim.Success([]byte("Init success"))
  24. }
  25. /*
  26. * 合约调用
  27. */
  28. func (bs *CrossChainTest) Invoke(stub shim.ChaincodeStubInterface) pb.Response {
  29. fn, args := stub.GetFunctionAndParameters()
  30. switch fn {
  31. // 用户自定义方法
  32. case "testSendMessage":
  33. // 对外发送的消息
  34. // args[0]: 跨链链码名字,从 Baas 平台上查询获取
  35. // args[1]: 目的区块链域名
  36. // args[2]: 接收者身份
  37. // 如果目的区块链是蚂蚁区块链,账号为账号地址 (32 字节) hex 字符串,不要以 0x 开头
  38. // 如果目的区块链时 Fabric,账号为接收消息的链码名字进行 sha256 后哈希值的 hex 字符串
  39. // args[3]: 发送消息内容
  40. // args[4]: 发送消息内容 nounce
  41. if len(args) != 5 {
  42. fmt.Println("Unexpected args len")
  43. return shim.Error("Unexpected args len")
  44. }
  45. fmt.Printf("CrossChainTest send message to %s::%s, content is %s\n", args[0], args[1], args[2])
  46. // 调用跨链链码
  47. var (
  48. cc = args[0] // 跨链utility链码名字
  49. )
  50. var args_cross = [][]byte {
  51. []byte("sendMessage"), // 发送跨链消息
  52. []byte(args[1]), // 目标区块链域名
  53. []byte(args[2]), // 接收消息的 mychain 客户合约地址
  54. []byte(args[3]), // 发送的消息
  55. []byte(args[4]), // 发送的消息 nounce
  56. }
  57. re := stub.InvokeChaincode(cc, args_cross, stub.GetChannelID())
  58. return re
  59. //客户合约实现接收有序消息接口
  60. case "recvMessage": // 接收消息
  61. return bs.recvMessage(stub, args[0], args[1], args[2])
  62. default:
  63. return shim.Error("Method not found")
  64. }
  65. }
  66. //客户合约必须实现接口
  67. func (bs *CrossChainTest) recvMessage(stub shim.ChaincodeStubInterface, sourceDomain string, sourceIdentity string, message string) pb.Response {
  68. // sourceDomain stirng, // 消息来源区块链的域名
  69. // sourceIdentity string, // 消息发送者身份
  70. // message string) // 消息内容
  71. // 补充具体实现
  72. fmt.Printf("CrossChainTest recv message from domain:%s, identity:%s, msg:%s\n", sourceDomain, sourceIdentity, message)
  73. return shim.Success(nil)
  74. }

请关注公众号获取更多资料

发表评论

电子邮件地址不会被公开。 必填项已用*标注