SHA256
34 lines
2.2 KiB
Markdown
34 lines
2.2 KiB
Markdown
# Документация блокчейна SHiNE (MVP)
|
|
|
|
Этот каталог описывает только текущий рабочий формат протокола для MVP.
|
|
|
|
## Основные документы
|
|
1. [01_Common_Block_Format.md](./01_Common_Block_Format.md)
|
|
Единый бинарный формат блока (Frame v0), подпись, базовые проверки.
|
|
2. [02_Blockchain_Kinds_and_Lines.md](./02_Blockchain_Kinds_and_Lines.md)
|
|
Виды цепочек и правила line-полей.
|
|
3. [10_TECH_Blocks.md](./10_TECH_Blocks.md)
|
|
Системные блоки (`msg_type=0`).
|
|
4. [11_TEXT_Blocks.md](./11_TEXT_Blocks.md)
|
|
Текстовые блоки (`msg_type=1`).
|
|
5. [12_REACTION_Blocks.md](./12_REACTION_Blocks.md)
|
|
Реакции (`msg_type=2`).
|
|
6. [13_CONNECTION_Blocks.md](./13_CONNECTION_Blocks.md)
|
|
Социальные связи (`msg_type=3`).
|
|
7. [14_USER_PARAM_Blocks.md](./14_USER_PARAM_Blocks.md)
|
|
Параметры пользователя (`msg_type=4`).
|
|
8. [01_Channel_Types_and_CreateChannel.md](./01_Channel_Types_and_CreateChannel.md)
|
|
Типы каналов и формат `CreateChannelBody`.
|
|
9. [02_Channel_Commands.md](./02_Channel_Commands.md)
|
|
Команды в текстовых сообщениях каналов.
|
|
10. [CHANGELOG.md](./CHANGELOG.md)
|
|
Журнал изменений документации.
|
|
|
|
## Важные ограничения MVP
|
|
- Каналы `type=100` и `type=200` присутствуют в формате, но сейчас не используются в UI.
|
|
- Поддерживаемый рабочий сценарий UI на текущем этапе: `stories (type=0)` и `public (type=1)`.
|
|
|
|
## Обязательное сопровождение
|
|
- При любом изменении формата/правил блокчейна в коде документы этого каталога обновляются в том же наборе изменений.
|
|
- Каждое обновление документов фиксируется в `CHANGELOG.md` с датой/временем и хэшем коммита-основания.
|