{"id":15015299,"url":"https://github.com/cathayddt/bdk","last_synced_at":"2025-08-21T13:33:10.184Z","repository":{"id":42695559,"uuid":"423697393","full_name":"cathayddt/bdk","owner":"cathayddt","description":"Streamlined blockchain deployment kit for Hyperledger Fabric.","archived":false,"fork":false,"pushed_at":"2024-03-19T03:47:33.000Z","size":7573,"stargazers_count":71,"open_issues_count":13,"forks_count":21,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-23T04:27:03.825Z","etag":null,"topics":["blockchain","command-line-tool","fabric","hyperledger","hyperledger-fabric","nodejs","quorum"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cathayddt.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-02T03:41:32.000Z","updated_at":"2024-06-03T11:47:46.321Z","dependencies_parsed_at":"2024-02-01T10:29:36.211Z","dependency_job_id":"c1305331-10e9-4b06-8e4d-cf689d869d1d","html_url":"https://github.com/cathayddt/bdk","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathayddt%2Fbdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathayddt%2Fbdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathayddt%2Fbdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cathayddt%2Fbdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cathayddt","download_url":"https://codeload.github.com/cathayddt/bdk/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230516192,"owners_count":18238353,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchain","command-line-tool","fabric","hyperledger","hyperledger-fabric","nodejs","quorum"],"created_at":"2024-09-24T19:46:43.803Z","updated_at":"2025-08-21T13:33:10.177Z","avatar_url":"https://github.com/cathayddt.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ch1\u003eBlockchain Development Kit\u003c/h1\u003e\n\u003cpre\u003e\n            ::::::::    :::::::     :::    :::\n         :+:   :+:   :+:   :+:   :+:   :+:\n      +:+    +:+  +:+    +:+  +:+  +:+\n   +#++:++#+   +#+    +:+  +#++:++\n  +#+    +#+  +#+    +#+  +#+  +#+\n #+#   #+#   #+#   #+#   #+#   #+#\n########    ########    ###    ###\n\u003c/pre\u003e\n\n[![NPM](https://img.shields.io/npm/v/%40cathaybc%2Fbdk?logo=npm)](https://www.npmjs.com/package/@cathaybc/bdk) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](./LICENSE) [![codeql-analysis](https://github.com/cathayddt/bdk/actions/workflows/codeql.yml/badge.svg)](https://github.com/cathayddt/bdk/actions/workflows/codeql.yml) [![test-report](https://github.com/cathayddt/bdk/actions/workflows/test-report.yml/badge.svg)](https://github.com/cathayddt/bdk/actions/workflows/test-report.yml) [![unit-test](https://github.com/cathayddt/bdk/actions/workflows/unit-test.yml/badge.svg)](https://github.com/cathayddt/bdk/actions/workflows/unit-test.yml)\n\u003c/div\u003e\n\n提供指令快速建立、管理、監控 blockchain，最大的特色是可以使用互動式的問答，讓使用者可以依續性的問答來完成指令所需要的指令，在每個 BDK 指令的後面，加入 `-i` 或是 `--interactive` 的參數，來使用互動式問答\n\nBDK streamlines the normally complicated process of creating a blockchain with command-line tools and npm packages. Creating, managing, monitoring a blockchain network has never been easier. We support interactive prompts which can be triggered with `-i` or `--interactive` behind all cli commands\n\ne.g.\n\n```\nbdk eth network create -i\n```\n#### Quorum\n![bdk eth network create -i](docs/vhs/bdk-quorum-network-create.gif)\n#### Besu\n![bdk eth network create -i](docs/vhs/bdk-besu-network-create.gif)\n\n```bash\nbdk fabric network create -i\n```\n#### Fabric\n![bdk fabric network create -i](docs/vhs/bdk-fabric-network-create.gif)\n\n## 版本 (Releases)\n\n|      Latest      |      Stable      |\n| ---------------- | ---------------- |\n| [v3.3.1][v3.3.1] | [v3.3.1][v3.3.1] |\n\n[v3.3.1]: https://github.com/cathayddt/bdk/releases/tag/v3.3.1\n\n[更新內容 (Changelog)](CHANGELOG.md)\n\n## 文件 (Documentation)\n\n- 指令文件 CLI Documentation (Work in Progress)\n- [Fabric 使用範例 (Examples)](docs/fabric/EXAMPLE.md)\n- [Quorum 使用範例 (Examples)](docs/eth/EXAMPLE.md)\n- [Besu 使用範例 (Examples)](docs/eth/EXAMPLE.md)\n- [開發指南 (Contributing)](.github/CONTRIBUTING.md)\n- [資安通報 (Security Issues)](SECURITY.md)\n\n## 安裝流程 (Getting Started)\n\n### 環境 (Prerequisites)\n\n- [npm + nodejs](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) node v18, npm v9\n- [docker](https://docs.docker.com/engine/install)\n- [docker-compose](https://docs.docker.com/compose/install) \u003e= 2.20\n- [docker-desktop(MacOS)](https://www.docker.com/products/docker-desktop/) Need Allow Docker Sockers in Advanced Options \n- eslint (vscode plugin, dev-only)\n\n### 主程式安裝 (Installation)\n\n#### 直接安裝 (Direct Install)\n\n```bash\nnpm install -g @cathaybc/bdk@latest\n\n# 初始化 (initialize)\nbdk fabric config init\n```\n\n#### 從原始碼安裝 (Install from Source)\n\n```bash\ngit clone https://github.com/cathayddt/bdk.git\ncd bdk\n\nnpm install\n\nnpm run build:console\n```\n\n## 設定 (Configuration)\n\n### 設定自動完成 (Configure AutoComplete)\n\n```bash\nbdk completion\n```\n\n腳本 (script source is as follows)\n\n```bash\n###-begin-bdk-completions-###\n#\n# yargs command completion script\n#\n# Installation: bdk completion \u003e\u003e ~/.zshrc\n#    or bdk completion \u003e\u003e ~/.zsh_profile on OSX.\n#\n_bdk_yargs_completions()\n{\n  local reply\n  local si=$IFS\n  IFS=$'\n' reply=($(COMP_CWORD=\"$((CURRENT-1))\" COMP_LINE=\"$BUFFER\" COMP_POINT=\"$CURSOR\" bdk --get-yargs-completions \"${words[@]}\"))\n  IFS=$si\n  _describe 'values' reply\n}\ncompdef _bdk_yargs_completions bdk\n###-end-bdk-completions-###\n```\n\n## Hello BDK\n\n使用以下的指令，可以確認 BDK 已安裝完成並且可以開始操作使用\n\nUse the following command to verify that BDK has completed installation and is now ready to be used.\n\n```bash\nbdk hello\n```\n\n如果指令已順利安裝，你會看到 `You have installed bdk successfully!!!` \n\nYou will see `You have installed bdk successfully!!!` if the command line tool is installed successfully.\n\n## 建立一個 Test Network (Create a test network)\n\n使用以下指令，可以建立一個簡單的 Hyperledger Fabric 網路\n\nUse the following command to create a simple Hyperledger Fabric Network.\n\n```bash\n  # create network\n  bdk fabric network create --test-network\n  # start orderer docker container (interactive mode)\n  bdk fabric orderer up -i\n  # start peer docker container (interactive mode)\n  bdk fabric peer up -i\n```\n\n## LICENSE\n\n[Apache2.0](LICENSE)\n\n[src/quorum/instance/infra/kubernetes/charts](./src/quorum/instance/infra/kubernetes/charts) follow [quorum-kubernetes](https://github.com/Consensys/quorum-kubernetes/) repository\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcathayddt%2Fbdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcathayddt%2Fbdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcathayddt%2Fbdk/lists"}