第9回　BBc-1ソースコードやドキュメント類

今回はgithubに公開されているBBc-1のリポジトリの構成や内容について説明します。Web上で確認できますが、gitコマンドでcloneしてリポジトリ全体を取得していただいても構いません。

BBc-1のプロジェクト構成

BBc-1は複数のリポジトリ群から構成されており、必要に応じて組み合わせて使います。こちらのURLをご覧ください。

2018年10月末時点では、6つのリポジトリが登録されています。

表1　beyond-blockchainの主要リポジトリ

リポジトリ名	概要
bbc1	BBc-1のコア機能のリファレンス実装です。
libbbcsig	BBc-1の署名作成・検証のためのライブラリで、高速化のためここだけC言語で実装されています。bbc1およびその他実装で利用します。
ledger_subsystem	EthereumおよびBitcoinにアンカリング（※）するための追加機能です。bbc1に組み込んで使います。
bbc1-lib-std	bbc1のユーザIDと公開鍵の紐付けを管理するためのライブラリです。bbc1のアプリケーションに組み込むことができます。
bbc1-lib-tokens	トークン系アプリケーションのためのライブラリです。bbc1のアプリケーションに組み込むことができます。
examples	サンプルアプリケーションです。

※アンカリングとは：
BBc-1トランザクション群のマークル木を外部ブロックチェーンに書き込み、外部システムを利用した存在証明を行うための機能です。

bbc1とlibbbcsigは必ずセットで利用します。分離しているのは、BBc-1の署名作成・検証機能をさまざまなBBc-1実装に使えるようにするためです。今回以降の記事は、基本的にはbbc1リポジトリの内容について説明していきます。

bbc1リポジトリの中を見ていきましょう。いくつかのディレクトリが含まれています。

表2　bbc1リポジトリ内の主なディレクトリ

ディレクトリ名	概要
bbc1/core/	BBc-1のコア機能のPythonスクリプトが格納されています。
docker/	Dockerコンテナ上でbbc1を動作させるためのスクリプトが格納されています。
docs/	ドキュメント群が格納されています。PDFファイル群と、sphinxによるAPIドキュメントが含まれます。
examples/file_proof/	ファイルの存在証明のサンプルアプリケーションが格納されています。その他のサンプルは、先に紹介したexamplesリポジトリに移行されました。
tests/	テストコード群が格納されています。
utils/	bbc1のcoreプロセスを制御するためのツール群が格納されています。

今回は、ドキュメントについて重点的に紹介し、最後にexamplesのツールの導入と使い方について簡単にご紹介します。

全体概要や使い方、プログラミング方法については、docs/ディレクトリの中にPDFファイルやmarkdown形式で各種ドキュメントが含まれます。

とにかく触ってみようという方は、上記のドキュメントの中の、

の順に読んでいただくのをおすすめします。次回は、その内容を簡単にまとめたものになります。

アプリを作ることも視野に入れたい、または仕組みを知りたい場合は、

の順で読んでいただくのをおすすめします。もしPythonに精通されているようでしたら、リポジトリ内のsrc/core/ディレクトリ内にあるソースコードをあわせて確認しながらの方が理解しやすいかもしれません（そのようにコメントされた方がいらっしゃいました⁠）⁠。

今回は、githubに公開されているBBc-1のリポジトリ、特に中心となるbbc1リポジトリについて紹介し、docs/ディレクトリ内のドキュメントの概要について触れました。なお、本連載のこれまでの内容は、BBc憲章とBBc-1設計書を説明したものになっています。

次回は、bbc1リポジトリに含まれているサンプルアプリケーションのfile_proof.pyの使い方について説明します。