Files
darkfi/README.md
2021-10-10 14:38:35 +02:00

75 lines
1.5 KiB
Markdown

# DarkFi
![Build Status](https://github.com/darkrenaissance/darkfi/actions/workflows/rust-build.yml/badge.svg)
## Building
```
$ make
```
## Configuration
The daemons can be configured using TOML files. Find examples in
this repo: [example/config](example/config) and copy them over to
`~/.config/darkfi`. The defaults should be safe to use for demo
purposes.
The cashier daemon must have enough testnet coins to cover fees.
Testnet SOL can be acquired by calling `solana airdrop` on devnet.
Testnet BTC can be acquired from a faucet.
The darkfid daemon must be manually configured with the cashier
public key. To get the cashier public key, run:
```
$ ./target/release/cashierd -a
```
To update darkfid, run:
```
$ ./target/release/darkfid cashier --set [PUBLIC KEY]
```
## Usage
For demo purposes we have to run three daemons. It is best practice to
run them in three different terminals, and use the fourth to interact
with them using the provided `drk` command line tool.
1. Run `gatewayd`:
```
$ ./target/release/gatewayd -v
```
2. Run `cashierd`:
```
$ ./target/release/cashierd -v
```
3. Run `darkfid`:
```
$ ./target/release/darkfid -v
```
Now using the command line interface to the `darkfid` daemon, we can
make use of the system:
```
$ ./target/release/drk help
```
## Go Dark
Let's liberate people from the claws of big tech and create the
democratic paradigm of technology.
Self-defense is integral to any organism's survival and growth.
Power to the minuteman.