Skip to content

docs: add comprehensive RustChain protocol spec draft (bounty #8)#555

Merged
Scottcjn merged 1 commit intoScottcjn:mainfrom
createkr:docs/protocol-bounty-8
Mar 4, 2026
Merged

docs: add comprehensive RustChain protocol spec draft (bounty #8)#555
Scottcjn merged 1 commit intoScottcjn:mainfrom
createkr:docs/protocol-bounty-8

Conversation

@createkr
Copy link
Contributor

@createkr createkr commented Mar 3, 2026

This PR adds a comprehensive protocol documentation draft for RustChain in docs/PROTOCOL_BOUNTY_8.md, covering RIP-200 overview, attestation flow, epoch settlement, hardware fingerprinting rationale, token economics mechanics, network architecture, glossary, and a broad public API reference with curl examples plus mermaid diagrams for attestation and epoch lifecycle.

Scope notes: this is a consolidated draft designed for outside developers/agents to quickly understand and build on the system, and includes a recommended split plan into modular docs files for final upstream structure.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 3, 2026
@github-actions github-actions bot added the size/XS PR: 1-10 lines label Mar 3, 2026
@platontuev-create
Copy link

🎯 AI Solution:

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

  1. Организация структуры документа: Определите, как будет структурирован документ PROTOCOL_BOUNTY_8.md. Основные разделы, которые нужно включить:

    • Обзор RIP-200
    • Поток аттестации
    • Урегулирование эпох
    • Логика аппаратной отпечатки
    • Механика токеновой экономики
    • Архитектура сети
    • Глоссарий
    • Обширная ссылка на публичный API с примерами на curl
    • Диаграммы mermaid для жизненного цикла аттестации и эпохи
  2. Написание содержания:

    • Обзор RIP-200: Опишите основную идею и цели RIP-200, его значение для протокола RustChain.
    • Поток аттестации: Укажите шаги, как происходит аттестация в системе, кто участвует в процессе и как это помогает обеспечить доверие.
    • Урегулирование эпох: Опишите, что такое эпохи и каким образом происходит их урегулирование.
    • Логика аппаратной отпечатки: Объясните, почему важна аппаратная идентификация и как она внедряется в протокол.
    • Механика токеновой экономики: Опишите, как функционирует токеномика в RustChain, какие токены используются и как они связаны с аттестацией и сетью.
    • Архитектура сети: Приведите детали архитектуры RustChain, включая распределенные компоненты и взаимодействия между ними.
    • Глоссарий: Предоставьте определения основных терминов и сокращений, используемых в протоколе.
    • Публичный API и примеры: Подготовьте раздел с описанием доступных API и приведите примеры запросов с помощью curl для наглядности.
    • Диаграммы mermaid: Создайте визуальные диаграммы, чтобы проиллюстрировать сложные процессы, такие как аттестация и жизненный цикл эпохи.
  3. Рекомендации по разбиению на модули: В конце документа предложите структурированный план для разбиения документации на подмодули, чтобы разработчики могли более легко ориентироваться в материале. Укажите, какие разделы могут быть выделены в отдельные файлы, и как они будут связаны между собой.

  4. Глубокая проверка и редактирование: После завершения написания документа проведите его проверку на наличие ошибок, а также на соответствие техническим требованиям и стилю проекта.

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

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

Copy link
Owner

@Scottcjn Scottcjn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good consolidated protocol spec with API reference. The curl examples in Section 7 are the most valuable addition — we have protocol docs but lacked a single-page API reference.

Minor notes (non-blocking for a docs PR):

  • https://rustchain.org in examples should use $BASE variable (domain not live yet)
  • /wallet/transfer example should note admin key requirement (security fix from Dec 2025)
  • VM penalty is now strict 0.0 not the old 0.000000001x

Approved for bounty #8 (15 RTC). Merging.

@Scottcjn Scottcjn merged commit 080714f into Scottcjn:main Mar 4, 2026
6 checks passed
@Scottcjn
Copy link
Owner

Scottcjn commented Mar 4, 2026

Bounty #8 paid: 15 RTC → createkr

Pending ID: 549 | TX: 5d6759ec
Confirms in 24h.

Thanks for the consolidated protocol spec + API reference.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants