diff options
| author | Antoine A <> | 2022-03-03 14:27:31 +0100 |
|---|---|---|
| committer | Antoine A <> | 2022-03-03 14:27:31 +0100 |
| commit | 1e93728aebe96095dde1848e303f07fe9a22daf6 (patch) | |
| tree | d9fde97fa49061512ff806424ee3eb2bf9c2ee27 /btc-wire | |
| parent | ee9c60847a8e4aa7daecb588c2f723b6bf272fe6 (diff) | |
| download | depolymerization-1e93728aebe96095dde1848e303f07fe9a22daf6.tar.gz depolymerization-1e93728aebe96095dde1848e303f07fe9a22daf6.tar.bz2 depolymerization-1e93728aebe96095dde1848e303f07fe9a22daf6.zip | |
Improve documentation
Diffstat (limited to 'btc-wire')
| -rw-r--r-- | btc-wire/README.md | 59 |
1 files changed, 12 insertions, 47 deletions
diff --git a/btc-wire/README.md b/btc-wire/README.md index d9d7a95..c887fd4 100644 --- a/btc-wire/README.md +++ b/btc-wire/README.md @@ -1,44 +1,7 @@ # btc-wire -btc-wire is taler wire adapter for [bitcoincore](https://bitcoincore.org/en/about/) node - -## Bitcoincore compatibility - -Bitcoind version 22.* is required - -## Install - -`cargo install --path btc-wire` - -## Configuration - -### taler.conf - -The configuration is based on [taler.conf](https://docs.taler.net/manpages/taler.conf.5.html) - -``` ini -# taler.conf - btc-wire default config -[depolymerizer-bitcoin] -DATA_DIR = -CONFIRMATION = 6 -BOUNCE_FEE = BTC:0.00001 -``` - -### bitcoin.conf - -btc-wire will automatically read the bitcoin configuration file to connect to -the RPC server, `txindex=1` and `maxtxfee` are mandatory. - -## Getting Started - -1. Write configuration files -2. Start bitcoind -3. Start PostgreSQL -4. Initialize database `btc-wire initdb` -5. Initialize wallet `btc-wire initwallet` -6. Update configuration files with wallet info -7. Run wire-gateway `wire-gateway` -8. Run btc-wire `btc-wire` +btc-wire is taler wire adapter for +[bitcoincore](https://bitcoincore.org/en/about/) node ## Deposit metadata format @@ -47,17 +10,17 @@ addresses to encode the reserve public key as metadata into a common bitcoin transaction. A single segwit address can contain 20B of chosen data and the reserve pub key -is 32B. We use two fake adresses consisting of the two key half prepended -with the same random pattern, at the exception of the first bit with must be 0 -for the first half and 1 for the second one. You must then send a single -transaction with the three addresses as recipients. +is 32B. We use two fake adresses consisting of the two key half prepended with +the same random pattern, at the exception of the first bit with must be 0 for +the first half and 1 for the second one. You must then send a single transaction +with the three addresses as recipients. -Segwit addresses are encoded using a bitcoin specific format: +Segwit addresses are encoded using a bitcoin specific format: [bech32](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) As a few lines of code can carry more meaning that many words, you can find a [simple rust example](src/bin/segwit-demo.rs) in this project and run it with -`make segwit_demo`. +`make segwit_demo`. ``` Ⅰ - Parse payto uri @@ -100,5 +63,7 @@ Make sure the amount show 0.10000588 BTC, else you have to change the base unit ### Stuck transaction -We resolve stuck transaction by always sending replaceable transaction -using [BIP 125](https://github.com/bitcoin/bips/blob/master/bip-0125.mediawiki).
\ No newline at end of file +We resolve stuck transaction by always sending replaceable transaction using +[BIP 125](https://github.com/bitcoin/bips/blob/master/bip-0125.mediawiki). + +TODO |