FlowVault Technical Documentation

Deployment

Repeatable deployment runbook for contracts, frontend, and docs with validation checkpoints at each stage.

Preflight

  • Confirm target network: testnet or mainnet.
  • Verify deployer wallet has enough STX for contract fees.
  • Run all local tests in contracts and SDK before deploy.
  • Prepare updated env vars for frontend and demo app.

Contracts

cd flowvault-contracts
clarinet deployments generate --testnet --medium-cost
clarinet deployments apply --testnet

After deployment, store resulting principal identifiers in your release notes. These identifiers are runtime dependencies for every client build.

Frontend

cd flowvault-frontend
npm install
npm run build

Ensure these are set in deployment environment:NEXT_PUBLIC_FLOWVAULT_CONTRACT_ADDRESS,NEXT_PUBLIC_FLOWVAULT_CONTRACT_NAME,NEXT_PUBLIC_FLOWVAULT_TOKEN_CONTRACT_ADDRESS, andNEXT_PUBLIC_FLOWVAULT_TOKEN_CONTRACT_NAME.

Docs Host (docs.flow-vault.dev)

cd flowvault-docs
npm install
npm run build

Deploy the built app to your host and map docs.flow-vault.dev as a custom domain.

Tagged Release (Core Routing Patterns)

Create a release tag after validating the three core behaviors:time-lock, split, and hold.

# 1) ensure main is up to date
git checkout main
git pull origin main

# 2) verify contracts + sdk tests
cd flowvault-contracts && npm test
cd ../flowvault-sdk && npm test

# 3) create annotated tag
git tag -a v0.2.0 -m "FlowVault core routing release: time-lock, split, hold"

# 4) push branch + tag
git push origin main
git push origin v0.2.0
Recommended release notes: include tested scenarios, contract principal, SDK version, and any migration instructions.

Verification

  1. Open frontend and connect wallet.
  2. Call read methods and confirm no network or parsing errors.
  3. Create a small deposit and inspect tx result in explorer.
  4. Check docs routes for all pages and active sidebar state.
  5. Record release version, commit hash, and deployed contract principal.