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.

​
Role Tiers

SuperVaults enforces four permission tiers with distinct onchain and offchain boundaries:
RoleOn-Chain?ScopeMutable?
Primary ManagerYesFull vault controlImmutable (set at creation)
Secondary ManagerYesAll operations except vault settingsRemovable via onchain tx
View OnlyNoDashboard read accessAdded/removed offchain
Registry MaintainerNoGlobal registry CRUDDB-level grant

​
Primary Manager

The primary manager is the onchain vault owner. One per vault.
  • Set at vault creation: the wallet that signs POST /api/v1/vaults/create/prepare
  • Cannot be changed without governance-level contract interaction
  • Exclusive access to vault settings (redeem timelock) and user management
  • Can add and remove secondary managers
The primary manager key cannot be rotated. Use a hardware wallet or multi-sig for production vaults. If this key is compromised, the attacker gains full vault control.

​
Secondary Manager

On-chain delegates with operational authority. A vault supports multiple secondary managers.
  • Added via POST /api/v1/users/secondary-manager/prepare (prepare pattern, requires wallet signature)
  • Removed via POST /api/v1/users/secondary-manager/remove/prepare
  • Full operational access: yield sources, merkle trees, strategies, pause/unpause, view-only user management
  • Cannot modify vault settings or add/remove other secondary managers

​
View Only

Off-chain read access. No onchain transaction required.
  • Added via POST /api/v1/users/view-only
  • Removed via DELETE /api/v1/users/view-only/{wallet}
  • Read-only dashboard and analytics visibility
  • No write capabilities

​
Registry Maintainer

Global permission for administering Erebor registries. Not vault-scoped.
  • Grants access to the Registry and Admin pages
  • Required for: creating/updating/deleting yield sources, oracles, hooks in the global registry; running data backfills
  • Separate from vault manager roles

​
Permission Matrix

ActionPrimarySecondaryView OnlyRegistry Maintainer
View dashboard✅✅✅—
Configure strategies✅✅❌—
Manage yield sources✅✅❌—
Merkle tree operations✅✅❌—
Create/edit strategies✅✅❌—
Pause vault (onchain)✅✅❌—
Pause keeper services✅✅❌—
Add/remove secondary managers✅❌❌—
Add/remove view-only users✅✅❌—
Vault settings (redeem timelock)✅❌❌—
Registry CRUD———✅
Admin backfill———✅

​
AuthGuard Enforcement

The institutional dashboard enforces permissions at both the page level and the API level: Client-side: AuthGuard checks curator_is_manager in localStorage and redirects unauthorized users. Server-side: All Erebor endpoints validate JWT claims. A 403 Forbidden response means the connected wallet lacks the required role.

​
Managing Users via API

# List all users for a vault
GET /api/v1/users?vault_address={address}&chain_id={chainId}
Authorization: Bearer <jwt>

# Prepare add secondary manager (returns calldata to sign)
POST /api/v1/users/secondary-manager/prepare
Authorization: Bearer <jwt>
{ "vault_address": "0x...", "chain_id": 8453, "manager_address": "0xnew..." }

# Add view-only user (offchain, no gas)
POST /api/v1/users/view-only
Authorization: Bearer <jwt>
{ "vault_address": "0x...", "chain_id": 8453, "wallet_address": "0x...", "display_name": "Risk Monitor" }
See User Management for the full UI walkthrough.