Skip to content

Latest commit

 

History

History
163 lines (134 loc) · 11 KB

README.md

File metadata and controls

163 lines (134 loc) · 11 KB

BTCRecover

Last Push - All Tests (Base Modules) Weekly - All Tests (Base Modules) Weekly Run All Tests (Base Modules) Documentation Status license

BTCRecover is an open source wallet password and seed recovery tool.

For seed based recovery, this is primarily useful in situations where you have lost/forgotten parts of your mnemonic, or have made an error transcribing it. (So you are either seeing an empty wallet or getting an error that your seed is invalid)

For wallet password or passphrase recovery, it is primarily useful if you have a reasonable idea about what your password might be.

Documentation:

Instructions for installation, usage & examples: https://btcrecover.readthedocs.io/

(You can also view the documentation in your browser locally by following the instructions here. )

If you need help, your best bet is to look at my BTCRecover playlist on YouTube and ask a question in the comments section for any of video closest to your situation.

Features

  • BIP39 Seed/Passphrase Recovery when for: (Recovery without a known address requires an Address Database)

    • Avalanche
    • Bitcoin
    • Bitcoin Cash
    • Cardano (Shelley Era Addresses)
    • Cosmos (Atom)
    • Dash
    • DigiByte
    • Dogecoin
    • Ethereum
    • Groestlcoin
    • Helium
    • Litecoin
    • Monacoin
    • Polkadot (sr25519, like those produced by polkadot.js)
    • Ripple
    • Secret Network
    • Solana
    • Stacks
    • Stellar
    • Tezos
    • Tron
    • Vertcoin
    • Zilliqa
    • And many other 'Bitcoin Like' cryptos
  • SLIP39 Passphrase Recovery for most coins supported by the Trezor T

    • Bitcoin
    • Bitcoin Cash
    • Dash
    • Digibyte
    • Dogecoin
    • Ethereum
    • Litecoin
    • Ripple
    • Vertcoin
  • Descrambling 12 word seeds (Using Tokenlist feature for BIP39 seeds via seedrecover.py)

  • Wallet File password recovery for a range of wallets

  • Seed Phrase (Mnemonic) Recovery for the following wallets

  • Bitcoin wallet password recovery support for:

  • Altcoin password recovery support for most wallets derived from one of those above, including:

  • Free and Open Source - anyone can download, inspect, use, and redistribute this software

  • Supported on Windows, Linux, and OS X

  • Support for Unicode passwords and seeds

  • Multithreaded searches, with user-selectable thread count

  • Ability to spread search workload over multiple devices

  • GPU acceleration for Bitcoin Core Passwords, Blockchain.com (Main and Second Password), Electrum Passwords + BIP39 and Electrum Seeds

  • Wildcard expansion for passwords

  • Typo simulation for passwords and seeds

  • Progress bar and ETA display (at the command line)

  • Optional autosave - interrupt and continue password recoveries without losing progress

  • Automated seed recovery with a simple graphical user interface

  • Ability to search multiple derivation paths simultaneously for a given seed via --pathlist command (example pathlist files in the )

  • “Offline” mode for nearly all supported wallets - use one of the extract scripts (click for more information) to extract just enough information to attempt password recovery, without giving btcrecover or whoever runs it access to any of the addresses or private keys in your Bitcoin wallet.

Setup and Usage Tutorials

BTCRecover is a Python (3.7, 3.8, 3.9, 3.10) script so will run on Windows, Linux and Mac environments. See the installation guide for more info

I have created a growing playlist that covers a number of usage examples for using this tool to recover seed phrases, BIP39 passphrases, etc.

This repository also included some example commands and file templates in the ./docs/ folder of the repository.

My suggestion is that you find a scenario that is most-like your situation and try to replicate my examples to ensure that you have the tool set up and running correctly. If you have a specific situation that isn't covered in these tutorials, let me know and I can look into creating a video for that.

If you don't know an address in the wallet that you are searching for, you can create and use an Address Database (click here for guide) There is no real performance penalty for doing this, it just takes a bit more work to set up.

Quick Start

To try recovering your password or a BIP39 passphrase, please start with the Password Recovery Quick Start.

If you mostly know your recovery seed/mnemonic (12-24 recovery words), but think there may be a mistake in it, please see the Seed Recovery Quick Start.

If this tool or other content on my YouTube channel was helpful, feel free to send a tip to:

Donate Bitcoin

BTC: 37N7B7sdHahCXTcMJgEnHz7YmiR4bEqCrS

Donate Bitcoin Cash

BCH: qpvjee5vwwsv78xc28kwgd3m9mnn5adargxd94kmrt

Donate Litecoin

LTC: M966MQte7agAzdCZe5ssHo7g9VriwXgyqM

Donate Ethereum

ETH: 0x72343f2806428dbbc2C11a83A1844912184b4243

Thanks to Gurnec

This tool builds on the original work of Gurnec who created it and maintained it until late 2017. If you find btcrecover helpful, please consider a small donation to them too. (I will also be passing on a portion of any tips I recieve at the addys above to them too)

Donate Bitcoin

BTC: 3Au8ZodNHPei7MQiSVAWb7NB2yqsb48GW4

Thank You!