Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/natureloved/DeadMan-Vault/llms.txt

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

The Deadman Vault dashboard is your command centre for everything related to your vaults. It pulls every vault owned by your connected wallet address from GET /api/vaults?address={ownerAddress}, groups them by urgency, and surfaces the information you need to act: which vaults are healthy, which need a check-in soon, and which have already triggered. From here you can navigate to individual vault status pages, kick off a heartbeat check-in, or create a new vault — all without losing context.

​
Accessing the dashboard

Navigate to /dashboard with your Stacks wallet connected. If no wallet session is active, the page shows a Connect Wallet button. Once connected, vaults are fetched automatically and the page refreshes without a reload. The connected address is displayed in the header as a truncated monospaced string alongside the STACKS TESTNET label.

​
Summary stats

When you have at least one vault, four stat tiles appear at the top of the dashboard:
TileValue
Total VaultsAll vaults owned by your address
WatchingVaults with status active, warning, or grace_period
Needs AttentionVaults with status warning, grace_period, or funding — highlighted in amber when non-zero
USDCx LockedSum of totalDeposited across all your vaults

​
Vault sections

Vaults are organised into three named sections based on their current status:
SectionStatuses includedHint
Needs Attentiongrace_period, warning, fundingCheck in soon or finish setup
ActiveactiveHealthy and watching
Resolvedtriggered, claimedSuccession already ran, or fully paid out
Within the Needs Attention section, vaults are sorted so the most critical (grace_period) appear first.

​
VaultCard

Each vault is rendered as a VaultCard component showing:
  • Vault name (or “Unnamed Vault” if none was set)
  • Status badge — a monospaced pill showing the vault’s current state. The exact badge text for each status is:
    Database statusBadge label
    fundingAWAITING DEPOSIT
    activeALIVE
    warningCHECK IN SOON
    grace_periodCRITICAL
    triggeredFLATLINED
    claimedPAID OUT
  • USDCx locked — the total totalDeposited amount for that vault
  • Deadline countdown — for active/warning/grace_period vaults: a progress bar and a Xd until next check-in deadline label derived from the current block height
  • Action buttons — a coloured Heartbeat button (shown for active, warning, and grace_period vaults) that navigates to /heartbeat?vaultId=[id], and a View Status button that navigates to the /status/[vaultId] detail page

​
Live block-height countdown

The time remaining shown on each vault card is not clock-based — it is derived from on-chain data: 
blocksRemaining = deadlineBlock − currentBlock
timeRemaining   = blocksRemaining × ~10 minutes/block
The current block height is fetched from the Hiro Stacks API. Because Stacks block times average approximately 10 minutes (with natural variance), the displayed countdown is an estimate, not a guarantee. Always check in with meaningful buffer time rather than waiting until the countdown reaches zero.
If a vault card shows CHECK IN SOON or CRITICAL, click its Heartbeat button to navigate to /heartbeat?vaultId=[id] immediately. The WARNING_BLOCKS threshold is 432 blocks (~3 days) before the deadline; GRACE_PERIOD_BLOCKS is 288 blocks (~2 days) after the deadline expires.

​
Vault status detail page

Each vault has a dedicated status page at /status/[vaultId]. This page is publicly accessible (no wallet required to view) and shows:
  • Vault name, owner address, and total deposited
  • Current block and deadline block with the BlockCounter component
  • DeadmanAnimation reflecting the current status
  • Full beneficiary list with allocation percentages
  • Owner’s optional message to beneficiaries
  • On-Chain Activity log: every heartbeat event with block height, timestamp, and explorer link, plus the initial vault creation transaction
The status page is useful for both vault owners checking their history and beneficiaries monitoring a vault before it triggers.

​
API query

The dashboard fetches vault data with a single authenticated request: 
GET /api/vaults?address={ownerAddress}
The response is an array of vault rows. Each row includes id, vaultName, status, totalDeposited, heartbeatIntervalDays, heartbeatDeadlineBlock, currentBlock, and txId. The dashboard re-fetches on page focus and whenever the connected wallet address changes.

Create a Vault

Lock USDCx, set a heartbeat interval, and register your beneficiaries.

Check In

Sign a 0.01 USDCx heartbeat transfer to extend your vault’s deadline.

Build docs developers (and LLMs) love

Get started for freeTalk to us