[Docs] Update node control API configuration
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ả
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, ordisableAll; - 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.whiteListfrom the activeforgingobject; - explain that forging remains controlled by
forging.secretand changes require a graceful node restart; - remove the active
dapp.masterrequired,dapp.masterpassword, anddapp.autoexecconfiguration; - explain that clients must sign DApp transactions locally and submit them through the standard transaction API;
- state that legacy
forging.accessanddappblocks 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.mdcontains no activeforging.accessor DApp runtime settings.- The documented
forging.secretworkflow 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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Adamant-im/docs
-
APIs documentation Nodes
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 72/100
Adamant-im/docs#45 · 2 bình luận ·
-
documentation Guideline Nodes Security
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsCó thể đã có người làm @adamant-al đã nhận 6 ngày trước. Đang mởCI/CD Security Task
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
Adamant-im/docs#40 ·
Tất cả issue của Adamant-im/docs
Issue tương tự
-
review-followup
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
griffinwork40/agent-afk#5180 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Đang mở
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Document the service-mesh L7 authorization boundary: non-enrolled workloads and shared rulesĐang mởarea:kubernetes area:security documentation priority:medium size:small
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
Maintainer thường phản hồi trong vòng 1 ngày