> ## Documentation Index
> Fetch the complete documentation index at: https://sealforge.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# sealForge documentation

> Auditable sealed-bid auctions on Zcash: the clearing price is public, the bidders aren't. How these docs are organised and what the status labels mean.

Auditable sealed-bid auctions on Zcash: the clearing price is public, the bidders aren't.

These pages are written for Zcash protocol and wallet engineers first. Every technical claim cites the code (`path`, function or constant) or an evidence file. Every behaviour carries a status label from the table below. The source of every page is in [`docs/site`](https://github.com/Udoka-AM/sealForge/tree/main/docs/site) in the repository. The engineering documents in [`docs/`](https://github.com/Udoka-AM/sealForge/blob/main/docs/README.md) (PRD, TRD and the rest) are the design history these pages cite.

## Status labels

| Label | Meaning |
| - | - |
| `Mainnet` | Has run on Zcash mainnet. **Nothing has yet.** |
| `Testnet` | Has run on public Zcash testnet. The page cites the auction code and transactions |
| `Regtest` | Exercised end to end on the local Zebra + Zaino chain |
| `Tested` | Unit or integration tests only |
| `Specified` | Types or design exist, not built |
| `Not built` | Neither |

## Contents

1. [Overview](https://sealforge.mintlify.site/overview.md): what it is, status of every component, the three guarantees and what isn't guaranteed
2. Protocol specification (`SF1`)
   * [2.1 Roles and what each one knows](https://sealforge.mintlify.site/protocol/roles.md)
   * [2.2 Lifecycle state machine](https://sealforge.mintlify.site/protocol/lifecycle.md)
   * [2.3 Wire formats](https://sealforge.mintlify.site/protocol/wire-formats.md)
   * [2.4 Commitments and domain separation](https://sealforge.mintlify.site/protocol/commitments.md)
   * [2.5 Bid selection](https://sealforge.mintlify.site/protocol/selection.md)
   * [2.6 Clearing](https://sealforge.mintlify.site/protocol/clearing.md)
   * [2.7 Refund privacy](https://sealforge.mintlify.site/protocol/refunds.md)
3. [Zcash integration reference](https://sealforge.mintlify.site/zcash-integration.md): every protocol touchpoint, and the upstream dependency risks
4. [Architecture and infrastructure](https://sealforge.mintlify.site/architecture.md)
5. [Security](https://sealforge.mintlify.site/security.md): trust assumptions, threat model, key custody, findings, mainnet gates
6. [Verification and evidence](https://sealforge.mintlify.site/verification.md): audit any auction, the testnet record, reproducibility, test inventory
7. [Guides](https://sealforge.mintlify.site/guides.md): organiser, trustee, bidder, auditor, integrator
8. [API and SDK reference](https://sealforge.mintlify.site/api-reference.md)
9. [Product and economics](https://sealforge.mintlify.site/product.md)
10. [Roadmap and mainnet gates](https://sealforge.mintlify.site/roadmap.md)
11. [Open questions for reviewers](https://sealforge.mintlify.site/open-questions.md)

Appendices: [glossary](https://sealforge.mintlify.site/appendix/glossary.md), [test vectors](https://sealforge.mintlify.site/appendix/test-vectors.md), [ZIP and spec index](https://sealforge.mintlify.site/appendix/specs.md), [changelog and memo versioning](https://sealforge.mintlify.site/appendix/changelog.md).

## Conventions

* Amounts are integer zatoshi (1 ZEC = 10^8 zat). "TAZ" is testnet ZEC.
* `‖` is byte concatenation. `u32 LE` and `u64 LE` are little-endian unsigned integers.
* Paths are relative to the repository root. Code citations are to `main` at the commit these pages were written against (see the [changelog](https://sealforge.mintlify.site/appendix/changelog.md)).
* Upstream behaviour (Orchard, Ironwood, PCZT, RedPallas, note encryption, consensus) is cited to the ZIP, the protocol specification or the upstream source and version. It is not restated from memory.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.