[Docs] Update node control API configuration

オープン 初心者向け
#46 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
78/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
領域
documentation

調査の方向性

own-node/configuration.mdから始め、forging と DApp ランタイムの設定セクションを見つけてください。記載されている削除要件と互換性要件に合わせて更新し、削除された HTTP ルート、段階的な再起動のための移行、汎用トランザクション API、タイプ 5、6、7 の動作に変更がないことを網羅するリリースノートを追加してください。検証チェックリストが満たされ、完成したドキュメントの変更が Adamant-im/adamant#295 からリンクされていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
CSS
スター
119
フォーク
2
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Adamant-im/docs のほかの issue

Adamant-im/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。