> For the complete documentation index, see [llms.txt](https://gabriel-j-shapiro.gitbook.io/metalex-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gabriel-j-shapiro.gitbook.io/metalex-docs/protocol-reference/reference.md).

# Overview

Reference is information-oriented: dry, neutral, and complete. Use it to look up what something *is*, not to learn or to do.

> **The contract source is authoritative.** These pages are generated from the contracts in [`cybercorps-contracts`](https://github.com/MetaLex-Tech/cybercorps-contracts) as of the `develop` branch (contracts at `DEPLOY_VERSION` `"4"`). The protocol is under active development — some contracts contain stubbed or in-progress functions, noted on the relevant pages. Always check the current `.sol` source before relying on an exact signature, and treat the code samples in the Tutorials and How-to sections as *illustrative of the flow* rather than copy-paste-ready.

## Contents

* [Core contracts](/metalex-docs/protocol-reference/contracts.md) — every contract with a one-line role.
* [Factories](/metalex-docs/protocol-reference/factories.md) — `CyberCorpFactory` and the sub-factories.
* [Certificate extensions](/metalex-docs/protocol-reference/extensions.md) — per-security-type metadata.
* [Hooks](/metalex-docs/protocol-reference/hooks.md) — transfer-restriction hooks and the LiquiLeX fee hook.
* [Conditions](/metalex-docs/protocol-reference/conditions.md) — the `ICondition` interface.
* [Access control (BorgAuth)](/metalex-docs/protocol-reference/access-control.md) — the numeric role model.
* [Upgrade model](/metalex-docs/protocol-reference/upgrade-model.md) — UUPS + beacon proxies, co-approval.
* [Agreement templates](/metalex-docs/protocol-reference/templates.md) — the `/templates` library.
* [Security types](/metalex-docs/protocol-reference/security-types.md) — the `SecurityClass` enum.
* [Deployments](/metalex-docs/protocol-reference/deployments.md) — canonical addresses.
* [Glossary](/metalex-docs/protocol-reference/glossary.md) — protocol terms.


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gabriel-j-shapiro.gitbook.io/metalex-docs/protocol-reference/reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.