[Docs] Update node control API configuration
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
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.
- 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from Adamant-im/docs
-
APIs documentation Nodes
Difficulty 3/5 1-2 days Newbie friendliness 72/100
Adamant-im/docs#45 · 2 comments ·
-
documentation Guideline Nodes Security
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsPossibly taken @adamant-al claimed this 6 days ago. OpenCI/CD Security Task
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Adamant-im/docs#40 ·
Similar issues
-
review-followup
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
griffinwork40/agent-afk#5180 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 76/100
416rehman/Guardrails#1716 ·
-
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
-
area:kubernetes area:security documentation priority:medium size:small
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
Maintainers usually reply within 1 day