5 Star 3 Fork 1

区块链技术与应用联合实验室 / RCJS

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

RCJS

介绍

RCJS(RepChain Client library for JavaScript),是基于JavaScript实现的用于与RepChain区块链网络进行交互的工具包,可作为开发RepChain DApp(Decentralized Application)的SDK。

RCJS对调用RepChain的相应Websocket API, Restful API等进行了封装。利用RCJS可较为方便地使DApp与RepChain进行交互。

RCJS兼容浏览器环境以及NodeJS环境,可根据需要在不同环境使用。

Note: 某些加密算法名称在不同环境可能有差异,需注意

RCJS为开发者提供了以下功能:

  • 获取RepChain区块链概要信息:获取区块链网络的区块数量、交易数量及最新区块哈希等信息;
  • 获取RepChain区块数据:支持订阅RepChain出块事件获取区块数据(二进制格式(protobuf序列化)),以及通过Restful API主动获取区块数据(json格式或二进制格式(protobuf序列化));
  • 获取RepChain交易数据:通过Restful API获取交易数据(json格式或二进制格式(protobuf序列化))
  • 构造RepChain签名交易:提供RepChain交易数据的构造及交易签名功能;
  • 提交RepChain签名交易:向RepChain区块链网络提交已构造的签名交易数据;
  • 加密工具:(基于NodeJS Crypto 以及 jsrsasign实现)
    • 生成密码学哈希值
    • 生成非对称密钥对:支持RSA与EC算法
    • 导出/导入密钥:支持生成/解析PEM格式的公钥或私钥
    • 对数据进行签名
    • 验证签名
    • 生成X509证书
    • 生成自签名X509证书
    • 导出/导入X509证书:支持生成/解析PEM格式证书信息
    • 验证证书的签名
    • 生成/解析CSR信息: 支持生成以及反解析PEM格式的CSR信息

使用说明

安装

yarn add rclink

npm i --save rclink

或者在package.json文件中直接使用git地址, 如:

"rclink": "https://gitee.com/BTAJL/RCJS.git#v3.0.0" 

API

API文档可参考这里

使用示例

构建签名交易
import { TRANSACTION, RCPROTO } from "rclink";

......

// 构建部署合约交易
const txToDeploy = TRANSACTION.Transaction.create({
  // 交易类型为部署合约
  type: RCPROTO.rep.proto.Transaction.Type.CHAINCODE_DEPLOY,
  // 合约名称
  chaincodeName: "TestContract",
  // 合约版本号
  chaincodeVersion: 1,
  // 部署合约参数
  chaincodeDeployParams: {
      // 部署超时设定
      timeout: 5000,
      // 合约源码语言
      codeLanguageType: RCPROTO.rep.proto.ChaincodeDeploy.CodeType.CODE_SCALA,
      // 合约法律条文说明
      legalProse: "fake-content",
      // 合约源码
      codePackage: "you_need_input_the_real_sourcecode",
  },
});
// 对交易进行签名
txToDeploy.sign({
  // pem格式私钥
  prvKey: prvKeyPEM,
  // pem格式公钥
  pubKey: pubKeyPEM,
  // 签名算法
  alg: "sha256",
  // 签名者账户标识
  creditCode: "identity-net:121000005l35120456",
  // 签名者账户证书名
  certName: "node1",
});

// 构建调用合约交易
const txToInvoke = TRANSACTION.Transaction.create({
  type: RCPROTO.rep.proto.Transaction.Type.CHAINCODE_INVOKE,
  chaincodeName: "TestContract",
  chaincodeVersion: 1,
  // 调用合约参数
  chaincodeInvokeParams: {
      // 合约方法名
      chaincodeFunction: "transfer",
      // 合约方法参数
      chaincodeFunctionArgs: [`{
          "from" : "121000005l35120456",
          "to" : "12110107bi45jh675g",
          "amount" : 5
      }`],
  },
  // 交易唯一标识(可选,未指定时将在签名时自动生成)
  txid: "some-unique-id",
  // 执行交易所需资源上限
  gasLimit: 1000,
  // 合约实例标识,默认为""
  oid: "some-oid"
});
txToInvoke.sign({
  prvKey: prvKeyPEM,
  pubKey: pubKeyPEM,
  alg: "sha256",
  creditCode: "identity-net:121000005l35120456",
  certName: "node1",
});

// 构建更改合约有效性状态交易
const txToSetState = TRANSACTION.Transaction.create({
  type: RCPROTO.rep.proto.Transaction.Type.CHAINCODE_SET_STATE,
  chaincodeName: "TestContract",
  chaincodeVersion: 1,
  // 更改合约有效性状态参数
  chaincodeSetStateParams: {
    // 欲设定的合约状态,true为有效,false为无效
    state: false,
  },
});
txToSetState.sign({
  prvKey: prvKeyPEM,
  pubKey: pubKeyPEM,
  alg: "sha256",
  creditCode: "identity-net:121000005l35120456",
  certName: "node1",
});
提交签名交易
import { CLIENT } from "rclink";

......

// 欲连接的区块链节点Url
const peerUrl = "http://192.168.2.3:9081";

const client = new CLIENT.Client(peerUrl);

const txSignedBuffer = Buffer.from(tx.getTxSignedBuffer());

// 以hex编码字符串形式提交签名交易到区块链节点
client.sendTransaction(txSignedBuffer.toString("hex")).then((res) => {
  if (res.err) {
    console.error("交易预处理失败: ", res.err);
  }
  console.log("已提交交易: ", res.txid);
}).catch((err) => {
  console.error(err);
});

// 或者以二进制形式提交签名交易到区块链节点
client.sendTransaction(txSignedBuffer).then((res) => {
  if (res.err) {
    console.error("交易预处理失败: ", res.err);
  }
  console.log("已提交交易: ", res.txid);
}).catch((err) => {
  console.error(err);
});
获取区块链概要信息
import { CLIENT } from "rclink";

......

// 欲连接的区块链节点Url
const peerUrl = "http://192.168.2.3:9081";

const client = new CLIENT.Client(peerUrl);

client.chainInfo().then((ci) => {
  console.log("当前最新区块高度: ", ci.height);
  console.log("当前交易数量: ", ci.totalTransactions);
  console.log("当前最新区块哈希: ", ci.currentBlockHash);
  console.log("前序区块哈希: ", ci.previousBlockHash);
  console.log("当前世界状态根哈希: ", ci.currentStateHash);
});
获取区块数据
import { CLIENT, RCPROTO, EVENTS } from "rclink";

......

// 欲连接的区块链节点Url
const peerUrl = "http://192.168.2.3:9081";

const client = new CLIENT.Client(peerUrl);

// 根据高度获取区块数据
client.block(1).then((blkJson) => {
  console.log("获取Json格式区块数据", blkJson);
});
client.block(1, CLIENT.RESPONSE_FORMAT.STREAM).then((blkBuffer) => {
  console.log("获取二进制格式区块数据");
  const blk = RCPROTO.rep.proto.Block.decode(blkBuffer);
  console.log(blk);
});

// 根据哈希值获取区块数据
const blockHash = "BHBJXDSJ7182368129gGYUcbdjs7889"
client.block(blockHash).then((blkJson) => {
  console.log("获取Json格式区块数据", blkJson);
});
client.block(blockHash, CLIENT.RESPONSE_FORMAT.STREAM).then((blkBuffer) => {
  console.log("获取二进制格式区块数据");
  const blk = RCPROTO.rep.proto.Block.decode(blkBuffer);
  console.log(blk);
});

// 订阅出块事件,获取区块数据
const peerWebsocketUrl = "ws://192.168.2.3:9081/event";
const et = new EVENTS.EventTube(peerWebsocketUrl, (evt) => {
  const event = Buffer.from(evt.data);
  const msg = RCPROTO.rep.proto.Event.decode(event);
  let block;
  if (msg.blk) {
    block = RCPROTO.rep.proto.Block.decode(msg.blk);
    console.log("订阅获取区块数据", block);
  }
});
获取交易数据
import { CLIENT, RCPROTO, EVENTS } from "rclink";

// 欲连接的区块链节点Url
const peerUrl = "http://192.168.2.3:9081";

const client = new CLIENT.Client(peerUrl);

const txid = "08329673428abc82389772befff32889090";

client.transaction(txid).then((txJson) => {
  console.log("获取Json格式交易数据", txJson);
});

client.transaction(txid, CLIENT.RESPONSE_FORMAT.STREAM).then((txBuffer) => {
  console.log("获取二进制格式交易数据");
  const tx = RCPROTO.rep.proto.Transaction.decode(txBuffer);
  console.log(tx);
});

client.transaction(txid, CLIENT.RESPONSE_FORMAT.JSON, true).then((txWithBlockHeight) => {
  console.log("获取带所属区块高度的Json格式交易数据", txWithBlockHeight);
})
......

另可参考测试用例代码:

开发

安装依赖

  1. 安装node.js和yarn
  2. yarn install

更新protobuf定义

当相应protobuf定义(默认为目录src/protos下的proto文件)需要发生变更时,执行:

yarn build:proto

会在目录src/protos中生成protobuf定义的相应js代码,然后基于生成的代码进行开发

生成lib库

yarn build

生成API文档

yarn doc

生成静态网页形式的API文档,若文档内容有更新则在进行git提交时会自动将API文档提交到专门的git分支api-docs上

运行测试

  1. 建立RepChain开发环境(RepChain v2+, 自动产生交易模式, 且已产生超过1个区块)
  2. 运行测试用例:
    • yarn test:node node环境下运行测试用例
    • yarn test:browser browser环境下运行测试用例
    • yarn test 在node与browser环境下分别运行测试用例
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2018 chen4w Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

RCJS(RepChain Client library for JavaScript),RepChain的客户端开发包JS语言版本,兼容Node以及Browser环境。 展开 收起
JavaScript 等 3 种语言
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
JavaScript
1
https://gitee.com/BTAJL/RCJS.git
git@gitee.com:BTAJL/RCJS.git
BTAJL
RCJS
RCJS
master

搜索帮助