Разработка смарт-контрактов с персональным ответственным

Конфиденциальный порядок работы над решениями по контракту

Разработка смарт-контрактов начинается с составленного конфиденциального описания того, что должен делать продукт. Ваш персональный ответственный координирует обсуждение и держит правила продукта, технические материалы и открытые решения в рамках рабочей группы, которую вы утверждаете.

До начала реализации мы готовим черновую спецификацию, охватывающую предполагаемое поведение контракта, роли и известные зависимости. Ничто не продвигается дальше этого черновика, пока ваша команда не получила возможность его изучить и предоставить письменное подтверждение. Это позволяет держать нерешенные вопросы на виду, а не допускать, чтобы предположения превращались в код.

Вы решаете, кто участвует в ревью, включая ответственных за продукт, инженеров и любого внешнего аудитора, уже вовлеченного в проект. Существующий код и архитектурные заметки рассматриваются как материалы проекта, а не как публичный контент. Если работа затрагивает правила токенов, ответственный может согласовать требования к контракту с созданием и развертыванием токенов.

Полезный первый пакет содержит путь пользователя, целевую сеть, текущие технические материалы и имена людей, уполномоченных утверждать поведение. Если некоторые детали остаются открытыми, они фиксируются как решения для ревью, а не как установленные требования.

Логика контракта, построенная вокруг утвержденных правил продукта

Объем контракта описывает действия, которые код должен обеспечивать, и условия, при которых каждое действие разрешено. Мы сопоставляем эти правила с ролями пользователей и администраторов до выбора функций и интерфейсов, необходимых для разработки.

Для вестинга спецификация может фиксировать распределения, график, поведение при запросе средств и обработку невостребованных сумм. Для стейкинга она может определять депозиты, выводы, расчет вознаграждений, периоды блокировки, поддерживаемые активы и административные разрешения. Эти решения также влияют на то, как связанное приложение представляет состояния контракта пользователям.

Ревью различает фиксированные параметры и значения, которые могут быть изменены позже, и называет роль, уполномоченную вносить любые одобренные изменения. Мы также фиксируем нормальное поведение, граничные случаи и ожидаемые ответы об ошибках на языке, который ваш руководитель продукта может подтвердить. Это дает инженерам и коллегам по продукту общий справочник до начала реализации.

Когда поведение контракта является частью более широкого пользовательского опыта, координируйте интерфейсы с разработкой dApp. Эмиссия токенов, разрешения или правила распределения могут быть согласованы со спецификацией контракта, в то время как поведение приложения остается четко определенной зависимостью.

Точки ревью и материалы, которые получает ваша команда

Передача предназначена для того, чтобы сделать и согласованное поведение, и оставшиеся решения понятными. До начала работы ваш персональный ответственный подтверждает, какие материалы включены и кто будет утверждать каждую точку ревью.

В зависимости от согласованного объема материалы могут включать исходный код, заметки по реализации, автоматические тесты, результаты тестов и инструкции по развертыванию. Мы можем подготовить технические материалы для независимого аудита и координировать ответы на его результаты. Координация аудита остается отличной от проведения независимого аудита безопасности.

Если требуется специальный интерфейс для подписания, оцените эту работу вместе с разработкой криптокошельков. Письменная передача должна четко указывать, какие функции покрываются предоставленными тестами, какие настройки требуют подтверждения и какие пункты остаются для внешнего ревью.

Что должно быть решено до выпуска контракта?

План выпуска должен определять сеть, настройки развертывания, ответственные аккаунты и людей, уполномоченных подписывать каждую транзакцию. Эти детали должны быть в ревью до подготовки к развертыванию, а не в неформальном обмене в последний момент.

Ваша команда подтверждает целевую среду, значения конструктора, адреса ролей, шаги верификации и любую процедуру восстановления при ошибках конфигурации. Мы фиксируем предварительные условия развертывания и открытые решения в передаче, чтобы человек, ответственный за выпуск, видел, что ему остается подтвердить.

Тестовый набор отражает только те случаи, которые он покрывает, а результаты независимого аудитора отражают код и границы ревью; поведение сети и сторонние интеграции остаются вне нашего контроля. Мы берем на себя обязательства по согласованной разработке и согласованной передаче, а не по конкретному заключению аудита или отсутствию любых возможных дефектов.

Сохраняйте эту границу четкой при принятии решения о готовности выпуска. Назначенный ответственный за развертывание должен иметь возможность проследить каждую настройку до утверждения и знать, какие внешние зависимости не являются частью кода контракта.

Порядок работы в три этапа ревью

Сдача работ проходит от конфиденциального обсуждения требований к рассмотренной спецификации, затем к реализации и передаче. Два формальных утверждения удерживают работу: одно для поведения контракта и одно для настроек выпуска.

1. Контекст и спецификация: Ваш ответственный собирает целевую сеть, сценарии использования, текущий код и лиц, принимающих решения. Мы готовим черновик, описывающий функции, разрешения, граничные случаи и критерии приемки для письменного утверждения вашей командой.
2. Реализация и результаты: Инженерия следует утвержденной спецификации и тестирует согласованное поведение. Результаты, зависимости и нерешенные вопросы представляются соответствующему руководителю продукта или техническому руководителю для ревью.
3. Передача и координация: Мы предоставляем согласованный код и вспомогательные материалы, затем проверяем предварительные условия развертывания с назначенным ответственным. Если координация аудита включена, подача и ответы обрабатываются как отдельная ветка ревью.

График подтверждается после того, как понятны требования, интеграции и циклы ревью. Сфокусированный контракт с установленными правилами имеет другой план сдачи, чем несколько связанных компонентов с нерешенными вопросами. Ваш ответственный держит последовательность на виду и фиксирует, что ожидает утверждения на каждом этапе.

Работа над контрактом в рамках более широкого Web3-продукта

Включайте смежную работу над продуктом в обсуждение, когда она меняет входные данные контракта, действия пользователей или обязанности по выпуску. Контракт может быть ограничен как отдельный компонент, сохраняя четкие интерфейсы с остальной частью продукта.

Дизайн токенов должен быть в том же планировании, когда эмиссия, разрешения или распределение влияют на ончейн-поведение. Рабочий поток dApp актуален, когда пользователям нужно подключать кошелек, отправлять транзакции или понимать состояния контракта. Для более широкого инженерного контекста см. Web3-разработка.

Рабочая запись называет каждый компонент, его интерфейс и его утверждающего. Это дает команде контракта ответственность за согласованное ончейн-поведение, в то время как коллеги по приложению отвечают за то, как пользователи достигают этого поведения и получают обратную связь о транзакциях. Общие решения имеют видимого ответственного, а не находятся между командами.

Первый результат — краткая спецификация контракта, показанная до реализации; сроки подтверждаются после того, как понятны зависимости и утверждения. Короткая заметка с указанием целевой сети и первого решения, ожидающего подписи, дает вашему персональному ответственному конфиденциальную отправную точку.

Как мы работаем

1. Определите контекст продуктаПоделитесь сценариями использования, целевой сетью, существующим кодом и людьми, уполномоченными подтверждать правила продукта.
2. Утвердите спецификацию контрактаИзучите задокументированные функции, роли, граничные случаи, интеграции и критерии приемки до начала реализации.
3. Реализуйте и протестируйте согласованное поведениеИнженерия следует утвержденной спецификации и фиксирует результаты для ревью продукта и инженерии.
4. Подтвердите обязанности по выпускуНазначенный ответственный проверяет настройки, предварительные условия развертывания и любые оставшиеся внешние ревью.
5. Получите передачуМы предоставляем согласованный код и вспомогательные материалы, с координацией аудита, если она включена.