[Docs] Update node control API configuration
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 78/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Ambito
- documentation
Direzione di ricerca
Inizia da own-node/configuration.md e individua le sezioni sulla configurazione di forging e del runtime DApp. Aggiornale in modo che rispettino i requisiti elencati per la rimozione e la compatibilità, quindi aggiungi una nota di rilascio che descriva le route HTTP rimosse, la migrazione per un riavvio graduale, l’API generica delle transazioni e il comportamento invariato dei tipi 5, 6 e 7. Il lavoro è completato quando la checklist di verifica è soddisfatta e la modifica alla documentazione completata è collegata da Adamant-im/adamant#295.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- CSS
- Stelle
- 119
- Fork
- 2
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Adamant-im/docs
-
APIs documentation Nodes
Difficoltà 3/5 1-2 giorni Idoneità per principianti 72/100
Adamant-im/docs#45 · 2 commenti ·
-
documentation Guideline Nodes Security
Difficoltà 4/5 3-5 giorni Idoneità per principianti 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsForse già presa @adamant-al l’ha presa 6 giorni fa. ApertaCI/CD Security Task
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Adamant-im/docs#40 ·
Tutte le issue di Adamant-im/docs
Issue simili
-
review-followup
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
griffinwork40/agent-afk#5180 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Aperta
Difficoltà 1/5 1-3 ore Idoneità per principianti 72/100
-
area:kubernetes area:security documentation priority:medium size:small
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
RonaldHensbergen/composable-data-stack#1339 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
I maintainer di solito rispondono entro 1 giorno