9 份文档
系统设计
系统设计文档、审计就绪材料包、工程指南。
参考实现的工程文档，采用 IBM 系统设计风格：需求、组件模型和数据模型、时序图、运维模型、安全控制、实测性能，以及从需求到测试的可追溯性。
| 文档 | 在需要以下操作时阅读 |
|---|---|
| 系统设计文档（AREX-SDD-001） | 理解整个系统，并把任何需求追溯到代码和测试 |
| 架构摘要（AREX-ARCH） | 用一页纸说明该设计 |
| 审计就绪（AREX-AUD-001） | 界定并准备一次安全审计 |
| 钩子开发（AREX-HOOK） | 编写、测试并注册钩子 |
| 快速入门、开发、测试、配置 | 搭建、修改、测试和配置代码仓库 |
| 项目结构 | 找到任何内容所在的位置 |
文档
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.