Skip to content

Latest commit

Β 

History

158 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

xKey - Offline Web3 Wallet Vault

NOT YOUR KEY, NOT YOUR CRYPTO

A private, offline-first cold vault for wallet records, private keys, seed phrases, encrypted backups, Shamir QR recovery, local audit history, and offline vanity wallet generation.

GitHub Release License Android Build Status


Current Release: v6.0.33

xKey v6.0.33 is the current synchronized web and Android release. This release updates the app version metadata, Android build metadata, documentation, and release automation notes used for GitHub Releases.

What's New

  • ✨ Corrected vanity wallet metadata and compact address highlighting.
  • 🏷️ Improved score labels and reasons for lucky, numeric-tail, and low-diversity patterns.
  • πŸ”€ Made vanity selection, saving, deletion, and restore handling address-case insensitive.
  • ⚑ Unified sorting and Set-based deduplication across the main thread and worker.
  • βœ… Added regression coverage for highlighting, scoring, metadata, and mixed-case addresses.
  • Android release metadata: versionName 6.0.33, versionCode 131.

Core Features

Security and Privacy

  • Offline encrypted local vault for wallet records and secret material.
  • Android Device Credential and Android Keystore integration where supported.
  • Optional privacy masking, explicit reveal/copy actions, hold-to-reveal secret viewing, clipboard safety flows, auto-lock, decoy vault, screen-capture controls, and local audit history.
  • Encrypted portable .xkey backups with verification flows.
  • Shamir Secret Sharing QR recovery for offline recovery workflows.
  • No custody server, no cloud sync requirement, and no telemetry requirement.

Wallet and Data Management

  • Wallet folders, tags, search, combined filter/sort panel, batch actions, pinning, manual balances, and configurable wallet density.
  • QR display/share workflows and CSV import/export.
  • Drag wallets into folders on desktop layouts.
  • Mobile swipe affordances for common wallet-card actions.
  • Multi-language UI: ar, de, en, es, fr, hi, id, ja, ko, pt, ru, th, tr, vi, zh.

Offline Vanity Wallet Generation

  • Offline vanity address scanning with CPU/heat warnings.
  • Generated private keys and seed phrases are hidden until explicitly revealed.
  • Supports individual saves, bulk saves, folder routing, and bounded reserve limits.

Project Structure

xKey/
β”œβ”€ android/                    Capacitor Android project and Gradle release metadata
β”œβ”€ assets/                     Project assets
β”œβ”€ icons/                      Icon sources
β”œβ”€ public/                     Static web assets
β”œβ”€ scripts/                    Maintenance and audit scripts
β”œβ”€ src/
β”‚  β”œβ”€ app/                     App constants and shared app-level contracts
β”‚  β”œβ”€ components/              Feature and reusable React UI components
β”‚  β”‚  β”œβ”€ auth/                 Unlock, onboarding, and auth error screens
β”‚  β”‚  β”œβ”€ backup/               Backup export/import UI
β”‚  β”‚  β”œβ”€ create-wallet/        Create/import/vanity wallet feature module
β”‚  β”‚  β”œβ”€ entropy/              Advanced entropy and derivation panels
β”‚  β”‚  β”œβ”€ qr/                   QR scanner/display/transfer components
β”‚  β”‚  β”œβ”€ settings/             Settings tabs and security/data panels
β”‚  β”‚  β”œβ”€ shamir/               Shamir backup/restore UI
β”‚  β”‚  β”œβ”€ shared/               Shared UI helpers
β”‚  β”‚  β”œβ”€ vanity/               Vanity score UI
β”‚  β”‚  └─ wallet/               Wallet cards, lists, sorting, swipe/drop UX
β”‚  β”œβ”€ contexts/                Theme, language, toast, confirm, vault contexts
β”‚  β”œβ”€ hooks/                   App, security, backup, vanity, and wallet hooks
β”‚  β”œβ”€ locales/                 Localized strings
β”‚  β”œβ”€ utils/                   Storage, crypto, audit, amount, wallet utilities
β”‚  └─ types.ts                 Core TypeScript models
β”œβ”€ tests/                      Focused tests and smoke/regression specs
β”œβ”€ capacitor.config.ts         Capacitor app configuration
β”œβ”€ package.json                Web app scripts and version
└─ vite.config.ts              Vite build configuration

Local instruction/scratch folder 1/ is intentionally ignored and must not be pushed.


Build and Verify

npm install
npm run type-check
npm run build
npx cap sync android

Additional focused checks:

npm run test
npm run locale:audit
npm run test:smoke

Android release builds are triggered by git tags matching v*.


Store Listing Copy

Short description:

Offline wallet vault. NOT YOUR KEY, NOT YOUR CRYPTO.

Long description opener:

xKey is an offline-first Web3 wallet vault for people who want direct local control of wallet keys, encrypted backups, local audit history, Shamir QR recovery, privacy masking, and advanced offline vanity wallet generation. NOT YOUR KEY, NOT YOUR CRYPTO.

Older Release Summary

Older details are intentionally summarized here; see CHANGELOG.md for the compact history.

  • v5.22.0: release metadata update before the mobile layout polish pass.
  • v5.21.9: privacy mode, wallet card, dashboard, empty-state, folder drag/drop, and transition polish.
  • v5.21.x: DPI, branding, vanity, duplicate detector, and security polish releases.

About

πŸ›‘οΈ xKey: 100% offline EVM wallet creation & backup. Air-gapped security for absolute asset control. NOT YOUR KEY, NOT YOUR CRYPTO! πŸš€πŸ”

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages