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.

This page is intentionally conservative. Vaulkyrie is early-stage software and has not completed a formal third-party audit.
Do not treat the current browser wallet, relay server, SDK, CLI, or program as production-ready custody software. Use test funds and development environments until audits, deployment hardening, versioned releases, and public package distribution are complete.

Current status

AreaReady for internal useReady for public external developersNotes
Browser walletYesNot yetApp builds from source; Chrome Web Store packaging and production relay deployment are still required.
Relay serverYesNot yetWorks as a private server; production hosting, TLS, monitoring, rate limits, and operational runbooks are still required.
Rust SDKYesNot yetWorkspace API exists; crate publication to crates.io is still required.
CLIYesNot yetLocal developer CLI exists; installable releases and binary distribution are still required.
TypeScript SDKYesNot yet@vaulkyrie/sdk workspace package builds locally; npm publication and parity tests are still required.
Solana programSource existsDeployment-sensitiveDo not change instruction layouts casually because redeployment and client compatibility are involved.

Publication checklist

Before public use, Vaulkyrie should complete:
  • Independent security audit for wallet, relay, SDK, and on-chain code.
  • Published npm package for the TypeScript SDK.
  • Published crates.io packages for Rust SDK and CLI.
  • Hosted wss:// relay endpoint with TLS, monitoring, rate limits, and abuse controls.
  • Chrome Web Store packaging, privacy policy, support URL, screenshots, and release process.
  • Versioned release notes and compatibility policy for SDK, CLI, extension, relay, and program.

Verification commands

Use these checks after code changes:
npm run build
npm run lint
cd relay-server
npm run build
cargo test --workspace
cargo fmt --all --check

Public documentation policy

Public examples should distinguish between released packages and local development commands. Until npm and crates.io releases are published, install commands are shown as intended release paths rather than live availability claims.