github/darkfi
1
1
Fork 0
mirror of https://github.com/darkrenaissance/darkfi.git synced 2026-01-09 06:38:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

added default TOMLs to readme

Browse Source
This commit is contained in:
lunar-mining
2021-09-09 09:35:17 +02:00
parent b37eebeb91
commit 3c42509460
1 changed files with 57 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -1,21 +1,61 @@
Not even an alpha product. Just a mere prototype(s).
# First time running the demo:
1. First time running the demo:
1. Compile the project:
Configure gatewayd, cashierd, darkfid and drk TOML files. Copy paste the following defaults to .config/darkfi:
**gatewayd.toml**
```
connect_url = "127.0.0.1:3333"
publisher_url = "127.0.0.1:4444"
database_path = "gatewayd.db"
log_path = "/tmp/gatewayd.log"
```
**cashierd.toml**
```
accept_url = "127.0.0.1:7777"
rpc_url = "http://127.0.0.1:8000"
client_database_path = "cashier_client_database.db"
btc_endpoint = "tcp://electrum.blockstream.info:50001"
gateway_url = "127.0.0.1:3333"
log_path = "/tmp/cashierd.log"
cashierdb_path = "/home/x/.config/darkfi/cashier.db"
client_walletdb_path = "/home/x/.config/darkfi/cashier_client_walletdb.db"
password = ""
client_password = ""
```
**darkfid.toml**
```
connect_url = "127.0.0.1:3333"
subscriber_url = "127.0.0.1:4444"
cashier_url = "127.0.0.1:7777"
rpc_url = "127.0.0.1:8000"
database_path = "/home/x/.config/darkfi/database_client.db"
walletdb_path = "/home/x/.config/darkfi/walletdb.db"
log_path = "/tmp/darkfid_service_daemon.log"
password = ""
```
**drk.toml**
```
rpc_url = "http://127.0.0.1:8000"
log_path = "/tmp/drk_cli.log"
```
2. Configure the password field on all TOML files.
3. Compile the project:
```console
$ cargo build --release
```
2. Set a wallet password. Note: you must set a password before using the wallet.
Open .config/darkfi/darkfid.toml and add a password to the 'Password' section.
3. Set a cashier password and a cashier client password.
Open .config/darkfi/cashierd.toml. Add a password to the 'Password' section, and a another password to the 'Client Password' section.
4. Run the gateway daemon:
```console
@@ -34,12 +74,18 @@ $ cargo run --bin cashierd -- -v
$ cargo run --bin darkfid -- -v
```
7. Initialize wallet and generate key pair:
7. Initialize drk wallet and generate a key pair:
```console
$ cargo run --bin drk -- -wk
```
8. Play.
```console
$ cargo run --bin drk -- -help
```
# Every time running the demo:
Run gateway daemon: