9 документов
Системное проектирование
Документ системного проектирования, пакет для подготовки к аудиту, инженерные руководства.
Эти страницы описывают эталонную реализацию: требования, компоненты, операции, меры безопасности и путь от требования к тесту. Это инженерные записи этой реализации.
| Документ | Читать, когда нужно |
|---|---|
| Документ системного проектирования (AREX-SDD-001) | понять всю систему и проследить любое требование до кода и тестов |
| Краткое описание архитектуры (AREX-ARCH) | изложить архитектуру на одной странице |
| Готовность к аудиту (AREX-AUD-001) | определить объём и подготовить аудит безопасности |
| Разработка хуков (AREX-HOOK) | написать, протестировать и зарегистрировать хук |
| Начало работы, Разработка, Тестирование, Конфигурация | подготовить рабочую среду, изменять, тестировать и настраивать репозиторий |
| Структура проекта | найти, где что находится |
Доступ
Эти страницы помогают понять форму эталонной системы. Написание хука, развёртывание токена или чтение интерфейса используют репозитории.
Компании, которые хотят реализовать A-REX, выпускать с ним партии или проводить аудит, запрашивают доступ для чтения на странице Запросить ранний доступ. Каждую заявку рассматривают вручную. Одобренные читатели получают доступ только для чтения к репозиторию стандарта и к эталонной реализации.
Документы
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.