privacy-pump-types

Maturity: Experimental library
Supported network: Network-independent
Audit status: Publication is not an audit. No external audit is claimed.

Canonical Rust, TypeScript, and schema definitions for Privacy Pump protocol messages.

Purpose

Provides pure versioned protocol types without server, database, session, key-loading, or browser-persistence behavior.

Scope

• Rust types
• TypeScript types
• JSON Schemas and round-trip tests

Architecture

flowchart LR
  User[Wallet or integrator] --> Interface[Public interface]
  Interface --> Boundary[Privacy Pump trust boundary]
  Boundary --> Chain[Solana or local reference]
  Boundary -. metadata exposure .-> Limits[Documented limitations]

Loading

See ARCHITECTURE.md for component boundaries and assumptions.

Current security status

• Experimental or reference material; not mainnet-ready.
• The inspected devnet programs are upgradeable and shared one upgrade authority at the publication audit date.
• Factory and relayer are distinct protocol roles, but a deployment may configure one signer for both.
• Production signer topology is intentionally not published.
• The ZK Pool vault-creation fee receipt does not independently bind its signer named factory to the Private Vault config factory; that boundary is under review.
• The ZK verifier path is fail-closed by default and is not a complete production privacy system.
• Browser, RPC, relayer, database, Waku/Logos, and Arcium metadata each have separate privacy limitations.
• Custom cryptographic glue is not described as audited.

Read SECURITY.md before using any material.

Dependencies

• privacy-pump-protocol-specs
• privacy-pump-protocol-test-vectors

Local setup

Use deterministic fixtures and ephemeral local keys only. No production credentials, cloud accounts, private RPC endpoints, or real wallet relationships are required.

node scripts/policy-scan.mjs

npm install
npm test
npm run typecheck
cargo fmt --manifest-path rust/Cargo.toml -- --check
cargo test --manifest-path rust/Cargo.toml

The TypeScript and Rust packages are intentionally small and contain protocol types only.

Roadmap

• Stabilize v1 serialization
• Generate schema compatibility report
• Publish package releases after license approval

Related Privacy Pump repositories

• privacy-pump-protocol-specs
• privacy-pump-protocol-test-vectors

Known limitations

• Public content omits production relayer, access-control, KMS, Supabase service-role, keeper-signing, monitoring, and deployment implementations.
• Privacy depends on more than user-interface masking; metadata visible to wallets, RPCs, relayers, transports, and infrastructure remains relevant.
• Interfaces may change while the devnet architecture is stabilized.

Contributing

See CONTRIBUTING.md. Licensing is under review; see LICENSE_STATUS.md.