# Superform

> Superform is the user-owned neobank enabling single-signature execution of arbitrary actions across chains and optimized vaults.

## Docs

- [Introduction](https://docs.superform.xyz/build.md): Build on Superform: write hooks, curate SuperVaults, and join the validator network.
- [Become a Validator](https://docs.superform.xyz/build/become-a-validator.md): Join the Superform validator network: stake $UP, attest to price-per-share updates, and earn protocol rewards.
- [Write a Hook](https://docs.superform.xyz/build/hooks.md): Step-by-step guide to building custom hooks on Superform, from repo setup through implementation and testing.
- [Curate a SuperVault](https://docs.superform.xyz/build/manage-a-supervault.md): On-chain vault creation, manager roles, upkeep, strategy management, fee configuration, and redemption fulfillment via SuperVaultAggregator.
- [Introduction](https://docs.superform.xyz/curate.md): Technical reference for institutions curating SuperVaults: vault operations, strategy automation, governance, and risk management.
- [Erebor API Reference](https://docs.superform.xyz/curate/api/erebor.md): Complete reference for the Erebor Go management API — REST endpoints across auth, vaults, analytics, merkle, registry, and more.
- [Getting SuperVaults Merkle Tree](https://docs.superform.xyz/curate/api/merkle-publish.md): Fetch the published merkle tree and proofs for a SuperVault. No authentication required.
- [OMS API — DeFiX Intents & Session Keys](https://docs.superform.xyz/curate/api/oms.md): 10-endpoint DeFiX v0.1 intent protocol for submitting, tracking, and cancelling onchain vault operations, plus session-key management for strategy automation.
- [API Overview](https://docs.superform.xyz/curate/api/overview.md): Three backends, one auth model. Route-to-backend matrix and common patterns for the SuperVaults API.
- [Strategy Engine API Reference](https://docs.superform.xyz/curate/api/strategy.md): 14 endpoints for creating and operating rule-based strategies, vault kill switches, and live shard state.
- [Authentication](https://docs.superform.xyz/curate/authentication.md): How JWT auth works in SuperVaults: wallet connection, token storage, and programmatic access.
- [Monitoring Vault State](https://docs.superform.xyz/curate/automation/monitoring.md): Poll endpoints to track PPS, service health, and alert conditions for your vault.
- [Building Institutional Automation](https://docs.superform.xyz/curate/automation/overview.md): Programmatic auth, safety patterns, and an end-to-end example for automated vault operations.
- [Webhooks and Event Streaming](https://docs.superform.xyz/curate/automation/webhooks.md): Webhook delivery is planned but not yet implemented. Use audit logs and polling as the current event stream.
- [Core Concepts](https://docs.superform.xyz/curate/concepts.md): The institution role, ERC-7540 vault mechanics, the hook system, merkle authorization, keeper workers, and the DeFiX intent protocol.
- [Curation Policy](https://docs.superform.xyz/curate/curation-policy.md): Superform's Flagship SuperVault policy covering portfolio construction, risk limits, liquidity, and yield underwriting.
- [Permissions Model](https://docs.superform.xyz/curate/permissions.md): Four access levels for SuperVaults: Primary Manager, Secondary Manager, View Only, and Registry Maintainer.
- [Prerequisites and Access](https://docs.superform.xyz/curate/prerequisites.md): What you need before you can curate a SuperVault: wallet, role, and API access.
- [Quickstart](https://docs.superform.xyz/curate/quickstart.md): Create and configure a SuperVault end-to-end in approximately 15 minutes.
- [Admin: Backfill & Maintenance](https://docs.superform.xyz/curate/ui/admin.md): Internal data maintenance tools for backfilling APY, TVL, and event history for vaults.
- [Alerts](https://docs.superform.xyz/curate/ui/alerts.md): Real-time vault health monitoring with severity classification and alert lifecycle management.
- [Create Vault](https://docs.superform.xyz/curate/ui/create-vault.md): Multi-step vault creation flow: choose chain, asset, configure fees, sign onchain, and poll for indexing.
- [Dashboard](https://docs.superform.xyz/curate/ui/dashboard.md): 9-section vault monitoring dashboard covering TVL, PPS, fees, risk, users, operations, and the Zap Terminal.
- [Home](https://docs.superform.xyz/curate/ui/home.md): The global overview page showing total TVL, vault count, best APY, and a filterable vault list.
- [Institutional](https://docs.superform.xyz/curate/ui/manage.md): Admin-level registry view for browsing all vaults, operating registry workflows, and provider administration.
- [Merkle Trees](https://docs.superform.xyz/curate/ui/merkle-trees.md): Manage hook configurations and onchain merkle root authorization for vault keeper operations.
- [Pause Operations](https://docs.superform.xyz/curate/ui/pause.md): Emergency onchain vault pause and per-vault keeper service controls.
- [Registry Management](https://docs.superform.xyz/curate/ui/registry.md): Manage the global yield source, oracle, and hook registries. Registry Maintainer access required.
- [Strategy Canvas](https://docs.superform.xyz/curate/ui/strategy.md): Create and run automated rebalancing strategies with a visual rule-based canvas.
- [User Management](https://docs.superform.xyz/curate/ui/user-management.md): Add and remove secondary managers and view-only users for your vault.
- [Vault Settings](https://docs.superform.xyz/curate/ui/vault-settings.md): Configure fees, PPS parameters, redeem timelock, banned hook leaves, and upkeep balance for your vault.
- [Yield Source Management](https://docs.superform.xyz/curate/ui/yield-sources.md): Whitelist, remove, and update yield sources and their oracle assignments for your vault.
- [Deployment Addresses](https://docs.superform.xyz/deployment-addresses.md): All Superform v2 contract addresses across Ethereum, Base, Optimism, Arbitrum, BNB, Polygon, Avalanche, Unichain, and HyperEVM.
- [What is Superform?](https://docs.superform.xyz/index.md): Superform is the user-owned neobank enabling single-signature execution of arbitrary actions across chains and optimized vaults.
- [Glossary](https://docs.superform.xyz/learn/glossary.md): Definitions of key terms used throughout the Superform protocol documentation.
- [Hooks](https://docs.superform.xyz/learn/hooks.md): Permissionless composable contracts that can be chained to execute any multi-chain DeFi strategy.
- [Superform Protocol](https://docs.superform.xyz/learn/learn.md): Superform Core and Superform Periphery: how the protocol components fit together.
- [Links](https://docs.superform.xyz/learn/links.md): Superform whitepapers, source code, standards, community, and developer tools.
- [Smart Accounts](https://docs.superform.xyz/learn/smart-accounts.md): ERC-7579 Smart Accounts powering Superform: gas abstraction, passkey login, and session keys while remaining fully self-custodial.
- [Superform Core](https://docs.superform.xyz/learn/superform-core.md): A suite of persistent, non-upgradeable contracts providing Merkle-verified execution through ERC-7579 Smart Accounts and composable Hooks.
- [SuperVaults](https://docs.superform.xyz/learn/supervaults.md): ERC-7540 tokenized vaults with institution-curated yield strategies, Merkle-verified execution, and validator-secured price-per-share.
- [Economics](https://docs.superform.xyz/learn/supervaults/economics.md): SuperVault fee structure: management fees, performance fees, upkeep costs, and the fee skimming mechanism.
- [Transaction Lifecycle](https://docs.superform.xyz/learn/supervaults/transaction-lifecycle.md): End-to-end transaction flows for SuperVault deposits, PPS updates, strategy operations, and redemptions.
- [$UP](https://docs.superform.xyz/learn/usdup.md): The UP token: ownership, staking, governance participation, and planned validator utility in the Superform Protocol.
- [Security](https://docs.superform.xyz/security.md)

## Optional

- [Superform App](https://app.superform.xyz)
- [Institutional Dashboard](https://institutions.superform.xyz)
- [GitHub](https://github.com/superform-xyz)