Skip to content

Latest commit

 

History

History
260 lines (175 loc) · 11.5 KB

README.md

File metadata and controls

260 lines (175 loc) · 11.5 KB
Raw

Hyperledger Iroha

License Rust

Iroha is a simple and efficient blockchain ledger based on the distributed ledger technology (DLT). Its design principles are inspired by the Japanese Kaizen principle of eliminating excesses (muri).

Iroha can help you manage your accounts, assets, on-chain data storage with efficient smart contracts, while being Byzantine- and crash-fault tolerant.

Features

Iroha is a fully-featured blockchain ledger. With Iroha you can:

  • Create and manage custom fungible assets, such as currencies, gold, and others
  • Create and manage non-fungible assets
  • Manage user accounts with a domain hierarchy and multi-signature transactions
  • Use efficient portable smart contracts implemented either via WebAssembly or Iroha Special Instructions
  • Use both permissioned and permission-less blockchain deployments

Iroha offers:

  • Byzantine fault-tolerance with up to 33% fault rate
  • Efficient in-memory operations
  • Extensive telemetry support out of the box
  • Modular structure
  • Event-driven architecture with strongly-typed events

Overview

Engage with the community:

System Requirements

RAM and storage requirements depend on your use case: whether you need to build or deploy a network, how big it is, and so on. This table summarises the requirements:

Use case CPU RAM Storage1
Build (minimum) Dual-core CPU 4GB 20GB
Build (recommend) AMD Ryzen™ 5 1600 16GB 40GB
Deploy (small) Dual-core CPU 8GB+ 20GB+
Deploy (large) AMD Epyc™ 64-core 128GB 128GB+

Regarding RAM requirements:

  • On average, you need 5 KiB of RAM per account. A network with 1 000 000 accounts uses 5GiB of memory.
  • Each transfer or Mint instruction requires 1 KiB per instruction.
  • RAM usage grows linearly, as all transactions are stored in memory. You should expect to consume more RAM with a higher TPS and uptime.

CPU considerations:

  • Rust compilation highly favours multi-core CPUs such as Apple M1™, AMD Ryzen™/Threadripper™/Epyc™, and Intel Alder Lake™.
  • On systems with restricted memory and many CPU cores, Iroha compilation may sometimes fail with SIGKILL. To avoid it, restrict the number of CPU cores using cargo build -j <number>, where <number> (without the angle brackets) is half of your RAM capacity rounded down.

Build, Test, and Run Iroha

Prerequisites:

(Optional) Run included tests

Run included code tests:

cargo test

Run API functional tests:

cargo build
chmod +x target/debug/iroha
chmod +x target/debug/iroha_client_cli

bash ./scripts/test_env.sh setup
bash ./scripts/tests/register_mint_quantity.sh
bash ./scripts/test_env.sh cleanup

To generate WASM files for smart contracts, use the provided script generate_wasm.sh. If you are in the root directory of iroha run the following command:

bash ./scripts/generate_wasm.sh [path/to/smartcontracts]

The generated WASM files will be saved in a generated directory test-smartcontracts, relative to your current working directory. The default path for smart contracts in this project is client/tests/integration/smartcontracts.

Build Iroha

  • Build Iroha and accompanying binaries:

    cargo build

  • (Optional) Build the latest Iroha image:

    docker build . -t hyperledger/iroha2:dev

    If you skip this step, the Iroha container will be built using the latest available image.

Run Iroha

Once you have built Iroha, you can instantiate the minimum viable network:

docker compose up

With the docker-compose instance running, use Iroha Client CLI:

cargo run --bin iroha_client_cli -- --config ./configs/swarm/client.toml

Integration

Iroha project mainly consists of the following crates:

  • iroha is the command-line application for deploying an Iroha peer. Contains the routing table and definitions of API endpoints.
  • iroha_actor provides a message passing model for Iroha components.
  • iroha_client provides a library for building clients that communicate with peers.
  • iroha_client_cli is the reference implementation of a client.
  • iroha_config handles configuration and documentation generation for options and run-time changes.
  • iroha_core is the primary library used by all other crates, including the peer endpoint management.
  • iroha_crypto defines cryptographic aspects of Iroha.
  • kagami is used to generate cryptographic keys, default genesis, configuration reference, and schema.
  • iroha_data_model defines common data models in Iroha.
  • iroha_futures is used for async programming.
  • iroha_logger uses tracing to provide logging facilities.
  • iroha_macro provides the convenience macros.
  • iroha_p2p defines peer creation and handshake logic.
  • iroha_default_executor defines runtime validation logic.
  • iroha_telemetry is used for monitoring and analysis of telemetry data.
  • iroha_version provides message versioning for non-simultaneous system updates.

Maintenance

A brief overview on how to configure and maintain an Iroha instance:

Configuration

There is a set of configuration parameters that could be passed either through a configuration file or environment variables.

iroha --config /path/to/config.toml

Note: detailed configuration reference is work in progress.

Endpoints

For a list of all endpoints, available operations, and ways to customize them with parameters, see API Reference > Torii Endpoints

Logging

By default, Iroha provides logs in a human-readable format and prints them out to stdout.

The logging level can be changed either via the logger.level configuration parameter or at run-time using the configuration endpoint.

Example: changing log level

For example, if your Iroha instance is running at 127.0.0.1:8080 and you want to change the log level to DEBUG using curl, you should send a POST request with a JSON containing the new log level. Like this:

curl -X POST \
    -H 'content-type: application/json' \
    http://127.0.0.1:8080/configuration \
    -d '{"logger": {"level": "DEBUG"}}' -i

The log format might be configured via the logger.format configuration parameter. Possible values are: full (default), compact, pretty, and json.

Output goes to /dev/stdout. Piping to files or log rotation is the responsibility of the peer administrator.

Monitoring

The details of the Health endpoint can be found in the API Reference > Torii Endpoints.

Iroha can produce both JSON-formatted as well as prometheus-readable metrics at the status and metrics endpoints respectively.

The prometheus monitoring system is the de-factor standard for monitoring long-running services such as an Iroha peer. In order to get started, install prometheus and use configs/prometheus.template.yml for configuration.

Storage

Iroha stores blocks and snapshots in the storage directory, which is created automatically by Iroha in the working directory of the peer. If kura.block_store_path is specified in the config file, it overrides the default one and is resolved relative to the config file location.

Note: detailed configuration reference is work in progress.

Scalability

Multiple instances of Iroha peer and client binaries can be run on the same physical machine and in the same working directory. However, we recommend to give each instance a clean new working directory.

The provided docker-compose file showcases a minimum viable network and the general methods of using the hyperledger/iroha2:dev docker image for deploying a network of peers.

Further Reading

We encourage you to check out our Iroha 2 Tutorial first. It is suitable for both experienced developers and prospective users of Iroha 2, and it provides language-specific guides for Bash, Python, Rust, Kotlin/Java, and Javascript/TypeScript.

Iroha SDKs:

How to Contribute

We welcome community contributions! Report bugs and suggest improvements via GitHub issues and pull requests.

Check out our contributing guide to learn more.

Get Help

Check out the channels you could use to get help or engage with the community.

License

Iroha codebase is 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.

Iroha documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/

Footnotes

  1. Note that all operations are done in RAM, so in theory Iroha can work without persistent storage. However, since synchronising blocks over the network after a power failure may take a long time, we recommend adding a hard drive. ↩