ibet-Prime

English | 日本語

The ibet-Prime security token management system for ibet network.

Features

• ibet-Prime is an API service that enables the issuance and management of security tokens on the ibet network.
• It supports tokens and various smart contracts developed by the ibet-SmartContract project.
• As a security token ledger management system, ibet-Prime provides a variety of functions required under Japanese regulations.
• By integrating the ibet-Prime API into your front-end application, you can easily build a security token management service.

Dependencies

• Python3 - version 3.13
• PostgreSQL - version 17
• GoQuorum
  • We support the official GoQuorum node of ibet-Network.
  • We use Anvil for local development and unit testing.

Supported ibet smart contract version

• ibet-SmartContract: Supports the latest version of contract specifications.
• See details.

Setup

Prerequisites

• A Python runtime environment must be set up.
• The database must be created on PostgreSQL beforehand.
  • By default, the following settings are required:
    • User: issuerapi
    • Password: issuerapipass
    • Database: issuerapidb
    • Test database: issuerapidb_test
• An ibet node must be available and connected.
  • The TokenList and E2EMessaging contracts from the ibet-SmartContract project must be deployed in advance.
• An Ethereum node is optional, but can be set up and connected.
• An Avalanche node is optional, but can be set up and connected.

Install packages

Create virtual environment with:

$ uv venv

Install python packages with:

$ uv sync --frozen --no-install-project --no-dev --all-extras

Setting environment variables

See docs/environment_variables.md for the list of environment variables. Set the required variables according to each use case.

DB migrations

See migrations/README.md.

Development Information

Install pre-commit hook

We provide a pre-commit hook to check code quality before commits.

$ uv run pre-commit install

Setting environment variables

You can create a .env file to define local environment variables.

Running tests

For test container startup, see docker-compose.yml. When running individual test cases, set up a local Python runtime environment and configure the required environment variables first.

Starting the Server

You can start the API server with:

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

Open your browser at http://0.0.0.0:5000.

You will see the JSON response as:

{"server":"ibet-Prime"}

API docs

Now go to http://0.0.0.0:5000/docs.

You will see the automatic interactive API documentation provided by Swagger UI:

And now, go to http://0.0.0.0:5000/redoc. You will see the alternative automatic documentation provided by ReDoc.

Branching model

This repository is version controlled using the following flow.

License

ibet-Prime is licensed under the Apache License, Version 2.0.

Contact information

We are committed to open-sourcing our work to support your use cases. We want to know how you use this library and what problems it helps you to solve. We have two communication channels for you to contact us:

• A public discussion group where we will also share our preliminary roadmap, updates, events, and more.

• A private email alias at dev@boostry.co.jp where you can reach out to us directly about your use cases and what more we can do to help and improve the library.

Please refrain from sending any sensitive or confidential information. If you wish to delete a message you've previously sent, please contact us.

Sponsors

BOOSTRY Co., Ltd.