commit 3e9cedbee0943e46927342b443adffe1d07634eb
parent b9033f99d70bd4cf73cadc762d14c359e8977da8
Author: Antoine A <>
Date: Thu, 10 Mar 2022 16:53:13 +0100
Improve documentation
Diffstat:
2 files changed, 29 insertions(+), 29 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
@@ -1905,9 +1905,9 @@ checksum = "360dfd1d6d30e05fda32ace2c8c70e9c0a9da713275777f5a4dbb8a1893930c6"
[[package]]
name = "tracing"
-version = "0.1.31"
+version = "0.1.32"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f6c650a8ef0cd2dd93736f033d21cbd1224c5a967aa0c258d00fcf7dafef9b9f"
+checksum = "4a1bdf54a7c28a2bbf701e1d2233f6c77f473486b94bee4f9678da5a148dca7f"
dependencies = [
"cfg-if",
"pin-project-lite",
diff --git a/README.md b/README.md
@@ -181,26 +181,6 @@ BUMP_DELAY = 0
8. Run wire-gateway `wire-gateway`
9. Run eth-wire `eth-wire`
-## NGINX TODO
-
-```
-server {
- location /btc-wire {
- proxy_pass http://unix:$UNIX_PATH;
- }
-}
-```
-
-or
-
-```
-server {
- location /btc-wire {
- proxy_pass http://localhost:$PORT;
- }
-}
-```
-
## Security
Depolymerizer only use an encrypted wallet and provide an easy way to create
@@ -211,11 +191,30 @@ Only the wire adapter need to have the password stored in its environment.
## Log format
-TODO
+Wire log use an ASCII code for transaction logs:
+
+- `<<` for an credit
+- `>>` for a debit
+- `||` for a bounce
+
+You can have an additional context:
+
+- `bump ` stuck transaction have been bumped
+- `conflict ` transaction have 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
## Test
-The following binaries need to be in the local user PATH:
+Instrumentation test documentation can be founded in the
+[instrumentation](instrumentation/README.md) directory.
+
+### Unit test
+
+Unit test require additional binaries. The following binaries must be in the
+local user PATH:
- `pg_ctl` and `psql` from PostgreSQL
- `geth` from [go-ethereum](https://geth.ethereum.org/downloads/)
@@ -228,8 +227,9 @@ You can use the [prepare](script/prepare.sh) script to downloads and extract
blockchain binaries and find the path of the local postgres installation.
However, taler binaries need to be compiled from source for now.
-TODO
-
-To also install test tools from source run: `make install_test`.
-
-To run all tests: `make test`.
+| Command | Run |
+| ------------------- | ------------------ |
+| `make test` | all tests |
+| `make test_gateway` | wire-gateway tests |
+| `make test_btc` | btc-wire tests |
+| `make test_eth` | eth-wire tests |
