Техническая документация смарт-контракта с примерами интеграции
Промпт готовит структурированную документацию по смарт-контракту: описывает архитектуру, интерфейсы, безопасность, развёртывание, тесты и примеры вызовов для команды разработки.
Подготовь полный технический документ по смарт-контракту для команды [НАЗВАНИЕ КОМПАНИИ]. Используй входные данные: - [НАЗВАНИЕ КОМПАНИИ] - [ФУНКЦИИ КОНТРАКТА] - [СТАНДАРТЫ КОДА] - [ТЕХНИЧЕСКИЕ ЗАВИСИМОСТИ] - [ОБРАТНАЯ СВЯЗЬ СТЕЙКХОЛДЕРОВ] - [УТИЛИТА ТОКЕНА] Если части данных отсутствуют, явно вставляй заметку «Требуется ввод: [название поля]» и кратко поясняй, какие сведения нужны. Не выдумывай функциональные требования и не задавай вопросов. Верни документ строго в следующем порядке: 1. Титульный блок 2. Краткое резюме 3. Обзор архитектуры и основных компонентов 4. Подробное описание функций и интерфейсов 5. Переменные состояния и invariants 6. Правила доступа и безопасность 7. Технические предпосылки и зависимости 8. Инструкции по развёртыванию и миграциям 9. Примеры интеграции и взаимодействия 10. Тестирование и валидация 11. Рекомендации по оптимизации газа и производительности 12. Управление выпуском и сопровождение 13. Описание утилиты токена 14. Feedback от стейкхолдеров и учтённые изменения 15. Наиболее слабая предпосылка в документации 16. Реалистичный сценарий непонимания документации 17. Приложения Обязательные требования: - язык русский; - стиль технический, без неструктурированных размышлений; - в разделе 4 для каждой функции укажи сигнатуру, входы, выходы, модификаторы, эффекты на состояние, события, возможные ошибки и ориентировочную оценку газа; - в разделе 6 перечисли уязвимости и конкретные проверки перед релизом; - в разделе 8 приведи команды и примеры для локальной разработки, тестнета и mainnet; - в разделе 9 включи минимум 3 практических сценария с примерами read и write вызовов через ethers.js или web3.js, обработкой ошибок и ожиданием подтверждений; - в разделе 9 также добавь пример unit-теста на Hardhat + ethers.js или mocha; - в разделе 10 опиши unit, integration, property или fuzz tests и целевые метрики покрытия; - в разделе 15 назови ровно одно слабое предположение и план его проверки; - в конце документа дай 1-2 строки о том, каких данных не хватает для полной точности, если такие пробелы есть. Ограничения: - не добавляй требования, которых нет в [ФУНКЦИИ КОНТРАКТА] и [ОБРАТНАЯ СВЯЗЬ СТЕЙКХОЛДЕРОВ]; - примеры кода делай короткими и готовыми для вставки; - не давай лишних пояснений о работе модели.
ChatGPT, Claude, GigaChat, Алиса ИИ, По нейросетям, Типы промптов, Яндекс GPT