[Docs] Update node control API configuration

Abierto Apto para principiantes
#46 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo

Línea de trabajo

Empieza con own-node/configuration.md y localiza las secciones de configuración de forging y del runtime de DApp. Actualízalas para que cumplan los requisitos indicados de eliminación y compatibilidad; después, añade una nota de publicación que cubra las rutas HTTP eliminadas, la migración para un reinicio gradual, la API genérica de transacciones y el comportamiento sin cambios de los tipos 5, 6 y 7. La tarea estará terminada cuando se cumpla la lista de verificación y el cambio de documentación completado esté enlazado desde Adamant-im/adamant#295.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
CSS
Estrellas
119
Forks
2
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Adamant-im/docs

Todos los issues de Adamant-im/docs

Issues similares

Más issues de Documentation

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.