commit c96993db49c23c56ad3120db51a59a398a50aa7f
parent 3d6220f5a2e60230a92d460154eb2b3565852dc2
Author: Antoine A <>
Date: Wed, 9 Mar 2022 11:30:43 +0100
Small doc improvement
Diffstat:
3 files changed, 55 insertions(+), 22 deletions(-)
diff --git a/Cargo.lock b/Cargo.lock
@@ -129,7 +129,7 @@ dependencies = [
"base64",
"bech32",
"bitcoin",
- "clap 3.1.5",
+ "clap 3.1.6",
"common",
"criterion",
"hex",
@@ -211,9 +211,9 @@ dependencies = [
[[package]]
name = "clap"
-version = "3.1.5"
+version = "3.1.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ced1892c55c910c1219e98d6fc8d71f6bddba7905866ce740066d8bfea859312"
+checksum = "d8c93436c21e4698bacadf42917db28b23017027a4deccb35dbe47a7e7840123"
dependencies = [
"atty",
"bitflags",
@@ -245,7 +245,7 @@ version = "0.1.2"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0649fb4156bbd7306896025005596033879a2051f9a3aa7416ab915df1f8fdac"
dependencies = [
- "clap 3.1.5",
+ "clap 3.1.6",
"roff",
]
@@ -509,7 +509,7 @@ dependencies = [
name = "eth-wire"
version = "0.1.0"
dependencies = [
- "clap 3.1.5",
+ "clap 3.1.6",
"common",
"ethereum-types",
"hex",
@@ -896,7 +896,7 @@ version = "0.1.0"
dependencies = [
"bitcoin",
"btc-wire",
- "clap 3.1.5",
+ "clap 3.1.6",
"clap_mangen",
"common",
"eth-wire",
@@ -1424,9 +1424,9 @@ dependencies = [
[[package]]
name = "regex"
-version = "1.5.4"
+version = "1.5.5"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d07a8629359eb56f1e2fb1652bb04212c072a87ba68546a04065d525673ac461"
+checksum = "1a11647b6b25ff05a515cb92c365cec08801e83423a235b51e231e1808747286"
dependencies = [
"aho-corasick",
"memchr",
@@ -1665,9 +1665,9 @@ dependencies = [
[[package]]
name = "siphasher"
-version = "0.3.9"
+version = "0.3.10"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a86232ab60fa71287d7f2ddae4a7073f6b7aac33631c3015abb556f08c6d0a3e"
+checksum = "7bd3e3206899af3f8b12af284fafc038cc1dc2b41d1b89dd17297221c5d225de"
[[package]]
name = "slab"
@@ -1916,9 +1916,9 @@ dependencies = [
[[package]]
name = "tracing-core"
-version = "0.1.22"
+version = "0.1.23"
source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "03cfcb51380632a72d3111cb8d3447a8d908e577d31beeac006f836383d29a23"
+checksum = "aa31669fa42c09c34d94d8165dd2012e8ff3c66aca50f3bb226b68f216f2706c"
dependencies = [
"lazy_static",
]
@@ -2184,7 +2184,7 @@ name = "wire-gateway"
version = "0.1.0"
dependencies = [
"bitcoin",
- "clap 3.1.5",
+ "clap 3.1.6",
"common",
"deadpool-postgres",
"ethereum-types",
diff --git a/README.md b/README.md
@@ -33,7 +33,7 @@ To also install test tools run: `make install_test`.
The configuration is based on
[taler.conf](https://docs.taler.net/manpages/taler.conf.5.html).
-You can find filled configurations for each implementation:
+You can find configurations example for each implementation:
- btc-wire: [minimal](docs/taler-btc-min.conf) or
[full](docs/taler-btc-full.conf)
@@ -42,7 +42,7 @@ You can find filled configurations for each implementation:
### Initialization
-This is the required configuration for initialization.
+This is the required configuration for initialization:
```ini
# taler.conf - (fill all ___)
@@ -73,7 +73,7 @@ the RPC server. Two flags are mandatory:
```ini
[depolymerizer-bitcoin]
# Datadir or configuration file path
-CONF_PATH = ~/.bitcoin
+CONF_PATH = ~/.bitcoin
# Number of blocks to consider a transactions durable
CONFIRMATION = 6
# Amount to keep when bouncing malformed credit
@@ -85,7 +85,7 @@ BOUNCE_FEE = 0.00001
```ini
[depolymerizer-bitcoin]
# Datadir or ipc file path
-IPC_PATH = ~/.ethereum/geth/geth.ipc
+IPC_PATH = ~/.ethereum/geth/geth.ipc
# Number of blocks to consider a transactions durable
CONFIRMATION = 24
# Amount to keep when bouncing malformed credit
@@ -102,6 +102,8 @@ PORT = 8080
UNIXPATH =
# HTTP Authentication Scheme (basic or none)
AUTH_METHOD =
+# Authentification token (base64 for basic auth)
+AUTH_TOKEN =
```
### Process lifetime
@@ -141,11 +143,12 @@ BUMP_DELAY = 0
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`
+4. Choose wallet password
+5. Initialize database `btc-wire initdb`
+6. Initialize wallet `btc-wire initwallet`
+7. Update configuration files with wallet info
+8. Run wire-gateway `wire-gateway`
+9. Run btc-wire `btc-wire`
#### eth-wire
@@ -154,12 +157,33 @@ BUMP_DELAY = 0
1. Write configuration files
2. Start geth
3. Start PostgreSQL
+4. Choose account password
4. Initialize database `eth-wire initdb`
5. Initialize wallet `eth-wire initwallet`
6. Update configuration files with wallet info
7. Run wire-gateway `wire-gateway`
8. 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 encrypted wallet, and provide an easy way to create them.
diff --git a/nginx.conf b/nginx.conf
@@ -0,0 +1,8 @@
+events {}
+http {
+ server {
+ location /btc-wire {
+ proxy_pass http://unix:/home/god/btc-wire.sock;
+ }
+ }
+}
+\ No newline at end of file
