Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superform.xyz/llms.txt

Use this file to discover all available pages before exploring further.

This guide follows the operator path from vault deployment to a live Superform listing. The launch path is complete when the vault is indexed, funded for upkeep, authorized with hooks, connected to yield sources, backed by at least one strategy, and listed as available in the Superform catalog. Prerequisites: operator access, connected EVM wallet, gas on the deployment chain, provider profile, and the token/yield-source details for the vault.
1

Create the vault

Open Create Vault (/vaults/create). The editable wizard has four steps:
  1. Basic Information — select chain, provider, underlying asset, listing metadata, and the computed onchain name/symbol.
  2. Managers — assign the primary manager and optional secondary managers.
  3. Fees — configure fee recipient, performance fee, management fee, PPS timing, and redemption timing.
  4. Review — inspect the full configuration before the transaction phase.
After review, the modal moves through transaction signing, indexing, optional yield-source setup, and completion. See Create Vault.
2

Work through the setup checklist

Open Setup. Treat it as the canonical go-live checklist:
  • Vault is created and readable.
  • Upkeep is staked so automation can run.
  • Hooks are configured in the active root config.
  • Yield sources are whitelisted.
  • At least one strategy exists.
  • The vault is listed and available in the Superform catalog.
The checklist coordinates operational readiness and public discovery. See Setup Checklist.
3

Fund upkeep and activate automation

Open Vault Settings → Upkeep. Fund the required upkeep balance. Erebor marks the vault active and discoverable once the funding gate is satisfied.Without upkeep, operator pages can still show the vault by direct link, but keeper automation and discoverability remain gated.
4

Configure hook authorization

Open Merkle Trees and follow the manager-root flow:
  1. Draft a root config.
  2. Activate the config.
  3. Generate the merkle tree.
  4. Have the primary manager propose and publish the root onchain.
Keepers and OMS intents need active merkle proofs for each hook/parameter combination they execute.
5

Whitelist yield sources

Open Yield Sources. Add each target yield source with its paired oracle. Bulk add, bulk remove, and bulk oracle update flows prepare a single transaction for multiple rows.Emergency-exit readiness is tied to the whitelist: each whitelisted yield source can have a paired EMERGENCY_EXIT strategy used by the Pause page to drain that source during an incident.
6

Create and order strategies

Open Strategy Canvas. Create user-defined strategies for deposits, withdrawals, and rebalances. Strategy priority is server-managed: use drag-to-reorder, which persists through POST /api/v1/strategies/reorder. Create and update requests do not carry priority.Before a strategy can publish intents, the OMS session key must be ready and the active merkle tree must contain the required withdrawal/deposit hooks.
7

List the vault in the catalog

Open the catalog/listing flow. Confirm provider IDs, visibility, availability, category, description, and external URL when relevant.Onchain created means the vault contract exists. Listed and available means the vault is discoverable in Superform surfaces. See Catalog Listing.
8

Monitor intents and operations

Use Dashboard for vault health, Intent History for execution traces, and Pause for incident controls. Intent History maps Strategy Engine rows to OMS events, fills, gas usage, mined timestamps, and hook transaction details.

​
Go-live checklist

  • Vault contract created, indexed, and readable in dashboard data
  • Upkeep funded and activation gate cleared
  • Active hook config exists
  • Merkle tree generated, proposed onchain by the primary manager, and published
  • Yield sources whitelisted with correct oracles
  • At least one strategy exists and intended strategies are RUNNING
  • OMS session key readiness is green
  • Catalog listing is listed and available
  • Intent History shows expected execution or no unexpected failures