diff options
author | Antoine A <> | 2022-05-06 17:33:00 +0200 |
---|---|---|
committer | Antoine A <> | 2022-05-06 17:33:00 +0200 |
commit | 4cf9dd00afa1e701da415bc2cdad7518bac03c17 (patch) | |
tree | 7296cc146ad8cee4bde52a8970691e461e061b1c | |
parent | 501b0cf2cde97b394552a0d3fdacb22b9eefefd3 (diff) | |
download | depolymerization-4cf9dd00afa1e701da415bc2cdad7518bac03c17.tar.gz depolymerization-4cf9dd00afa1e701da415bc2cdad7518bac03c17.tar.bz2 depolymerization-4cf9dd00afa1e701da415bc2cdad7518bac03c17.zip |
typo
-rw-r--r-- | README.md | 33 | ||||
-rw-r--r-- | btc-wire/README.md | 2 | ||||
-rw-r--r-- | wire-gateway/README.md | 4 |
3 files changed, 19 insertions, 20 deletions
@@ -45,7 +45,7 @@ Depolymerizer require: ### Initialization -We expect you to have already have written a [configuration](#configuration) and +We expect you to already have written a [configuration](#configuration) and that PostgreSQL and the node (bitcoind or geth) is configured and running. We will use `btc-wire` in command, but you can use `eth-wire` interchangeably to @@ -138,7 +138,7 @@ to connect to the RPC server. Two flags are mandatory: - `maxtxfee=?`: bitcoin transactions fees can exceed taler wire fees, putting your wire in bankruptcy. You must specify an acceptable transaction fee cap. -It is also recommanded to disable RPC client timeout with `rpcservertimeout=0` +It is also recommended to disable RPC client timeout with `rpcservertimeout=0` or to set a timeout delay superior than the block delay (e.g `rpcservertimeout=720`) to prevent recurrent "Broken pipe" errors. @@ -208,15 +208,15 @@ BUMP_DELAY = 0 ## Security -Depolymerizer only use an encrypted wallet and provide an easy way to create -them. It is the administrator's responsibility to back up its wallet and +Depolymerizer only use an encrypted wallet and provides an easy way to create +them. It is the administrator's responsibility to back up his wallet and password. -Only the wire adapter need to have the password stored in its environment. +Only the wire adapter needs to have the password stored in its environment. ## Log format -Wire log use an ASCII code for transaction logs: +Wire logs use an ASCII code for transaction logs: - `<<` for a credit - `>>` for a debit @@ -224,21 +224,20 @@ Wire log use an ASCII code for transaction logs: You can have an additional context: -- `bump ` stuck transaction have been bumped -- `conflict ` transaction have been canceled by a conflicting blockchain +- `bump ` a stuck transaction has been bumped +- `conflict ` a transaction has been canceled by a conflicting blockchain transaction -- `recovered ` successful transaction that we failed to register in the local - database have been found in the blockchain -- `onchain ` unknown transaction have been found in the blockchain +- `recovered ` a successful transaction that we failed to register in the local + database has been found in the blockchain +- `onchain ` an unknown transaction has been found in the blockchain ## Test -Instrumentation test documentation can be founded in the -[instrumentation](instrumentation/README.md) directory. +Instrumentation test documentation can be founded in the [instrumentation](instrumentation/README.md) directory. -### Local test +### Local testing -Local test require additional binaries. The following binaries must be in the +Local tests require additional binaries. The following binaries must be in the local user PATH: - `pg_ctl` and `psql` from PostgreSQL @@ -248,8 +247,8 @@ local user PATH: - `taler-config` and `taler-exchange-wire-gateway-client` from the [Taler exchange ](https://git.taler.net/exchange.git/) -You can use the [prepare](script/prepare.sh) script to downloads and extract -blockchain binaries and find the path of the local postgres installation. +You can use the [prepare](script/prepare.sh) script to download and extract +blockchain binaries and find the path of the local Postgres installation. However, taler binaries need to be compiled from source for now. | Command | Run | diff --git a/btc-wire/README.md b/btc-wire/README.md index 3a1ef1d..39d82f7 100644 --- a/btc-wire/README.md +++ b/btc-wire/README.md @@ -63,7 +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 +We resolve stuck transactions by always sending replaceable transactions using [BIP 125](https://github.com/bitcoin/bips/blob/master/bip-0125.mediawiki). TODO diff --git a/wire-gateway/README.md b/wire-gateway/README.md index a03ba02..0a02e83 100644 --- a/wire-gateway/README.md +++ b/wire-gateway/README.md @@ -5,8 +5,8 @@ Rust server for ## Database schema -The server is wire implementation agnostic, it only require an postgres database -with following schema: +The server is wire implementation agnostic, it only requires a Postgres database +with the following schema: ```sql -- Key value state |