9 Dokumente
Systementwurf
Systementwurfsdokument, Paket zur Audit-Vorbereitung, technische Leitfäden.
Diese Seiten beschreiben die Referenzimplementierung: Anforderungen, Komponenten, Abläufe, Sicherheitskontrollen und den Weg von einer Anforderung zu einem Test. Sie sind die Ingenieurunterlagen dieser Implementierung.
| Dokument | Zu lesen, wenn Folgendes nötig ist |
|---|---|
| Systementwurfsdokument (AREX-SDD-001) | das gesamte System verstehen und jede Anforderung bis zu Code und Tests zurückverfolgen |
| Architekturübersicht (AREX-ARCH) | den Entwurf auf einer Seite erklären |
| Audit-Bereitschaft (AREX-AUD-001) | ein Sicherheitsaudit eingrenzen und vorbereiten |
| Hook-Entwicklung (AREX-HOOK) | einen Hook schreiben, testen und registrieren |
| Erste Schritte, Entwicklung, Tests, Konfiguration | das Repository einrichten, ändern, testen und konfigurieren |
| Projektstruktur | herausfinden, wo was liegt |
Zugang
Sie können diese Seiten nutzen, um die Gestalt des Referenzsystems zu verstehen. Einen Hook zu schreiben, einen Token bereitzustellen oder eine Schnittstelle zu lesen, verwendet die Repositories.
Unternehmen, die A-REX implementieren, Chargen damit ausgeben oder ihn auditieren wollen, beantragen Lesezugriff über Frühen Zugang beantragen. Jede Anfrage wird von Hand geprüft. Freigegebene Leser erhalten Lesezugriff auf das Repository des Standards und auf die Referenzimplementierung.
Dokumente
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.