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.

Catalog listing connects an onchain SuperVault to Superform discovery. A vault can be created, indexed, and manager-visible without being listed to users.

State model

LayerMeaning
Onchain vaultContract exists on the deployment chain.
Managed vaultErebor can read it and managers can operate it.
Catalog listingPersephone/Superform catalog knows how to display and route users to it.
Available listingThe listing is both visible and available for user flows.

Listing fields

FieldDescription
provider_idsProvider or institution IDs associated with the vault.
categoryCatalog category, commonly yield.
visibilityWhether the vault is listed or hidden from discovery.
availabilityWhether the listed vault is available to users. Non-superadmins cannot set unavailable.
external_urlOptional external detail page or provider URL.
name / descriptionUser-facing catalog copy.
yield_source_idsOptional catalog yield-source associations.
Default catalog inputs are visibility: listed and availability: available when the role allows it.

Unlisted SuperVaults

The Unlisted SuperVaults panel finds vaults you manage that are not in the catalog. Adding one pre-fills chain, address, provider IDs, category, visibility, availability, and external URL where known.

Operational invariant

Do not treat deployment as launch. Launch requires:
  1. Onchain creation and indexing.
  2. Upkeep-funded activation.
  3. Hook and merkle proof readiness.
  4. Yield sources and strategy setup.
  5. Catalog row set to listed and available.
The Setup Checklist is the canonical place to verify launch readiness.