Skip to main contentA-REX Foundation

Whitepaper · 11

Implementation Guide

What the implementation guide covers, step by step, and how to obtain it.

What the guide is

The guide takes an engineer from a clean checkout to a deployed batch token with rules and attestations. Every code block in it is copied from a test of the reference implementation and runs in continuous integration, so the guide cannot drift from the code. This page describes its steps; the guide itself, with its code, is part of early access.

Steps it covers

StepWhat the engineer does
Set up and deployInstalls the reference implementation and deploys the token and the attestation registry.
RolesGives issuing, processing, enforcement and administration to separate accounts.
Create and read a batchRecords a lot with its commodity, unit, dates, origin reference and document commitment.
TransferMoves units and asks the token why a refused transfer was refused.
LineageSplits, merges and processes lots, keeping each parent linked.
Status and metadataMoves a lot through its lifecycle and updates its document commitment.
RulesRegisters rule contracts in order and checks their effect.
AttestationsTrusts issuers per topic and records certificates per lot.
Eligibility and enforcementRestricts accounts, freezes amounts and carries out forced transfers.
Retire, index and upgradeCloses a lot for good, rebuilds the lineage from events, and upgrades the token after validating it.

Going to production

The guide ends with a checklist: a reproducible build with tests passing; roles redistributed and the deployer's renounced; rules audited and their order published; the metadata schema version and status table published, with no personal data in the origin reference; legal instruments referenced and the classification of the offer settled with counsel; a third-party audit of the token, the attestation registry and every registered rule; and an upgrade rehearsed before it is needed.

Access

Companies that want to implement A-REX, issue batches with it or audit it request the guide, with the normative text, on Request early access.