9 documentos
Projeto do sistema
Documento de Projeto do Sistema, pacote de prontidão para auditoria, guias de engenharia.
Documentação de engenharia da implementação de referência no estilo de projeto de sistema da IBM: requisitos, modelos de componentes e de dados, diagramas de sequência, modelo operacional, controles de segurança, desempenho medido e rastreabilidade do requisito ao teste.
| Documento | Leia quando precisar |
|---|---|
| Documento de Projeto do Sistema (AREX-SDD-001) | entender o sistema como um todo e rastrear qualquer requisito até o código e os testes |
| Resumo da arquitetura (AREX-ARCH) | explicar o projeto em uma página |
| Prontidão para auditoria (AREX-AUD-001) | definir o escopo de uma auditoria de segurança e se preparar para ela |
| Desenvolvimento de hooks (AREX-HOOK) | escrever, testar e registrar um hook |
| Primeiros passos, Desenvolvimento, Testes, Configuração | preparar, alterar, testar e configurar o repositório |
| Estrutura do projeto | encontrar onde cada coisa está |
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.