Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vaulkyrie.xyz/llms.txt

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

Vaulkyrie is not audited yet. Use these commands for development, review, and test environments only.

​
Browser wallet

npm install
npm run dev
npm run build
npm run lint
The browser wallet scripts come from package.json:
ScriptPurpose
npm run devStarts the Vite development server.
npm run buildRuns TypeScript project build and Vite production build.
npm run lintRuns ESLint across the browser wallet source.
npm run previewServes the built Vite output.

​
Relay server

cd relay-server
npm install
npm run build
npm run dev
The relay server scripts come from relay-server/package.json:
ScriptPurpose
npm run devRuns tsx watch src/server.ts.
npm run buildCompiles the relay server TypeScript.
npm startRuns the compiled server from dist/server.js.

​
Rust workspace

Run these from the Rust workspace root. 
cargo build --workspace
cargo test --workspace
cargo fmt --all --check
The workspace contains:
  • crates/vaulkyrie-cli
  • crates/vaulkyrie-frost
  • crates/vaulkyrie-frost-wasm
  • crates/vaulkyrie-protocol
  • crates/vaulkyrie-sdk
  • programs/vaulkyrie-core

​
Docs site

Run these from the Mintlify docs repository if you are contributing to documentation. 
npm i -g mint
mint validate
mint dev
The hosted documentation is available at https://vaulkyrie.mintlify.app/.