| .. | ||
| 00_Blockchain_Formats_and_Block_Types.md | ||
| 01_Channel_Types_and_CreateChannel.md | ||
| 01_Common_Block_Format.md | ||
| 02_Blockchain_Kinds_and_Lines.md | ||
| 02_Channel_Commands.md | ||
| 10_TECH_Blocks.md | ||
| 11_TEXT_Blocks.md | ||
| 12_REACTION_Blocks.md | ||
| 13_CONNECTION_Blocks.md | ||
| 14_USER_PARAM_Blocks.md | ||
| CHANGELOG.md | ||
| README.md | ||
| sync-between-servers.md | ||
Документация блокчейна SHiNE (MVP)
Этот каталог описывает только текущий рабочий формат протокола для MVP.
Основные документы
- 01_Common_Block_Format.md
Единый бинарный формат блока (Frame v0), подпись, базовые проверки. - 02_Blockchain_Kinds_and_Lines.md
Виды цепочек и правила line-полей. - 10_TECH_Blocks.md
Системные блоки (msg_type=0). - 11_TEXT_Blocks.md
Текстовые блоки (msg_type=1). - 12_REACTION_Blocks.md
Реакции (msg_type=2). - 13_CONNECTION_Blocks.md
Социальные связи (msg_type=3). - 14_USER_PARAM_Blocks.md
Параметры пользователя (msg_type=4). - 01_Channel_Types_and_CreateChannel.md
Типы каналов и форматCreateChannelBody. - 02_Channel_Commands.md
Команды в текстовых сообщениях каналов. - 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с датой/временем и хэшем коммита-основания.