Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aureleoules/bitcarve
⛏️ carve data on the Bitcoin network forever
https://github.com/aureleoules/bitcarve
bitcoin
Last synced: 3 days ago
JSON representation
⛏️ carve data on the Bitcoin network forever
- Host: GitHub
- URL: https://github.com/aureleoules/bitcarve
- Owner: aureleoules
- Created: 2020-04-08T21:54:30.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-04-09T23:15:27.000Z (over 4 years ago)
- Last Synced: 2023-03-03T13:02:17.016Z (over 1 year ago)
- Topics: bitcoin
- Language: Go
- Homepage:
- Size: 16.6 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BitCarve
BitCarve allows your to carve any type of data on the Bitcoin network **forever**.
[8cf28eb9ac221d8cd15298b9ae63eca910b536a5234c133c7e364b29a4e39d21](https://www.blockchain.com/btc/tx/8cf28eb9ac221d8cd15298b9ae63eca910b536a5234c133c7e364b29a4e39d21)
## Get started
**Disclaimer**: To avoid data corruption, there can be no change of the UTXO. You will lose the whole amount in the UTXO.
```bash
$ go build
# Carve data
$ ./bitcarve \
--file image.jpg \
--network main \
--amount 546 \ # minimum on main is 546 sats/output
--fee 1 \
--utxo your_utxo_id \
--key your_private_key
Successfully carved data on the Bitcoin network.
TxID: 8cf28eb9ac221d8cd15298b9ae63eca910b536a5234c133c7e364b29a4e39d21
# Decrypt data
$ ./bitcarve \
--decrypt \
--txid 8cf28eb9ac221d8cd15298b9ae63eca910b536a5234c133c7e364b29a4e39d21 \
--output myimage.jpg
Retrieved data.
```
### Docker
```bash
$ docker build --tag bitcarve .
$ docker run -it bitcarve \
--file image.jpg \
--network testnet \
--amount 1 \
--fee 1 \
--utxo your_utxo_id \
--key your_private_key
Successfully carved data on the Bitcoin network.
TxID: 8cf28eb9ac221d8cd15298b9ae63eca910b536a5234c133c7e364b29a4e39d21
```
## Requirements
* Go
* bitcoin-daemon and bitcoin-cli (chain data is not required)
## Arguments
### Carve
* **--utxo**: UTXO ID
* **--file**: File to carve
* **--key**: Private key to sign TX
* --network: main/testnet
default=main
* --amount: amount to send to each address
default=1 sat
* --fee: Fee sats/byte
default=1 sat
* --vout: Position in the UTXO
default=0
## Decrypt
* **--decrypt**
* **--txid**: TX storing data
* --output: data output
default=./output
## How it works
To store large files (kilobytes) on the Bitcoin network, the `OP_RETURN` cannot be used because of its 40 bytes limit.
Instead, `bitcarve` stores data in tx output addresses. Each address can store 20 bytes of data, 1 version byte, and 4 bytes of checksum.
Your file is split into chunks of 20 bytes, hashed to compute a checksum, versionned and converted to base58 in order to produce valid Bitcoin addresses.
Each address is added to the bitcoin transaction with 546 sats (main net requirement) (0.00000546 BTC).
The transaction can be signed and broadcast to the network.
Your data is now stored forever on Bitcoin.
## License
MIT