@hlf-explorer/common NPM

Библиотека предназначена для взаимодействия с системой реестра через API и WebSocket. Она предоставляет API-клиент и WebSocket-клиент для работы с данными в блокчейне, включая блоки, транзакции и события.

Назначение

Основная цель библиотеки — облегчить взаимодействие с данным в блокчейне, обеспечивая доступ к различным сущностям, таким как блоки и транзакции, а также реализовать возможность подписки на события реестра для получения обновлений в реальном времени.

Функциональность

API-клиент (LedgerApiClient):
- Отправка запросов на сервер для выполнения операций с реестром (ledger).
- Получение информации о конкретном блоке, транзакции или событии.
- Поиск сущностей блокчейна по заданным критериям.
- Сброс данных реестра с проверкой пароля.
WebSocket-клиент (LedgerApiSocket):
- Реализация подключения к серверу через WebSocket для получения событий в реальном времени.
- Подписка на различные события, такие как обновление реестра, обработка блоков и получение списка реестров.
- Управление событиями и их обработка с поддержкой фильтрации по дефолтному реестру.

Архитектура

Классы и интерфейсы: Построены вокруг сущностей блокчейна, включая LedgerBlock, LedgerBlockTransaction, LedgerBlockEvent и LedgerInfo. Они представляют собой модели данных и определяют структуру данных, возвращаемых из API.
Клиенты: LedgerApiClient и LedgerApiSocket управляют взаимодействием с сервером на уровне API и WebSocket соответственно, обеспечивая интерфейсы для различных операций и событий.
Расширенные ошибки и логирование: Используемые библиотеки позволяют эффективно управлять ошибками и логированием, что улучшает отслеживаемость и управление ошибками.

Библиотека подходит для приложений, которым необходимо взаимодействовать с блокчейн-системами, предоставляя простой интерфейс для управления данными и получения обновлений в реальном времени. Разработчики могут использовать клиентскую часть API для интеграции блокчейн-функционала в свои проекты, используя знакомые инструменты и практики.