[Docs] Update node control API configuration

Đang mở Phù hợp với người mới
#46 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với own-node/configuration.md và tìm các phần cấu hình forging và runtime DApp. Cập nhật chúng để đáp ứng các yêu cầu đã liệt kê về việc loại bỏ và khả năng tương thích, sau đó thêm ghi chú phát hành đề cập đến các HTTP route bị loại bỏ, quá trình chuyển đổi để khởi động lại êm, API giao dịch tổng quát và hành vi không thay đổi của loại 5, 6 và 7. Công việc hoàn tất khi danh sách kiểm tra xác minh được đáp ứng và thay đổi tài liệu đã hoàn thành được liên kết từ Adamant-im/adamant#295.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

APIs documentation Nodes Security
Summary

Update operator documentation and release notes for the ADAMANT Node control API removal in Adamant-im/adamant#295.

Details

The node no longer exposes:

  • forging enable, disable, status, enableAll, or disableAll;
  • DApp install, launch, stop, uninstall, state-inspection, server-side signing, dynamic per-DApp, or DApp peer runtime routes.

Update own-node/configuration.md to:

  • remove forging.access.whiteList from the active forging object;
  • explain that forging remains controlled by forging.secret and changes require a graceful node restart;
  • remove the active dapp.masterrequired, dapp.masterpassword, and dapp.autoexec configuration;
  • explain that clients must sign DApp transactions locally and submit them through the standard transaction API;
  • state that legacy forging.access and dapp blocks remain loadable for upgrade compatibility but are ignored.

Add a release-note entry for the breaking HTTP API change and the restart-based migration path. Explicitly state that DApp transaction types 5, 6, and 7 retain their existing validation, serialization, fees, apply/undo behavior, and replay behavior.

Related node work:

  • Adamant-im/adamant#285
  • Adamant-im/adamant#295
  • GHSA-vjhq-r5fg-85cx
Checklist
  • Update the forging configuration section
  • Update or remove the DApp runtime configuration section
  • Add the breaking API and graceful-restart migration note
  • Link the completed documentation change from Adamant-im/adamant#295
Notes

This task is intentionally separate from the node implementation so the node PR can remain scoped to Adamant-im/adamant.

Verification
  • own-node/configuration.md contains no active forging.access or DApp runtime settings.
  • The documented forging.secret workflow matches the node behavior.
  • Release notes call out the removed routes, operator migration, retained generic transaction API, and unchanged type 5-7 consensus behavior.
Ngôn ngữ chính
CSS
Star
119
Fork
2
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Adamant-im/docs

Tất cả issue của Adamant-im/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.