https://github.com/bitceptron/retriever

A utility crate to scan the utxo set for bitcoins locked in scripts built by custom derivation paths.
https://github.com/bitceptron/retriever

Last synced: 2 days ago
JSON representation

A utility crate to scan the utxo set for bitcoins locked in scripts built by custom derivation paths.

• Host: GitHub
• URL: https://github.com/bitceptron/retriever
• Owner: bitceptron
• Created: 2024-05-06T13:02:59.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-30T07:12:00.000Z (6 months ago)
• Last Synced: 2024-11-15T03:35:42.823Z (2 days ago)
• Language: Rust
• Homepage:
• Size: 5.99 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# bitceptron retriever

This is part of the bitceptron product suite. A utility crate to scan the utxo set for bitcoins locked in scripts built by custom derivation paths.

## WIP notice

***Please note that this is a work in progress at the moment and breaking changes might happen.***

***NOT PRODUCTION READY YET.***

### About

Various wallets using different BIP32 derivation paths can be a problem for bitcoiners. In some cases, this might lead to confusion or a perception of loss of bitcoins, when incompatible wallets are used for receiving bitcoins and retrieving them in a later time. Bitceptron retriever is to alleviate that problem to some extent.

Bitceptron retriever uses the txout dump of bitcoincore to scan the utxo set for various descriptors derivable from your mnemonic and passphrase. We use miniscript to create the following single key descriptors:

1. P2PK.

2. P2PKH.

3. P2SHWPKH.

4. P2WPKH.

5. P2TR (Single key path spending without a script tree).

### Future steps

We plan to:

1. Build a GUI.

2. Add async support for faster preparation. [Done in v1.0.0]

3. Add support for multisigs.

4. Optimize the txoutset crate for retriever's specific use case of the dump file.

5. Add more documentation.

6. Increase test coverage.

7. Improve error messages.

8. Add tracing. [Done in v1.0.0]

9. Add CI/CD.

### Usage

`bitceptron-retriever-cli` provides a cli tool to use this crate. Please refer to  for instructions.

## Epilogue

Happy rusting plebs.