> For the complete documentation index, see [llms.txt](https://docs.t-rex.network/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.t-rex.network/guides/about-the-guides.md).

# 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.

| Section                      | What it gives                                                                            |
| ---------------------------- | ---------------------------------------------------------------------------------------- |
| **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.

| Range    | Guides                                                                                                                                                                                                                                     |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 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.**

| You want                          | Use                                                  |
| --------------------------------- | ---------------------------------------------------- |
| 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

| Order | ID | Guide                                                                                          |
| ----- | -- | ---------------------------------------------------------------------------------------------- |
| 1     | 01 | [Deploy a token suite](/guides/issuer/01.-deploy-a-token-suite.md)                             |
| 2     | 25 | [Commission a suite and grant roles](/guides/issuer/25.-commission-a-suite-and-grant-roles.md) |
| 3     | 03 | [Configure required claim topics](/guides/issuer/03.-configure-required-claim-topics.md)       |
| 4     | 04 | [Add a trusted Claim Issuer](/guides/issuer/04.-add-a-trusted-claim-issuer.md)                 |
| 5     | 20 | [Remove a trusted Claim Issuer](/guides/issuer/20.-remove-a-trusted-claim-issuer.md)           |
| 6     | 11 | [Add a compliance rule](/guides/issuer/11.-add-a-compliance-rule.md)                           |
| 7     | 12 | [Remove a compliance rule](/guides/issuer/12.-remove-a-compliance-rule.md)                     |
| 8     | 26 | [Authorize spenders](/guides/issuer/26.-authorize-spenders.md)                                 |
| 9     | 27 | [Upgrade a suite](/guides/issuer/27.-upgrade-a-suite.md)                                       |

### Identity

| Order | ID | Guide                                                                                                                        |
| ----- | -- | ---------------------------------------------------------------------------------------------------------------------------- |
| 1     | 02 | [Deploy an ONCHAINID](/guides/identity/02.-deploy-an-onchainid.md)                                                           |
| 2     | 07 | [Link a wallet to an ONCHAINID](/guides/identity/07.-link-a-wallet-to-an-onchainid.md)                                       |
| 3     | 23 | [Revoke a wallet](/guides/identity/23.-revoke-a-wallet.md)                                                                   |
| 4     | 22 | [Add and remove keys on an ONCHAINID](/guides/identity/22.-add-and-remove-keys-on-an-onchainid.md)                           |
| 5     | 28 | [Install the recovery module and manage guardians](/guides/identity/28.-install-the-recovery-module-and-manage-guardians.md) |
| 6     | 21 | [Recover access to an ONCHAINID](/guides/identity/21.-recover-access-to-an-onchainid.md)                                     |
| 7     | 24 | [Transfer through the identity](/guides/identity/24.-transfer-through-the-identity.md)                                       |

### Claim Issuer

| Order | ID | Guide                                                                                                        |
| ----- | -- | ------------------------------------------------------------------------------------------------------------ |
| 1     | 05 | [Issue a claim to an investor](/guides/claim-issuer/05.-issue-a-claim-to-an-investor.md)                     |
| 2     | 19 | [Revoke a claim](/guides/claim-issuer/19.-revoke-a-claim.md)                                                 |
| 3     | 29 | [Bring an EAS attestation in as a claim](/guides/claim-issuer/29.-bring-an-eas-attestation-in-as-a-claim.md) |

### Positions

| Order | ID | Guide                                                                                     |
| ----- | -- | ----------------------------------------------------------------------------------------- |
| 1     | 08 | [Mint a position to an investor](/guides/positions/08.-mint-a-position-to-an-investor.md) |
| 2     | 10 | [Transfer between investors](/guides/positions/10.-transfer-between-investors.md)         |
| 3     | 09 | [Burn a position](/guides/positions/09.-burn-a-position.md)                               |

### Agents

| Order | ID | Guide                                                                                                                            |
| ----- | -- | -------------------------------------------------------------------------------------------------------------------------------- |
| 1     | 06 | [Register an investor for an asset](/guides/agents/06.-register-an-investor-for-an-asset.md)                                     |
| 2     | 17 | [Update an investor's registration](/guides/agents/17.-update-an-investors-registration.md)                                      |
| 3     | 18 | [Remove an investor's registration](/guides/agents/18.-remove-an-investors-registration.md)                                      |
| 4     | 13 | [Freeze and unfreeze an address or a partial balance](/guides/agents/13.-freeze-and-unfreeze-an-address-or-a-partial-balance.md) |
| 5     | 14 | [Execute a forced transfer](/guides/agents/14.-execute-a-forced-transfer.md)                                                     |
| 6     | 15 | [Recover a position from a lost wallet](/guides/agents/15.-recover-a-position-from-a-lost-wallet.md)                             |
| 7     | 16 | [Pause and unpause a token](/guides/agents/16.-pause-and-unpause-a-token.md)                                                     |

### Cross-chain

| Order | ID | Guide                                                                                                           |
| ----- | -- | --------------------------------------------------------------------------------------------------------------- |
| 1     | 33 | [Open an asset on a satellite](/guides/cross-chain/33.-open-an-asset-on-a-satellite.md)                         |
| 2     | 30 | [Delegate a position out to a satellite](/guides/cross-chain/30.-delegate-a-position-out-to-a-satellite.md)     |
| 3     | 31 | [Transfer on a satellite](/guides/cross-chain/31.-transfer-on-a-satellite.md)                                   |
| 4     | 34 | [Transfer between two satellites](/guides/cross-chain/34.-transfer-between-two-satellites.md)                   |
| 5     | 32 | [Recall a position to the reference chain](/guides/cross-chain/32.-recall-a-position-to-the-reference-chain.md) |
| 6     | 35 | [Discard or resolve a validation](/guides/cross-chain/35.-discard-or-resolve-a-validation.md)                   |
| 7     | 36 | [Handle a late reconciliation or a halt](/guides/cross-chain/36.-handle-a-late-reconciliation-or-a-halt.md)     |

### 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](/guides/journeys.md).

| ID | Journey                                                                                                                                                             |
| -- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| J1 | [Issuer journey: launch an asset](/guides/journeys/j1.-issuer-journey-launch-an-asset.md)                                                                           |
| J2 | [Investor journey: from onboarding to secondary transfer](/guides/journeys/j2.-investor-journey-from-onboarding-to-secondary-transfer.md)                           |
| J3 | [Transfer agent journey: operations on a live asset](/guides/journeys/j3.-transfer-agent-journey-operations-on-a-live-asset.md)                                     |
| J4 | [Cross-chain journey: distribute and reconcile](/guides/journeys/j4.-cross-chain-journey-distribute-and-reconcile.md)                                               |
| J5 | [Offboarding journey: an investor that must no longer hold or receive](/guides/journeys/j5.-offboarding-journey-an-investor-that-must-no-longer-hold-or-receive.md) |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.t-rex.network/guides/about-the-guides.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.