9 documentos
Diseño del sistema
Documento de diseño del sistema, paquete de preparación para auditoría y guías de ingeniería.
Estas páginas describen la implementación de referencia: requisitos, componentes, operación, controles de seguridad y la trazabilidad de cada requisito hasta su prueba. Son la documentación de ingeniería de esa implementación.
| Documento | Consúltalo cuando necesites |
|---|---|
| Documento de Diseño del Sistema (AREX-SDD-001) | entender el sistema completo y seguir cualquier requisito hasta el código y las pruebas |
| Resumen de arquitectura (AREX-ARCH) | explicar el diseño en una página |
| Preparación para auditoría (AREX-AUD-001) | definir el alcance de una auditoría de seguridad y prepararla |
| Desarrollo de hooks (AREX-HOOK) | escribir, probar y registrar un hook |
| Primeros pasos, Desarrollo, Pruebas, Configuración | instalar, modificar, probar y configurar el repositorio |
| Estructura del proyecto | ubicar dónde está cada cosa |
Acceso
Estas páginas te sirven para entender cómo está armado el sistema de referencia. Para escribir un hook, desplegar un token o leer una interfaz, necesitas los repositorios.
Si tu empresa quiere implementar A-REX, emitir lotes con él o auditarlo, solicita acceso de lectura en Solicitar acceso anticipado. Revisamos cada solicitud a mano. Si te aprueban, recibes acceso de solo lectura al repositorio del estándar y a la implementación de referencia.
Documentos
A-REX Core — System Design Document
RFC 2119 keywords in this document are informative; the normative text is AREX SPEC. Identifiers: FR nn functional requirement, NFR nn non functional requirement, C nn constraint, CMP nn component, ADR nnn decision, INV
A-REX Architecture — one-page summary
The full design — context, requirements, component model, data model, sequence diagrams, operational model, security controls, measured performance, decision records and the traceability matrix — is in SYSTEM DESIGN.md.
Audit Readiness Package
This document is what an external auditor receives on day one: scope, build instructions, invariants, threat model pointers, test coverage matrix, known limitations and the questions we want answered. It does not replace
Writing an A-REX hook
A hook is the only extension point of an A REX Core token. If you can express a rule as "given this operation on this batch between these accounts, allow or return a code", it is a hook.
Getting started
Node.js 20 or 22 LTS and npm. Clone and install from the lockfile:
Development
See PROJECT STRUCTURE.md. In one line: standard/ and contracts/standard/ are the standard; contracts/reference/ is the reference implementation (token, attestations) with the demonstration hooks and extensions.
Testing
Use Node.js 20 or 22 LTS with npm; the committed package lock.json is the source of truth for dependency versions. Newer Node majors may print Hardhat support warnings.
Configuration
Keep secrets in a local .env (see .env.example) or a secret manager. Never commit keys.
Project structure
Nothing in contracts/standard/ imports anything else in the repository; hooks and extensions depend on the interfaces, never on ARexToken.