README_JA.md

ibet-Prime

English | 日本語

ibet-Prime は ibet network 向けの証券トークン管理システムです。

機能概要

• ibet-Prime is an API service that enables the issuance and management of security tokens on the ibet network.
• ibet-Prime は、 ibet network 上で証券トークンの発行、期中管理を行うことができる API サービスです。
• ibet-SmartContract プロジェクトで開発されているトークンや様々なスマートコントラクトをサポートしています。
• 証券トークンの台帳管理システムとして、ibet-Prime は日本の法令要件として必要な様々な機能群を提供します。
• フロントエンドのアプリケーションから ibet-Prime の API を呼び出すことによって、簡単に証券トークンの管理サービスを構築することが可能です。

依存

• Python3 - バージョン 3.12
• PostgreSQL - バージョン 15
• GoQuorum
  • ibet-Network の公式の GoQuorum をサポートしています。
  • 最新の hardhat network をローカル開発およびユニットテストで利用しています。

コントラクトのバージョン

• ibet-SmartContract: 最新バージョンのコントラクトの仕様をサポートしています。
• 詳細を参照ください。

セットアップ

Prerequisites

• Python 実行環境を整備してください。
• PostgreSQL を設定し、以下のDBを事前に作成してください。
  • デフォルトでは以下の設定が必要になります。
    • ユーザー: issuerapi
    • パスワード: issuerapipass
    • DB: issuerapidb
    • テスト用 DB: issuerapidb_test
• ibet-SmartContract の以下のコントラクトを事前にデプロイする必要があります。
  • TokenList
  • E2EMessaging

パッケージインストール

以下のコマンドで Python パッケージをインストールします。

$ poetry install --no-root --only main --all-extras

pre-commit hookのインストール

$ poetry run pre-commit install

hardhatのインストール

$ npm install

環境変数の設定

主要な環境変数は以下の通りです。

環境変数名	必須	詳細	設定例
DATABASE_URL	False	データベース URL	postgresql+psycopg://issuerapi:issuerapipass@localhost:5432/issuerapidb
TEST_DATABASE_URL	False	テスト用データベース URL	postgresql+psycopg://issuerapi:issuerapipass@localhost:5432/issuerapidb
DATABASE_SCHEMA	False	データベースのスキーマ
WEB3_HTTP_PROVIDER	False	Web3 プロバイダー	http://localhost:8545
CHAIN_ID	False	ブロックチェーンネットワーク ID	1010032
TOKEN_LIST_CONTRACT_ADDRESS	True	TokenList コントラクトアドレス	0x0000000000000000000000000000000000000000
E2E_MESSAGING_CONTRACT_ADDRESS	True	E2EMessaging コントラクトアドレス	0x0000000000000000000000000000000000000000
TZ	False	タイムゾーン	Asia/Tokyo

その他の環境変数の設定は、config.py で確認することができます。

DB マイグレーション

migrations/README.md を確認してください。

サーバーの起動

API サーバーの起動は、以下を実行します。

$ ./run.sh server (Press CTRL+C to quit)

ブラウザで、http://0.0.0.0:5000 を開くと、以下のJSONのレスポンスを確認できるはずです。

{"server":"ibet-Prime"}

API 仕様書

Swagger UI

サーバーを起動した状態で、http://0.0.0.0:5000/docs を開いてください。

Swagger UI 形式のドキュメントを参照することができるはずです。

ReDoc

同様に、http://0.0.0.0:5000/redoc を開いてください。

ReDoc 形式のドキュメントを参照することができるはずです。

ブランチ作成方針

このリポジトリは以下の図で示されるフローでバージョン管理が行われています。

License

ibet-Prime は Apache License, Version 2.0 でライセンスされています。

Contact information

私たちは、皆様のユースケースをサポートするために、オープンソースに取り組んでいます。 私たちは、あなたがこのライブラリをどのように使用し、どのような問題の解決に役立っているかを知りたいと思います。 私たちは、2つのコミュニケーション用の手段を用意しています。

• public discussion group では、ロードマップ、アップデート、イベント等を共有します。

• dev@boostry.co.jp のEメール宛に連絡をいただければ、直接私たちに連絡することができます。

機密事項の送信はご遠慮ください。過去に送信したメッセージの削除を希望される場合は、ご連絡ください。

スポンサー

BOOSTRY Co., Ltd.