Documentation

How Vault Brief works

Short, scannable reference for founders. Wallet sync, monthly cadence, investor distribution, plan limits — everything you need to know before you ship your first report.

What Vault Brief does

Vault Brief generates monthly investor reports for Web3 teams from on-chain data and GitHub activity. You connect treasury wallets, a GitHub org, and your project context once. Every month the system pulls a snapshot, drafts a narrative, and lets you review and send a polished PDF to investors.

The product is read-only. It never asks for private keys, seed phrases, or signing permissions. Wallets are identified by public addresses; balances and transactions come from RPC providers (Alchemy, Dune Sim, Helius).

Data sources

  • Treasury balances and flows — Alchemy, Dune Sim, and Helius for Solana. Latest balance per token, inflows and outflows during the report period, classified into expense categories (payroll, infra, marketing, grants, legal, token sale).
  • Token metrics — CoinGecko (price, market cap, holders) with CoinMarketCap as a fallback if your token is not listed on CG.
  • GitHub activity — GitHub REST API. Commits, merged PRs, active contributors, releases. Repos are capped at the top 25 by recent push activity to keep within rate limits.
  • Governance proposals — Snapshot.org for projects that operate a DAO space.
  • Project context— founder-entered milestones, asks, partner intros, last funding round. These power the executive summary and “Looking ahead” sections.

Connecting wallets

From /projects/new, paste a treasury wallet address (EVM or Solana) and pick the chain. That's it — no signature prompt, no extension hookup. You can add more wallets later under /projects/[id]/wallets.

Supported chains: Ethereum, Optimism, Arbitrum, Base, Polygon, Scroll, Linea, zkSync Era, Avalanche, BNB Chain, Gnosis, Celo, Fantom, Mantle, Blast, and Solana — plus L2s that share Alchemy coverage.

Multisigs (Safe, Squads) work the same way — treat the multisig contract address as a treasury wallet.

Generating your first report

  1. Create a project and add at least one wallet. If you have a token contract, fill it in — we'll prefill description, website, GitHub, and token symbol from CoinGecko.
  2. From the project dashboard, click Sync data. The system pulls a fresh snapshot and auto-generates a draft report based on it. This takes 5–30 seconds depending on the wallet count.
  3. Review the report on /projects/[id]/reports/[reportId]. Every number is validated against the source snapshot at generation time — no fabricated figures — but you can still edit the markdown narrative inline.
  4. When the report reads correctly, click Send. The investor distribution drawer lets you pick recipients, attach a PDF, and ship it via Resend. Open and click events flow back into the dashboard.

Monthly auto-sync and report

Two scheduled jobs run on Trigger.dev once your project is active:

  • 1st of every month, 06:00 UTC — snapshot all active projects (balances, flows, GitHub, token metrics).
  • 3rd of every month, 08:00 UTC— draft a report for each project that has a fresh snapshot and no report for the current period. You get an email (“Report ready for review”) with a one-click link to the draft. Nothing is sent to investors automatically.

You can also click Sync data any time from the dashboard — useful for ad-hoc investor updates or testing. On-demand syncs are rate-limited per project.

Sharing reports with investors

When you send a report, each investor gets a personalized email with a link to the public view at /r/[reportId]. The link works without an account — investors don't sign up for anything.

Status of the report is gated on the public route. A report has to be flipped to sent before /r/[id] renders it. Drafts stay private inside your account.

Open and click events are tracked back to the report row in your dashboard, so you can see who looked at the latest update.

Plan limits

Quotas are enforced server-side on every mutation:

  • Trial (14 days, automatic on signup) — same quota as Seed. Generates real reports against your own data.
  • Seed ($99/mo) — 1 project, up to 5 treasury wallets, 1 GitHub org.
  • Growth ($299/mo) — up to 3 projects, 10 wallets, 5 GitHub repos, token metrics, custom branding.
  • Custom (contact) — up to 30 projects, unlimited wallets, white-label exports, dedicated support.

Plan changes take effect immediately. Reports generated under a higher tier remain accessible if you downgrade.

Need help or want a feature?

Email hello@vaultbrief.io — typical response within one business day. For security issues, use security@vaultbrief.io. For API access (read-only endpoints for projects, snapshots, reports), we're building it now — drop us a line to be on the early-access list.