[Docs] Update node control API configuration
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
調査の方向性
own-node/configuration.mdから始め、forging と DApp ランタイムの設定セクションを見つけてください。記載されている削除要件と互換性要件に合わせて更新し、削除された HTTP ルート、段階的な再起動のための移行、汎用トランザクション API、タイプ 5、6、7 の動作に変更がないことを網羅するリリースノートを追加してください。検証チェックリストが満たされ、完成したドキュメントの変更が Adamant-im/adamant#295 からリンクされていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- CSS
- スター
- 119
- フォーク
- 2
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Adamant-im/docs のほかの issue
-
APIs documentation Nodes
難易度 3/5 1〜2日 初心者へのやさしさ 72/100
Adamant-im/docs#45 · コメント 2 件 ·
-
documentation Guideline Nodes Security
難易度 4/5 3〜5日 初心者へのやさしさ 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findings対応中かも @adamant-al が 6 日前に担当しました。 オープンCI/CD Security Task
難易度 4/5 3〜5日 初心者へのやさしさ 48/100
Adamant-im/docs#40 ·
Adamant-im/docs の issue をすべて見る
似ている issue
-
review-followup
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
griffinwork40/agent-afk#5180 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 76/100
416rehman/Guardrails#1716 ·
-
難易度 1/5 1〜3時間 初心者へのやさしさ 72/100
-
area:kubernetes area:security documentation priority:medium size:small
難易度 1/5 1〜3時間 初心者へのやさしさ 88/100
RonaldHensbergen/composable-data-stack#1339 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
メンテナーはふだん 1 日以内に返信