Перейти к содержанию

docs/ — старт здесь

Единая точка входа в документацию OneWallet — e-money кошелька (Таиланд, регулятор Bank of Thailand, валюта THB). Найдите свою роль ниже или используйте таблицу «Вопрос → Файл».

На какие вопросы отвечает

  • Я новый сотрудник — с чего начать читать?
  • Что такое OneWallet и какие у него приложения и роли?
  • Где описана архитектура сервисов, схемы БД, платёжный поток и ledger?
  • Почему приняли то или иное техническое решение (TigerBeetle, HMAC, разделение схем)?
  • Что показать регулятору (BOT) и аудиторам по комплаенсу?
  • Где лежит детальная документация по конкретному проекту (PM, Auth Center, admin-panel, blog, приложения)?

Навигация по ролям

graph TD
  Start["docs/README.md<br/>старт здесь"]
  Start --> PO["Product / Operations"]
  Start --> Dev["Разработка"]
  Start --> Comp["Комплаенс"]
  PO --> B["business/"]
  Dev --> D["dev/"]
  Dev --> A["adr/"]
  Comp --> C["compliance/"]
  B -.детали.-> PP["projects/*/docs/business/"]
  D -.детали.-> PD["projects/*/docs/dev/"]
Роль С чего начать Что найдёте
Product / Operations business/01-what-is-onewallet.md продукт, роли/счета, приложения, сценарии, лимиты/тарифы, статус
Разработка dev/01-overview.md + adr/0001-tigerbeetle-ledger.md сервисы, схемы БД, платежи и ledger, безопасность, деплой, решения (ADR)
Комплаенс compliance/bot-qa.md ответы для BOT, вопросы аудитора, таймлайн, карта сервисов

Вопрос → Файл

Вопрос Файл
Что такое OneWallet, кто пользователи? business/01-what-is-onewallet.md, business/02-actors-and-accounts.md
Какие есть приложения (consumer, merchant, admin)? business/03-apps.md
Как выглядят пользовательские сценарии (P2P, QR, NFC, invoice)? business/04-scenarios.md
Лимиты, комиссии, fee-rules? business/05-limits-and-fees.md
Что уже сделано, что в планах? business/06-roadmap-and-status.md
Обзор архитектуры и сервисов? dev/01-overview.md, dev/02-services.md
Схемы БД (public/pm/blog), кросс-схемные views? dev/03-data-and-schemas.md, adr/0003-schema-separation.md
Платёжный поток, intent, TigerBeetle? dev/04-payments-and-ledger.md, adr/0001-tigerbeetle-ledger.md, adr/0004-single-intent-api.md
HMAC, PIN/биометрия, step-up auth? dev/05-security-and-auth.md, adr/0002-single-hmac-auth.md
KYC, хранилище (Garage/S3), PII-шифрование? dev/06-storage-and-kyc.md, adr/0005-pii-encryption.md
Деплой, docker-compose, порты, профили? dev/07-deployment.md
Какие приложения и appId? adr/0006-clients-and-appid.md, business/03-apps.md
Ответы для BOT / аудитора? compliance/bot-qa.md, compliance/accountant-questions.md
История изменений, карта сервисов? compliance/TIMELINE.md, compliance/service-map.md
Детали конкретного проекта? projects/payment-manager/docs/, projects/onewallet_base/docs/, projects/admin-panel/docs/, projects/one_blog/, projects/one_merchant_app/docs/, projects/one_loop_app/docs/

Карта структуры docs/

docs/
├── README.md           ← вы здесь
├── business/           продукт, роли, приложения, сценарии, лимиты, статус
├── dev/                архитектура, сервисы, БД, платежи, безопасность, деплой
├── adr/                ключевые архитектурные решения (0001…0006)
├── compliance/         BOT Q&A, аудит, таймлайн, карты сервисов
└── archive/            старые монолитные доки (для справки, НЕ актуальны)

Детальная документация по сервисам живёт рядом с кодом: projects/<service>/docs/.

Пример: как читать по задаче

Нужно понять, как проходит P2P-перевод между пользователями:

  1. Бизнес-уровень — business/04-scenarios.md (сценарий P2P).
  2. Технический поток — dev/04-payments-and-ledger.md: запрос POST /intents с operationType=P2P_TRANSFER, канал INTERNAL_P2P (имя канала в коде, src/channels/internal-p2p.ts) проходит state machine CREATED → SETTLED синхронно в одном запросе (для внешних PSP-каналов финал асинхронный через Redis pub/sub intent.{id}).
  3. Почему так устроен ledger — adr/0001-tigerbeetle-ledger.md (инвариант transit.balance = 0, two-phase pending/post, trace_id = intent_id).

Контракты и идентификаторы (DTO, HMAC, endpoints) — канонический источник: PASSPORT.md. Сверяйтесь с ним перед изменением контрактов PM.