9 documentos
Diseño de sistema
Documento de Diseño de Sistema, paquete de preparación para la auditoría, guías de ingeniería.
Documentación de ingeniería de la implementación de referencia al estilo de diseño de sistemas de IBM: requisitos, modelos de componentes y de datos, diagramas de secuencia, modelo operativo, controles de seguridad, rendimiento medido y trazabilidad desde el requisito hasta la prueba.
| Documento | Léase cuando se necesite |
|---|---|
| Documento de Diseño de Sistema (AREX-SDD-001) | comprender todo el sistema y rastrear 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 la auditoría (AREX-AUD-001) | delimitar y preparar una auditoría de seguridad |
| Desarrollo de hooks (AREX-HOOK) | escribir, probar y registrar un hook |
| Primeros pasos, Desarrollo, Pruebas, Configuración | preparar, modificar, probar y configurar el repositorio |
| Estructura del proyecto | encontrar dónde reside cada cosa |
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.