Актуализировать документацию и навигацию для агентов

This commit is contained in:
AidarKC
2026-11-05 22:50:31 +03:00
parent 3c6021a290
commit 4f8c2a72e9
31 changed files with 315 additions and 927 deletions
+37
View File
@@ -0,0 +1,37 @@
# Архитектура SHiNE
Этот документ даёт общую карту продукта. Точные форматы, операции и инструкции находятся по ссылкам ниже. Состояние отдельных функций может отличаться между тестовым и production контурами; для изменения протокола сверяйтесь с кодом и профильной спецификацией.
```mermaid
flowchart LR
UI[Браузерный UI] -->|HTTP / WebSocket| Server[Сервер SHiNE]
Wallet[Расширение кошелька] -->|Сессия и подписи| Server
ESP[ESP32 прототипы] -.->|Сценарии устройства| Server
Server --> DB[(PostgreSQL)]
Server <-->|Публикация и импорт блоков| Arweave[(Arweave)]
UI -->|PDA и транзакции| Solana[(Solana)]
Server -->|Чтение PDA / синхронизация| Solana
```
## Компоненты и границы
| Компонент | За что отвечает | Где смотреть детали |
| --- | --- | --- |
| `shine-UI/` | Браузерные экраны, локальное состояние, взаимодействие с сервером | `shine-UI/AGENTS.md`, `docs/UI-Design/README.md` |
| `SHiNE-server/` | HTTP/WS запросы, валидация, доставка сообщений и звонков, хранение | `SHiNE-server/AGENTS.md`, `docs/API/09_Operations_Index.md` |
| PostgreSQL | Локальные данные сервера и пользовательские блоки | `SHiNE-server/shine-server-db/`, `docs/Blockchain/README.md` |
| Arweave | Внешняя публикация и импорт подписанных пользовательских блоков | `docs/Blockchain/17_ANS104_Arweave_Transport.md` |
| Solana | Пользовательские PDA, регистрация и платёжные программы | `docs/Solana_Architecture/README.md`, `docs/Инициализация_Solana_регистрации/README.md` |
| `SHiNE-browser-plugin-wallet/` | Вход через сессию кошелька в браузере | `SHiNE-browser-plugin-wallet/README.md` |
| `ESP32/` | Прототипы устройств и прошивки | `ESP32/AGENTS.md` |
## Основные потоки
1. **Регистрация и подключение.** Клиент взаимодействует с Solana PDA и сервером; серверный адрес публикуется в PDA серверного аккаунта. Детали регистрации и её текущий статус: `docs/Инициализация_Solana_регистрации/README.md`, `docs/registration-v2/README.md`.
2. **Пользовательские блоки.** Клиент создаёт подписанный ANS-104 DataItem с SHiNE Frame v1. Сервер проверяет его при `AddBlock`, хранит локально в PostgreSQL и, в зависимости от режима публикации, передаёт в Arweave. Другие серверы могут импортировать опубликованные блоки. Точный формат и ограничения: `docs/Blockchain/README.md`.
3. **Личные сообщения.** Клиент формирует зашифрованное сообщение; сервер обслуживает доставку и локальное хранение, не получая ключ содержимого. Точные правила, формат и доставка: `docs/Personal_Messages/README.md`.
4. **Деплой.** Сборка основного сервера управляется корневым Gradle-проектом; эксплуатационные сценарии и отдельный Solana-модуль документированы раздельно: `deploy/README.md`, `shine-solana/shine/AGENTS.md`.
## Ограничения этой карты
Схема показывает связи компонентов, но не обещает доступность каждой функции на каждом контуре. Документы с названиями `TODO`, `Черновик`, `PROPOSED` и исторические отчёты не описывают действующий контракт. Если карта расходится с профильной спецификацией или кодом, расхождение нужно проверить и исправить по [правилам сопровождения](CONTRIBUTING_DOCS.md).