About the guides
A guide documents one operation: who performs it, which calls are made, in which order, what the contracts check, what changes, and what can fail. The Concepts section explains how the protocol works. The guides say how to do one thing with it.
How a guide is built
Every guide has the same sections, in the same order.
At a glance
Who triggers the operation, the actors, the contracts, the preconditions and the result.
Actors and roles
What each actor does in this operation and what it has to hold.
Sequence
A diagram of the calls, in order.
Step by step
For each step: who, the call, what to prepare, what the contract checks, what changes.
State after the flow
What is true on-chain when the operation is done.
Failure modes
Each way the operation fails, its cause and its fix.
Common misunderstandings
What people get wrong about this operation.
Integration notes
What a Platform builds around the calls.
Related flows
The operations that come before, after or instead.
A guide does not re-explain its preconditions. It links to the guide that produces each of them.
How guides are numbered
Every guide carries a two-digit number, such as 01 or 25. The number is a permanent reference. It is not a step number, and it does not say in which order to read the guides.
How a number is given. A guide receives the next free number of its range when it is added to the catalog, and keeps it for good. When a range is full, a new range is opened.
01 to 22
The first catalog of operations: deployment, eligibility, the investor lifecycle, positions, agent operations, identity keys and recovery.
23 to 29
Operations added with T-REX 5 on the reference chain: revoking a wallet, transferring through the identity, commissioning a suite, authorizing spenders, upgrading a suite, managing guardians, bringing an EAS attestation in as a claim.
30 to 39
Cross-chain operations.
J1 to J5
Journeys, which chain several guides.
Why numbers are never changed. A number that stays the same can be quoted. "Guide 14" in a support ticket, in an audit report or in an integrator's runbook means the same operation in every version of these docs. Renumbering each time an operation is added would break every such reference.
Why the numbers look out of order. The guides are grouped by who performs the operation, and each group lists its guides in the order they are performed. That order is not the order in which the guides were added. An Issuer that launches an asset follows 01, then 25, then 03, then 04: guide 25, commissioning a suite, was added to the catalog with T-REX 5 and therefore has a higher number, although it is the second thing an Issuer does.
How to find your way.
The order in which to do things
The "Order" column of each group below, or a journey
To quote or look up one operation
Its number
The guides
Issuer
Identity
Claim Issuer
Positions
Agents
Cross-chain
Journeys
A journey orders several guides end to end for one persona or one situation. It is the place to look for a reading order across groups. See Journeys.
Last updated