[Docs] Update node control API configuration

Aperta Adatta ai principianti
#46 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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

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.
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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Adamant-im/docs

Tutte le issue di Adamant-im/docs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.