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.

The Rust SDK and CLI are implemented in the Rust workspace.

​
Rust SDK

Source: crates/vaulkyrie-sdk/src/ The SDK includes:
  • Instruction builders in instruction.rs
  • PDA helpers in pda.rs
  • Account decoders in accounts.rs
  • Error decoding in error.rs
  • Shared types in types.rs
  • Optional FROST helper exports in frost.rs

​
Instruction builder coverage

crates/vaulkyrie-sdk/src/instruction.rs currently exposes builders for:
  • ping
  • init_vault
  • init_authority
  • init_quantum_vault
  • init_pqc_wallet
  • set_vault_status
  • rotate_authority
  • init_authority_proof
  • write_authority_proof_chunk
  • rotate_authority_staged
  • advance_winter_authority
  • split_quantum_vault
  • close_quantum_vault
  • advance_pqc_wallet
  • init_spend_orchestration
  • commit_spend_orchestration
  • complete_spend_orchestration
  • fail_spend_orchestration
  • init_recovery
  • complete_recovery
  • migrate_authority

​
Example: PDA derivation and instruction building

use vaulkyrie_sdk::{instruction, pda, Pubkey};

let program_id = Pubkey::from([1u8; 32]);
let wallet_pubkey = Pubkey::from([2u8; 32]);
let (vault_registry, bump) = pda::find_vault_registry(&wallet_pubkey, &program_id);

let ix = instruction::init_vault(
    &program_id,
    &vault_registry,
    &wallet_pubkey,
    wallet_pubkey.to_bytes(),
    [9u8; 32],
    bump,
);

​
CLI

Source: crates/vaulkyrie-cli/src/ The CLI binary is named vaulkyrie. It is a workspace CLI, not currently documented as a published installer. Command groups:
GroupSourcePurpose
vaultcmd/vault.rsVault lifecycle instruction JSON.
dkgcmd/dkg.rsFROST harness signing, custom signing, legacy message signing, share refresh.
authoritycmd/authority.rsAuthority init, rotation, staged proof helpers.
quantumcmd/quantum.rsQuantum vault and PQC wallet instruction JSON.
spendcmd/spend.rsSpend orchestration init, commit, complete, fail.
recoverycmd/recovery.rsRecovery instruction JSON.
pdacmd/pda.rsPDA derivation.
inspectcmd/inspect.rsInspect account data.
decodecmd/decode.rsDecode errors, instruction data, or account bytes.
pingcmd/mod.rsNo-op program health instruction.

​
Example: run FROST harness

cargo run -p vaulkyrie-cli -- dkg sign --message 68656c6c6f

​
Example: derive a PQC wallet PDA

cargo run -p vaulkyrie-cli -- pda pqc-wallet \
  --program-id <PROGRAM_ID> \
  --wallet-id <32_BYTE_HEX_WALLET_ID>

​
Example: build PQC advance instruction JSON

cargo run -p vaulkyrie-cli -- quantum advance-pqc-wallet \
  --program-id <PROGRAM_ID> \
  --wallet <PQC_WALLET_PDA> \
  --destination <DESTINATION_PUBKEY> \
  --signature <SIGNATURE_HEX> \
  --next-root <32_BYTE_HEX_NEXT_ROOT> \
  --amount 1000000

​
Readiness

SurfaceAssessment
Rust SDKUsable inside the workspace and structurally complete for current vaulkyrie-core instruction builders. Not currently presented as a published crates.io API.
CLIUsable for local development, harnesses, PDA derivation, decoding, and instruction JSON. Not yet a polished public CLI distribution with installers, shell completions, or end-to-end transaction submission UX.
TestsWorkspace tests exist and cover SDK serialization, PDA derivation, FROST harnesses, and program lifecycle logic.