Files
SHiNE-server/docs/Blockchain
..

Документация блокчейна SHiNE (MVP)

Этот каталог описывает только текущий рабочий формат протокола для MVP.

Основные документы

  1. 01_Common_Block_Format.md Единый бинарный формат блока (Frame v0), подпись, базовые проверки.
  2. 02_Blockchain_Kinds_and_Lines.md Виды цепочек и правила line-полей.
  3. 10_TECH_Blocks.md Системные блоки (msg_type=0).
  4. 11_TEXT_Blocks.md Текстовые блоки (msg_type=1).
  5. 12_REACTION_Blocks.md Реакции (msg_type=2).
  6. 13_CONNECTION_Blocks.md Социальные связи (msg_type=3).
  7. 14_USER_PARAM_Blocks.md Параметры пользователя (msg_type=4).
  8. 15_TEXT_Attachments.md Вложения в TEXT-сообщениях через SHiNE:attach v=1.
  9. 16_TEXT_Channel_Meta.md Скрытый TEXT_CHANNEL_META для профиля канала.
  10. 01_Channel_Types_and_CreateChannel.md Типы каналов и формат CreateChannelBody.
  11. 02_Channel_Commands.md Команды в текстовых сообщениях каналов.
  12. CHANGELOG.md Журнал изменений документации.

Смежная документация

Важные ограничения MVP

  • Каналы type=100 и type=200 присутствуют в формате, но сейчас не используются в UI.
  • Поддерживаемый рабочий сценарий UI на текущем этапе: stories (type=0) и public (type=1).

Обязательное сопровождение

  • При любом изменении формата/правил блокчейна в коде документы этого каталога обновляются в том же наборе изменений.
  • Обычный AddBlock сейчас пишет через <blockchainName>.tmp_bch, <blockchainName>.write_check и <blockchainName>.write_pending; эта схема и BlockchainTmpRecoveryOnStartup должны быть описаны в актуальной документации по синхронизации и recovery.
  • Каждое обновление документов фиксируется в CHANGELOG.md с датой/временем и хэшем коммита-основания.