Skip to main content
SuperformOS Vault Settings — upkeep activation and notification-channel controls Vault Settings is the configuration hub for vault-level controls. Most settings use the same pattern: Erebor prepares calldata, the manager wallet signs, and the protocol contract applies the change onchain. Public SuperVault detail pages expose Vault Settings as read-only context. Manager-only controls, including upkeep deposit/withdrawal and settings transactions, remain in the authenticated Operate flow.
Prepare endpoints return transaction data. They do not mutate protocol state by themselves. The connected wallet must sign and submit the transaction.

Access Model

Primary managers own sensitive vault settings. Secondary managers can operate the vault but do not control primary-only settings such as manager assignment and some security parameters. See Permissions Model for the full matrix.

Fees

Configure the vault’s performance fee, management fee, and fee recipient. Fee changes protect depositors through the protocol’s proposal/timelock rules. The dashboard displays current values and prepares the required transaction when a primary manager proposes a change.

PPS Parameters

Price-per-share controls define how often PPS can update and when stale data blocks operations. Common fields:
  • Deviation threshold — maximum allowed difference between calculated and current PPS.
  • PPS expiration / staleness — when vault operations should stop waiting for a fresh PPS update.
  • Minimum update interval — minimum time between PPS updates.
These settings are read from vault detail data and changed through signed transactions.

Redeem Timelock

Redeem timelock adds a delay between redemption request and fulfillment eligibility. Use it for:
  • Liquidity sourcing before fulfillment.
  • Fraud and risk review windows.
  • Regulatory or operational policy requirements.
Relevant APIs:
EndpointMethodDescription
/api/v1/redeem-timelocksGETList configured timelocks
/api/v1/redeem-timelocks/bulkGETBulk timelock lookup
/api/v1/vaults/{chain_id}/{vault_address}/redeem-timelockGETRead one vault’s timelock
/api/v1/settings/redeem-timelockPOSTPrepare timelock update transaction
Changing a redeem timelock affects future redemption requests. Existing requests are not retroactively changed.

Banned Hook Leaves

A banned hook leaf is blocked even if it appears in an authorized merkle tree. Use this to quickly stop a specific hook + parameter combination while you prepare a cleaner merkle config update. Banning a leaf is narrow: it blocks the exact leaf, not the entire hook category.

Upkeep and Activation

Upkeep funds vault automation. It is also the practical activation gate for a new vault. The Upkeep panel shows:
  • Current upkeep balance.
  • Upkeep token.
  • Required balance and shortfall.
  • Activation status: active or insufficient_upkeep.
  • Whether the vault is active for keeper operations and discoverable in public listing surfaces.
  • Pending upkeep withdrawal proposal, if any.
A vault below its required upkeep threshold is not considered active. Once the required balance is in place, Erebor marks it active and discoverable. Erebor returns this as upkeep_info plus activation; upkeep withdrawal lifecycle is returned separately as withdrawal_status.

Deposit Upkeep

Managers deposit upkeep through the settings flow:
POST /api/v1/settings/upkeep/deposit
The dashboard handles token allowance checks first, then prepares the deposit transaction for wallet signature.

Withdraw Upkeep

Withdrawals use a propose / execute pattern:
POST /api/v1/settings/upkeep/withdraw/propose
POST /api/v1/settings/upkeep/withdraw/execute
Use withdrawals carefully on live vaults. Pulling the balance below threshold can make the vault inactive or undiscoverable.

Session Keys

Session keys delegate limited execution authority for automation. They are used by the OMS / Strategy Engine path so strategies can publish and execute intents without asking the manager wallet for every tick. Erebor exposes vault-scoped session-key inventory and prepare endpoints:
EndpointMethodDescription
/api/v1/session-keysGETList session keys visible to the manager
/api/v1/vaults/{chain_id}/{vault_address}/session-keyGETRead a vault session key
/api/v1/vaults/session-key/preparePOSTPrepare grant transaction
/api/v1/vaults/session-key/revoke/preparePOSTPrepare revoke transaction
OMS also exposes strategy-automation session-key readiness and rotation endpoints. See OMS API.

Notification Channels

Notification channels attach Slack, webhook, or websocket destinations to a vault.
EndpointMethodDescription
/api/v1/notification-channelsGET/POSTList or create manager-owned channels
/api/v1/vaults/{chain_id}/{vault_address}/notification-channelsGETList vault channels
/api/v1/vaults/{chain_id}/{vault_address}/notification-channels/{channel_id}POSTAttach channel
/api/v1/vaults/{chain_id}/{vault_address}/notification-channels/{channel_id}DELETEDetach channel
Use notification channels for operational alerts, monitoring, and downstream automation.

Alert Delivery

Alerts connect vault events to notification destinations. Treat alert delivery as operational plumbing: create the channel first, bind it to the vault, then verify delivery with a low-risk event before relying on it for incidents. Notification channel records include:
FieldDescription
providerChannel provider or transport.
nameOperator-facing channel name.
configProvider-specific destination config. Sensitive values should be redacted in UI.
created_byCreator metadata.
created_at / updated_atAudit timestamps.
Recommended alert categories:
  • Upkeep shortfall or activation loss.
  • PPS staleness.
  • Failed keeper runs.
  • Session-key readiness changes.
  • Emergency pause / unpause.
  • Emergency liquidity exit arm / stop.
  • Merkle generation or publish failure.
  • Repeated OMS execution failure.
Troubleshooting:
SymptomCheck
Channel exists but receives nothingConfirm it is bound to the vault.
Sensitive destination appears in UIRedact config display and rotate the destination if leaked.
Alerts are noisyTune event thresholds before muting the channel.
Incident alert is missingCheck audit logs and notification-channel binding first.

API Reference

EndpointMethodDescription
/api/v1/vaults/{chain_id}/{vault_address}GETFull vault detail including fee, PPS, and upkeep data
/api/v1/settings/fee-configGETRead current fee config
/api/v1/settings/fee-config/proposePOSTPrepare fee-config proposal transaction
/api/v1/settings/fee-config/executePOSTPrepare fee-config execution transaction
/api/v1/settings/deviation-thresholdGETRead PPS deviation threshold
/api/v1/settings/deviation-threshold/updatePOSTPrepare deviation-threshold update transaction
/api/v1/settings/pps-expirationGETRead PPS expiration / staleness setting
/api/v1/settings/pps-expiration/proposePOSTPrepare PPS-expiration proposal transaction
/api/v1/settings/pps-expiration/executePOSTPrepare PPS-expiration execution transaction
/api/v1/settings/pps-expiration/cancelPOSTPrepare PPS-expiration cancellation transaction
/api/v1/settings/redeem-timelockGET/PUT/DELETERead, update, or remove redeem timelock
/api/v1/settings/banned-hook-leavesGETRead banned hook leaves
/api/v1/settings/banned-hook-leaves/updatePOSTPrepare banned-hook-leaf update transaction
/api/v1/settings/min-update-intervalGETRead minimum PPS update interval
/api/v1/settings/min-update-interval/proposePOSTPrepare min-update-interval proposal transaction
/api/v1/settings/min-update-interval/executePOSTPrepare min-update-interval execution transaction
/api/v1/settings/min-update-interval/cancelPOSTPrepare min-update-interval cancellation transaction
/api/v1/settings/upkeepGET/POSTRead or prepare upkeep settings update
/api/v1/settings/upkeep/depositPOSTPrepare upkeep deposit
/api/v1/settings/upkeep/withdraw/proposePOSTPrepare upkeep withdrawal proposal
/api/v1/settings/upkeep/withdraw/executePOSTPrepare upkeep withdrawal execution