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.

Operate is the operator control plane for SuperVaults. Its APIs split by operational responsibility.

Services

ServiceOwnsDocs
EreborVault reads, settings, registries, merkle config, upkeep, users, pause controlsErebor API
Strategy EngineStrategy lifecycle, ordering, live shards, intent projections, emergency locksStrategy API
OMSDeFiX intent execution, events, session-key readiness, hook transactionsOMS API
Public merkle artifactPublished proof data for keepers and integratorsMerkle Publishing

Auth

Authenticated endpoints use Dynamic-issued bearer JWTs:
Authorization: Bearer <jwt>
Public endpoints, such as published merkle artifacts and public vault listings, do not require an operator JWT.

Prepare, Sign, Confirm

Most protocol mutations follow this model:
  1. API prepares calldata.
  2. Wallet signs and submits the transaction.
  3. API / indexer reads resulting state or confirms a transaction hash.
Do not treat a successful prepare request as a completed setting change.

Vault Identity and Listing State

A vault can be:
  • Created onchain.
  • Indexed in Erebor.
  • Active / discoverable after upkeep is funded.
  • Listed and available in the Superform catalog.
Those are related but separate states. The dashboard setup flow tracks them together so operators do not route users into a half-configured vault.

Strategy Execution Flow

  1. Operator configures hooks and publishes merkle authorization.
  2. Operator whitelists yield sources and pairs oracles.
  3. Operator creates and orders strategies.
  4. Strategy Engine evaluates rules and submits DeFiX intents.
  5. OMS validates authorization and executes hook transactions.
  6. Events and fills flow back into intent history.

API Reference Pages