thinkingfrog / zk-kyc

Bachelor's thesis work on implementing ZKP for KYC systems

ZK-KYC

Бакалаврская дипломная работа по применению Zero Knowledge Proofs (ZKP) для Know Your Customer (KYC) систем и аналогичных им

Запуск

Сервисы запускаются из директории services и все дальнейшие команды запускаются из неё

Сервисы поднимаются с помощью docker compose: docker compose up -d. Для остановки сервисов используется docker compose down

Для того, чтобы принудительно пересобрать все образы, можно использовать флаг --build:

docker compose up -d --build

Его стоит использовать, если исходный код сервисов был изменен

Для отправки KYC запроса используется веб интерфейс, который автоматически поднимается из сервиса user и располагается по адресу localhost:5000

Сборка

Все сервисы собираются и поднимаются через docker compose файл services/compose.yaml. Конфигурационные файлы сервисов расположены в директории services/config, название каждого файла соответствует названию сервиса

NOTE: Конфигурационные файлы передаются в контейнеры сервисов через bind, но сервисы не поддерживают изменение конфигов во время работы. Чтобы применить новый конфиг, нужно перезапустить контейнер сервиса

Чтобы собрать и скопировать в нужные пути библиотеку бэкэнда с ZK, можно использовать скрипт services/lib/build_lib.sh. Его нужно использовать перед тем, как запускать контейнеры в докере

Описание

Более детальное описание концепта и реализации доступно здесь