[Docs] Update node control API configuration
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
- Área
- documentation
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
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.
- 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
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Adamant-im/docs
-
APIs documentation Nodes
Dificultad 3/5 1-2 días Aptitud para principiantes 72/100
Adamant-im/docs#45 · 2 comentarios ·
-
documentation Guideline Nodes Security
Dificultad 4/5 3-5 días Aptitud para principiantes 52/100
Adamant-im/docs#41 ·
-
[Chore] Update dependencies to latest ncu versions and clear npm audit findingsPosiblemente ocupada @adamant-al la tomó hace 6 días. AbiertoCI/CD Security Task
Dificultad 4/5 3-5 días Aptitud para principiantes 48/100
Adamant-im/docs#40 ·
Todos los issues de Adamant-im/docs
Issues similares
-
review-followup
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
griffinwork40/agent-afk#5180 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 1-3 horas Aptitud para principiantes 76/100
416rehman/Guardrails#1716 ·
-
Ep2: source of metadata?Abierto
Dificultad 1/5 1-3 horas Aptitud para principiantes 72/100
-
Document the service-mesh L7 authorization boundary: non-enrolled workloads and shared rulesAbiertoarea:kubernetes area:security documentation priority:medium size:small
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
RonaldHensbergen/composable-data-stack#1339 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día