> For the complete documentation index, see [llms.txt](https://docs.hyperauth.org/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.hyperauth.org/home/readme.md).

# HyperAuth

The client-side identity layer for Web3

<h2 align="center">HyperAuth</h2>

<p align="center">The client-side identity layer for Web3. One enclave. All apps. Users own everything.</p>

<p align="center"><a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/README.md" class="button primary">Enclave Docs</a> <a href="https://github.com/hyperauth-org/gitbook/blob/main/contracts/README.md" class="button secondary">Contracts Docs</a></p>

<table data-view="cards"><thead><tr><th>Product</th><th>Description</th><th>Link</th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Enclave</strong></td><td>WASM-based identity enclave with MPC keys, UCAN auth, and encrypted storage.</td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/README.md">Learn more</a></td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/README.md">https://github.com/hyperauth-org/gitbook/blob/main/enclave/README.md</a></td></tr><tr><td><strong>Contracts</strong></td><td>Smart contract wallet with passkey auth, ERC-4337, and on-chain DID anchoring.</td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/contracts/README.md">Learn more</a></td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/contracts/README.md">https://github.com/hyperauth-org/gitbook/blob/main/contracts/README.md</a></td></tr><tr><td><strong>SDK</strong></td><td>TypeScript SDK — <code>npm install @hyperauth/sdk</code> — integrate in 100 lines.</td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/sdk/typescript-sdk.md">Learn more</a></td><td><a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/sdk/typescript-sdk.md">https://github.com/hyperauth-org/gitbook/blob/main/enclave/sdk/typescript-sdk.md</a></td></tr></tbody></table>

{% columns %}
{% column %}

#### Get started in 5 minutes

Integrate HyperAuth into your application with just a few lines of code. Our SDK handles the complexity of WASM loading, MPC key generation, and UCAN authentication locally on the user's device.

<a href="https://github.com/hyperauth-org/gitbook/blob/main/enclave/getting-started/quickstart.md" class="button primary" data-icon="rocket-launch">Quickstart Guide</a>
{% endcolumn %}

{% column %}
{% code title="example.ts" overflow="wrap" %}

```typescript
import { createEnclave } from '@hyperauth/sdk';

// Initialize enclave (loads WASM)
const enclave = await createEnclave('/enclave.wasm');

// Create identity with passkey
const { did, accounts } = await enclave.generate(credential);

// Query DID document
const doc = await enclave.query();

// Execute commands
const result = await enclave.exec('resource:accounts action:list');
```

{% endcode %}
{% endcolumn %}
{% endcolumns %}

{% columns %}
{% column %}

#### Why HyperAuth

HyperAuth is built on the principle that identity should be local, private, and owned by the user.

* **Local-first**: Keys never leave the device. Threshold signatures happen in the secure WASM enclave.
* **Open standard**: Built on UCAN, DID, and WebAuthn. No proprietary lock-in.
* **Zero cost**: MIT licensed. No per-user fees or vendor dependencies.
* **Battle-tested**: AES-256-GCM encryption and MPC threshold signing ensure maximum security.
  {% endcolumn %}

{% column %}

#### Secure Architecture

HyperAuth leverages a WASM-based enclave that runs in a separate worker or isolated context. It manages cryptographic material using MPC (Multi-Party Computation) and anchors identities on-chain via ERC-4337 smart wallets.

This ensures that even if the host application is compromised, the user's root keys remain protected within the enclave.
{% endcolumn %}
{% endcolumns %}

<h2 align="center">Open Source Community</h2>

<p align="center">HyperAuth is 100% open source and community-driven.</p>

<table data-card-size="large" data-view="cards"><thead><tr><th>Channel</th><th>Description</th><th>Link</th></tr></thead><tbody><tr><td><strong>GitHub</strong></td><td>Explore the source code, report issues, or contribute to the project.</td><td><a href="https://github.com/hyperauth-org" class="button secondary">View on GitHub</a></td></tr><tr><td><strong>License</strong></td><td>MIT Licensed. Free to use, modify, and distribute.</td><td><a href="https://github.com/hyperauth-org/sdk/blob/main/LICENSE" class="button secondary">Read License</a></td></tr></tbody></table>


---

# 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 following URL with the `ask` and `goal` query parameters:

```
GET https://docs.hyperauth.org/home/readme.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 `build a script that syncs our docs to a CMS` 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.
