[Docs] Update node control API configuration

Open Beginner friendly
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Domain
documentation

Research direction

Start with own-node/configuration.md and locate the forging and DApp runtime configuration sections. Update them to match the listed removal and compatibility requirements, then add a release note covering the removed HTTP routes, graceful restart migration, generic transaction API, and unchanged type 5, 6, and 7 behavior. Done means the verification checklist is satisfied and the completed documentation change is linked from Adamant-im/adamant#295.

Written by the indexing model from the issue text.

Description

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.
Dominant language
CSS
Stars
119
Forks
2
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Adamant-im/docs

All issues in Adamant-im/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.