mirror of
https://github.com/darkrenaissance/darkfi.git
synced 2026-04-28 03:00:18 -04:00
87 lines
2.5 KiB
Markdown
87 lines
2.5 KiB
Markdown
# DarkFi
|
|
|
|
|
|
[](https://dark.fi)
|
|
[](https://lists.dyne.org/lurker/message/20211021.123016.3dccaf0c.en.html)
|
|
|
|
## Build
|
|
|
|
To build the necessary binaries, we can just clone the repo, and use
|
|
the provided Makefile to build the project. This will download the
|
|
trusted setup params, and compile the source code.
|
|
|
|
```
|
|
$ git clone https://github.com/darkrenaissance/darkfi
|
|
$ make
|
|
```
|
|
|
|
## Install
|
|
|
|
This will install the binaries and configurations in the configured
|
|
namespace (`/usr/local` by default). The configurations are installed
|
|
as TOML files in `/usr/local/share/doc/darkfi`. They have to be copied
|
|
in your user's `$HOME/.config/darkfi` directory. You can review the
|
|
installed config files, but the defaults should be good for using
|
|
the testnet if you're following this document.
|
|
|
|
```
|
|
$ sudo make install
|
|
$ mkdir -p ~/.config/darkfi
|
|
$ cp -f /usr/local/share/doc/darkfi/*.toml ~/.config/darkfi
|
|
```
|
|
|
|
## Usage
|
|
|
|
After the installation, you should have `drk` and `darkfid`
|
|
binaries in `/usr/local`. Also, the configuration files should be in
|
|
`~/.config/darkfi`. Now we're ready to use the testnet.
|
|
|
|
In one terminal, start `darkfid`, which is the daemon that will
|
|
communicate with the DarkFi network:
|
|
|
|
```
|
|
$ darkfid -v
|
|
```
|
|
|
|
And in the other terminal, we can use the CLI interface to `darkfid`
|
|
called `drk`:
|
|
|
|
```
|
|
$ drk -h
|
|
drk
|
|
|
|
USAGE:
|
|
drk [FLAGS] [OPTIONS] [SUBCOMMAND]
|
|
|
|
FLAGS:
|
|
-h, --help Prints help information
|
|
-V, --version Prints version information
|
|
-v, --verbose Increase verbosity
|
|
|
|
OPTIONS:
|
|
-c, --config <CONFIG> Sets a custom config file
|
|
|
|
SUBCOMMANDS:
|
|
deposit Deposit clear tokens for Dark tokens
|
|
features Show what features the cashier supports
|
|
hello Say hello to the RPC
|
|
help Prints this message or the help of the given subcommand(s)
|
|
id Get hexidecimal ID for token symbol
|
|
transfer Transfer Dark tokens to address
|
|
wallet Wallet operations
|
|
withdraw Withdraw Dark tokens for clear tokens
|
|
```
|
|
|
|
### Examples
|
|
|
|
See [doc/tutorial.md](doc/tutorial.md).
|
|
|
|
## 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.
|