Hyperledger Iroha

Iroha — это простой и эффективный блокчейн-реестр, основанный на технологии распределённого реестра (DLT). Его принципы проектирования вдохновлены японским принципом Кайдзен, который заключается в устранении излишков (muri).

Iroha может помочь вам управлять своими учётными записями, активами, хранением данных в цепочке с помощью эффективных смарт-контрактов, при этом обеспечивая устойчивость к византийским ошибкам и сбоям.

Функции

Iroha представляет собой полнофункциональный блокчейн-реестр. С Iroha вы можете:

• Создавать и управлять пользовательскими взаимозаменяемыми активами, такими как валюты, золото и другие.
• Создавать и управлять невзаимозаменяемыми активами.
• Управлять учётными записями пользователей с иерархией доменов и транзакциями с несколькими подписями.
• Использовать эффективные портативные смарт-контракты, реализованные через WebAssembly или специальные инструкции Iroha.
• Использовать как разрешённые, так и неразрешённые развёртывания блокчейна.

Iroha предлагает:

• Устойчивость к византийским сбоям с частотой отказов до 33%.
• Эффективные операции в памяти.
• Обширную поддержку телеметрии «из коробки».
• Модульную структуру.
• Архитектура, управляемая событиями, со строго типизированными событиями.

Обзор

• Ознакомьтесь с системными требованиями и инструкциями о том, как создать и запустить Iroha.
• Узнайте о комплектах, предоставляемых Iroha.
• Изучите, как настроить и использовать Iroha.
• Читайте больше об Iroha.

Общайтесь с сообществом:

• Вносите свой вклад в репозиторий.
• Свяжитесь с нами, чтобы получить помощь.

Системные требования

Требования к оперативной памяти и хранилищу зависят от вашего варианта использования: нужно ли вам создать или развернуть сеть, насколько она велика и т. д. В этой таблице приведены требования:

[^1]: Обратите внимание, что все операции выполняются в оперативной памяти, поэтому теоретически Iroha может работать без постоянного хранилища. Однако, поскольку синхронизация блоков по сети после сбоя питания может занять много времени, мы рекомендуем добавить жёсткий диск.

Что касается требований к оперативной памяти:

• В среднем вам требуется 5 КБ оперативной памяти на учётную запись. Сеть с 1 000 000 учётных записей использует 5 ГиБ памяти.
• Каждая передача или инструкция Mint требует 1 КБ на инструкцию.
• Использование оперативной памяти растёт линейно, поскольку все транзакции хранятся в памяти. Вы должны ожидать, что будете потреблять больше оперативной памяти при более высокой TPS и времени безотказной работы.

Соображения по поводу процессора:

• Компиляция Rust сильно благоприятствует многоядерным процессорам, таким как Apple M1™, AMD Ryzen™/Threadripper™/Epyc™, и Intel Alder Lake™.
• На системах с ограниченной памятью и большим количеством ядер ЦП компиляция Iroha иногда может завершаться неудачно с SIGKILL. Чтобы этого избежать, ограничьте количество ядер ЦП с помощью cargo build -j <число>, где <число> (без угловых скобок) составляет половину вашей ёмкости ОЗУ, округлённую вниз.

Создание, тестирование и запуск Iroha

Предварительные условия:

• Rust.
• (Необязательно) Docker.
• (Необязательно) Docker Compose.

Создайте Iroha

• Создайте Iroha и сопутствующие двоичные файлы:

  cargo build

• (Необязательно) Создайте последний образ Iroha:

  docker build . -t hyperledger/iroha2:dev

  Если вы пропустите этот шаг, контейнер Iroha будет создан с использованием последнего доступного образа.

Запустите Iroha

После создания Iroha можно создать минимально жизнеспособную сеть:

docker compose up

Когда экземпляр docker-compose запущен, используйте клиентский интерфейс командной строки Iroha:

cargo run --bin iroha -- --config ./defaults/client.toml

Интеграция

Проект Iroha в основном состоит из следующих комплектов:

• iroha предоставляет... kura.block_store_path задаётся в конфигурационном файле, он переопределяет значение по умолчанию и разрешается относительно расположения конфигурационного файла.

Примечание: подробная справочная информация о конфигурации находится в разработке (https://github.com/hyperledger-iroha/iroha-2-docs/issues/392).

Масштабируемость

На одной физической машине и в одном рабочем каталоге можно запустить несколько экземпляров одноранговых узлов и клиентских двоичных файлов Iroha. Однако мы рекомендуем предоставить каждому экземпляру чистый новый рабочий каталог.

Приведённый файл docker-compose демонстрирует минимально жизнеспособную сеть и общие методы использования образа докера hyperledger/iroha2:dev для развёртывания сети равноправных узлов.

Дальнейшее чтение

Мы рекомендуем сначала ознакомиться с нашим руководством по Iroha 2. Оно подходит как для опытных разработчиков, так и для потенциальных пользователей Iroha 2 и предоставляет руководства для конкретных языков для Bash, Python, Rust, Kotlin/Java и Javascript/TypeScript.

• Документация Iroha 2 (https://docs.iroha.tech)
  • Глоссарий (https://docs.iroha.tech/reference/glossary.html)
  • Специальные инструкции Iroha (https://docs.iroha.tech/blockchain/instructions.html)
  • Справочник по API (https://docs.iroha.tech/reference/torii-endpoints.html)

• Технический документ Iroha 2 (./docs/source/iroha_2_whitepaper.md)

SDK Iroha:

• Iroha Python (https://github.com/hyperledger-iroha/iroha-python)
• Iroha Java (https://github.com/hyperledger-iroha/iroha-java)
• Iroha Javascript (https://github.com/hyperledger-iroha/iroha-javascript)
• Iroha iOS Swift (https://github.com/hyperledger-iroha/iroha-ios)

Как внести свой вклад

Мы приветствуем вклад сообщества! Сообщайте об ошибках и предлагайте улучшения через проблемы GitHub и запросы на вытягивание.

Ознакомьтесь с нашим руководством по внесению вклада (CONTRIBUTING.md), чтобы узнать больше.

Получить помощь

Проверьте каналы, которые вы могли бы использовать, чтобы получить помощь или взаимодействовать с сообществом (CONTRIBUTING.md#contact).

Лицензия

Исходный код Iroha лицензирован под лицензией Apache, версия 2.0 («Лицензия»); вы не можете использовать этот файл, кроме как в соответствии с Лицензией. Вы можете получить копию Лицензии по адресу http://www.apache.org/licenses/LICENSE-2.0

Если это не требуется применимым законодательством или не согласовано в письменной форме, программное обеспечение, распространяемое по лицензии, распространяется на условиях «КАК ЕСТЬ», БЕЗ ГАРАНТИЙ ИЛИ УСЛОВИЙ ЛЮБОГО РОДА, явных или подразумеваемых. См. Лицензию для конкретного языка, регулирующего разрешения и ограничения в рамках Лицензии.

Файлы документации Iroha предоставляются по лицензии Creative Commons Attribution 4.0 International License (CC-BY-4.0), доступной по адресу http://creativecommons.org/licenses/by/4.0/.