SHiNE-server/Dev_Docs/00_INDEX.md

2.3 KiB
Raw Blame History

Dev_Docs — оглавление

Этот набор документов сделан по текущему состоянию кода сервера (/workspace/SHiNE-server) и разбит по темам.

Список документов

  1. 01_Connection_and_Sessions.md
    Процесс подключения к WebSocket, авторизация (двухшаговая), создание сессии, вход в существующую сессию, просмотр и закрытие сессий.

  2. 02_Blockchain_Structure_and_Block_Types.md
    Архитектура блокчейна, форматы и типы блоков, что уже можно делать каждым типом блока.

  3. 03_Addable_Blocks_Channels_Messages_Connections.md
    Какие блоки добавляются через AddBlock, как делать каналы/подписки/контакты/друзей/лайки/ответы, что уже есть и чего не хватает в API.

  4. 04_Query_Design_for_Subscriptions_Counters_and_Sync.md
    Проектирование новых API-запросов: список подписок с общим/новым числом сообщений, список сообщений канала, граф ответов для сообщения, поток синхронизации online/offline.

  5. 05_Open_Questions_and_TODO.md
    Список открытых вопросов, рисков и приоритетов для доработки сервера.

Почему так разбито

  • Сначала протокол и сессии — это входная точка клиента.
  • Потом блокчейн-слой — какие данные вообще можно выразить блоками.
  • Потом прикладные функции (каналы/сообщения/связи) — что реально можно сделать уже сейчас.
  • Потом проектирование отсутствующих запросов — чтобы закрыть разрыв между текущим сервером и нужной функциональностью клиента.
  • В конце вопросы — чтобы быстро согласовать спорные места.