9 documents
Conception du système
Document de conception du système, dossier de préparation à l'audit, guides d'ingénierie.
Documentation d'ingénierie de l'implémentation de référence dans le style de conception de système d'IBM : exigences, modèles de composants et de données, diagrammes de séquence, modèle opérationnel, contrôles de sécurité, performances mesurées et traçabilité de l'exigence au test.
| Document | À lire lorsque vous devez |
|---|---|
| Document de conception du système (AREX-SDD-001) | comprendre l'ensemble du système et relier n'importe quelle exigence au code et aux tests |
| Synthèse de l'architecture (AREX-ARCH) | expliquer la conception en une page |
| Préparation à l'audit (AREX-AUD-001) | cadrer et préparer un audit de sécurité |
| Développement de hooks (AREX-HOOK) | écrire, tester et enregistrer un hook |
| Prise en main, Développement, Tests, Configuration | installer, modifier, tester et configurer le dépôt |
| Structure du projet | trouver où se trouve chaque élément |
Documents
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.