@caict/bop-typescript-sdk 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,34 @@
+# bop-typescript-sdk changes
+
+* * *
+
+**Changes in 1.0.0**  
+
+适用：bop-typescript-sdk版本v1.0.0  
+
+[add] 支持星火链相关查询接口
+
+[add] 支持账户相关的有效性校验、创建与查询接口
+
+[add] 支持合约相关的有效性校验、创建与查询接口 
+
+[add] 支持构建交易及交易查询接口  
+
+[add] 支持区块的查询接口
+
+[add] 支持星火开放平台相关账号许可接口
+
+[add] 支持公私钥地址创建、解析、验签与密钥存储器构建、解析接口
+
+[add] 支持助记词生成与解析接口
+
+更新日期：2025-3-12
+
+* * *
+
+  *注：*
+  [add]代表新增内容  
+
+  [opt]代表优化内容  
+
+  [bug]代表修复的bug  

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) 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
+
+      (d) 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 2025 Corporation CAICT All rights reserved.
+
+   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.

package/NOTICE

@@ -0,0 +1,5 @@
+Apache SkyWalking
+Copyright 2025 The Apache Software Foundation
+
+This product includes software developed at
+The Apache Software Foundation (http://www.apache.org/).

package/README.md

@@ -0,0 +1,112 @@
+# bop-typescript-sdk
+
+[bop] sdk to develop with Xinghuo BIF Open Platform
+
+## What
+
+The current package is primarily designed to implement interfaces for the Xinghuo Open Platform. Up to now, it has already realized two major modules, namely, the [Basic Service API] and the [Message Subscription Service]. Through these modules, direct communication with the Xinghuo Open Platform is feasible. In addition, relevant protocol components are handled using Protocol Buffers (protobuf).
+
+## Installation
+
+First, you need to install the sdk by running
+
+```bash
+npm install @caict/bop-typescript-sdk
+```
+
+And add the following statement to your file:
+
+```js
+require("@caict/bop-typescript-sdk");
+```
+
+Or, if you are using TypeScript, add this to your file:
+
+```ts
+import "@caict/bop-typescript-sdk";
+```
+
+## Use example
+
+### https service
+
+```ts
+import {
+  Config,
+  ProviderByBop,
+  BopInterface,
+  SignerByBop,
+} from "@caict/bop-typescript-sdk";
+
+(async () => {
+  let config = new Config("https://bif-mainnet.bitfactory.cn", "xxx", "xxx");
+  let provider = new ProviderByBop(new BopInterface(config));
+  console.log(await provider.chain.getChainInfo());
+
+  let signer = new SignerByBop("your enc private key");
+  let signerWithProvider = signer.connect(provider);
+  console.log(await signerWithProvider.getAccount());
+})();
+```
+
+### ws service
+
+```ts
+import {
+  WsProviderByBop,
+  BopWsInterface,
+  WsConfig,
+  bopwsprotocol,
+} from "@caict/bop-typescript-sdk";
+
+async function main() {
+  try {
+    // 创建 BopWsInterface 实例，这里假设已经有 bopWs 实例化代码，可根据实际情况修改
+    const config = new WsConfig("ws://bif-mainnet.bitfactory.cn/bif/subscribe"); // 替换为实际的 WebSocket 地址
+    const bopWs = new BopWsInterface(config.url, config.heartBeatInterval);
+
+    // 标志位，用于判断 BLOCK_HEADER 回调是否已经发生
+    let blockHeaderCallbackTriggered = false;
+
+    const subscriptionBlockHeaderId = await bopWs.bop.subscribe(
+      bopwsprotocol.MessageType.BLOCK_HEADER,
+      (data) => {
+        let message: LedgerHeaderMessage = {};
+        message = LedgerHeaderMessage.fromJSON(data);
+        console.log("dealBlockHeader ing...", message);
+
+        // 设置标志位为 true，表示回调已经发生
+        blockHeaderCallbackTriggered = true;
+      },
+    );
+    console.log("Subscription BlockHeader ID:", subscriptionBlockHeaderId);
+
+    if (subscriptionBlockHeaderId !== "-1") {
+      // 等待 BLOCK_HEADER 回调发生
+      await new Promise<void>((resolve) => {
+        const intervalId = setInterval(() => {
+          if (blockHeaderCallbackTriggered) {
+            clearInterval(intervalId);
+            resolve();
+          }
+        }, 100); // 每 100 毫秒检查一次标志位
+      });
+      // 取消订阅
+      await bopWs.bop.unsubscribe(
+        bopwsprotocol.MessageType.BLOCK_HEADER,
+        subscriptionBlockHeaderId,
+      );
+      console.log("Unsubscribed from BLOCK_HEADER");
+    }
+
+    // 断开连接
+    await bopWs.bop.disconnect();
+    console.log("Disconnected from WebSocket");
+  } catch (error) {
+    console.error("An error occurred:", error);
+  }
+}
+
+// 调用 main 函数
+main();
+```

package/package.json

@@ -0,0 +1,90 @@
+{
+  "name": "@caict/bop-typescript-sdk",
+  "version": "1.0.0",
+  "description": "Xinghuo bop sdk",
+  "main": "dist/index.js",
+  "files": [
+    "src",
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "npm run test:compile",
+    "lint": "npx prettier --check . && npx eslint .",
+    "lint:fix": "npx prettier --write . && npx eslint --fix .",
+    "clean": "rm -rf ./dist",
+    "test": "npm run test:compile && npm run test-bop && npm run test-sdk",
+    "test:compile": "tsc --project tsconfig.json && copyfiles -u 4 src/bop-sdk/interface/service/offline/**/* dist/bop-sdk/interface/service/",
+    "test-bop": "npm run test:compile && mocha --recursive 'dist/bop/**/test/**/*.js' -c --exit --timeout 30000",
+    "test-sdk": "npm run test:compile && mocha --recursive 'dist/bop-sdk/**/test/**/*.js' -c --exit --timeout 30000",
+    "ws-demo": "npm run build && node dist/bop/bop-ws/sample/sample.js"
+  },
+  "keywords": [
+    "caict",
+    "bop"
+  ],
+  "author": {
+    "name": "maxufeng",
+    "email": "maxufeng@caict.ac.cn"
+  },
+  "license": "apache2.0",
+  "engines": {
+    "node": "18.20.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/caict-4iot-dev/bop-typescript-sdk"
+  },
+  "bugs": {
+    "url": "https://github.com/caict-4iot-dev/bop-typescript-sdk/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@bifproject/bs58": "^5.0.0",
+    "@bufbuild/protobuf": "^2.2.3",
+    "@caict/bif-encryption": "^1.0.1",
+    "@caict/bif-protocol": "^1.0.2",
+    "@types/chai": "^4.2.0",
+    "@types/mocha": ">=9.1.0",
+    "@types/node": "^18.0.0",
+    "@types/sinon": "^9.0.8",
+    "assert": "^2.1.0",
+    "bignumber.js": "^9.1.2",
+    "bn.js": "^5.2.1",
+    "brdc-sjcl": "^1.1.1",
+    "chalk": "^2.4.2",
+    "co-wrap-all": "^1.0.0",
+    "crypto": "^1.0.1",
+    "crypto-js": "^4.2.0",
+    "debug": "^4.1.1",
+    "eslint": "^9.5.0",
+    "fs-extra": "^7.0.1",
+    "io-ts": "^1.10.4",
+    "is-type-of": "^2.1.0",
+    "js-sha3": "^0.9.3",
+    "json-bigint": "^1.0.0",
+    "lodash": "^4.17.11",
+    "long": "^5.2.3",
+    "merge-descriptors": "^2.0.0",
+    "randombytes": "^2.1.0",
+    "reconnecting-websocket": "^4.4.0",
+    "request-promise": "^4.2.6",
+    "semver": "^6.3.0",
+    "sjcl": "^1.0.8",
+    "typescript": "~5.0.0",
+    "ws": "^8.18.0"
+  },
+  "devDependencies": {
+    "chai": "4.2.0",
+    "chai-as-promised": "^8.0.1",
+    "copyfiles": "^2.4.1",
+    "mocha": "^11.0.1",
+    "mocha-typescript": "^1.1.17",
+    "sinon": "^19.0.2",
+    "ts-node": "^10.9.2",
+    "ts-proto": "^2.6.0"
+  }
+}

package/src/bop/bop-base/README.md

@@ -0,0 +1,5 @@
+# bop-base
+
+The basic APIs of Xinghuo BIF Open Platform
+
+# API