Skip to content

[XLM-20] Limpieza, renombrado de producto, tests finales y documentación #20

Description

@grantfox-oss

Contexto obligatorio: PLAN_STELLAR.md y ISSUES_STELLAR.md.
Ola 6 — bloqueada por todos los anteriores. Es la última.

Problema

Tres residuos del trabajo multicadena:

  1. Columnas muertas que dejó la migración 004.
  2. Documentación que sigue describiendo una plataforma mono-cadena.
  3. El nombre de producto "Coffee XRPL Platform" incrustado en ~25 lugares, varios visibles para el usuario final.

Por qué importa

El README es la cara del proyecto: hoy dice "construida sobre el XRP Ledger" y describe una realidad que ya no es la que hay.

Y el nombre de producto es peor que un detalle cosmético: aparece en el PDF del recibo que se le entrega al productor y en la instrucción que el operador lee en su teléfono al firmar. Un pago liquidado en Stellar que se anuncia como "XRPL Platform" es información incorrecta frente al usuario.

Por qué va al final y no antes

El renombrado toca archivos de los que son dueños casi todos los demás issues (auth_flow.py es de #9, dashboard.py de #14, receipt.py de #10). Hacerlo antes generaría conflictos de merge con todo lo que esté en vuelo. Aquí ya no hay nadie trabajando en esos archivos.

Alcance

1. Limpieza de datos

scripts/migrate_005_drop_legacy_address.py: eliminar producers.xrpl_address y users.xrpl_address, que #5 dejó a propósito como red de seguridad durante el desarrollo.

2. Nombre de producto: Coffee XRPL PlatformCoffee Payments

Visible para el usuario (prioridad):

Archivo Qué ve el usuario
payment_app/ui_payment/auth_flow.py:513 La instrucción que aparece en el teléfono al firmar con Xaman
core/receipt.py:46,72 El PDF del recibo que se entrega al productor
payment_app/ui_payment/auth_flow.py:40,52 Título y encabezado del login de pagos
payment_app/ui_payment/dashboard.py:36 Título de la ventana de pagos
admin_app/ui_admin/login_window.py:32,41 Título y encabezado del login de admin
admin_app/ui_admin/dashboard.py:34 Título de la ventana de admin
admin_app/main_admin.py:19, payment_app/main_payment.py:21 setApplicationName (barra de tareas)
backend/app.py:20 Título de la API en /docs

Interno (docstrings y encabezados): backend/app.py:2, core/audit.py:2, core/models.py:2, core/utils.py:2, core/xaman_client.py:1, shared_ui/__init__.py:2, shared_ui/components.py:2, tests/test_core.py:2, requirements.txt:1.

3. Documentación

  • README.md: sección "Multicadena" con el diagrama de arquitectura, la tabla de equivalencia de escrow XRPL ↔ Stellar y la nota de billetera dual. Actualizar el título, la tabla del stack (stellar-sdk) y el árbol del proyecto (coffee-payments/).
  • QUICKSTART.md: dependencia nueva, migración 004, cómo fondear cuentas de testnet con friendbot, y rutas al nombre nuevo. Ojo: la línea 186 tiene un enlace file:///c:/Users/eric/Desktop/software/... roto desde hace tiempo — cambiarlo por una ruta relativa.
  • backend/README.md: título y el cd coffee_xrpl_platform/backend de la línea 33.
  • AUDITORIA.md: por qué se descartaron los claimable balances (invariante I3) y las diferencias de modelo de seguridad entre ambos escrows.
  • PLAN_IMPLEMENTACION.md: solo el título; el resto es histórico y no se reescribe.

Fuera de alcance

  • Funcionalidad nueva.
  • Renombrar directorios de paquetes de Python (payment_app/, admin_app/): los nombres de módulo no son visibles para el usuario y renombrarlos rompería imports por todo el proyecto sin ganancia.

Criterios de aceptación

  • grep -ri "coffee.xrpl\|coffee_xrpl" . no devuelve nada fuera de los planes históricos.
  • La instrucción de firma en Xaman y el PDF del recibo dicen "Coffee Payments".
  • La migración 005 corre sobre una copia de la base de datos real y es idempotente.
  • Alguien que no conoce el proyecto puede levantarlo en ambas redes siguiendo solo el QUICKSTART.md.
  • pytest tests/ -v completo en verde.

Pruebas

Suite completa; arranque de ambas apps verificando los títulos; generación de un recibo PDF; prueba en limpio del QUICKSTART.md sobre una base de datos nueva.

Dependencias

  • Bloqueada por: todos los issues anteriores del workstream.
  • Bloquea a: nada. Cierra el workstream.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Campaign: Official Campaign | FWC26backendcore/, backend/, modelo de datos, ledgercomplexity: mediumPantalla, endpoint o modulo autocontenidodocumentationImprovements or additions to documentationstellar-multichainWorkstream XRPL + Stellar (PLAN_STELLAR.md)

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions