|
|
@@ -1,5 +1,3 @@
|
|
|
-# DarkFi v0 user tutorial
|
|
|
-
|
|
|
Welcome to the dark renaissance. This tutorial will teach you how to
|
|
|
install darkfi on your system, and how to use the testnet to send and
|
|
|
receive anonymous tokens.
|
|
|
@@ -20,7 +18,7 @@ $ git clone https://github.com/darkrenaissance/darkfi
|
|
|
|
|
|
In the project root directory, run provided Makefile. This will download
|
|
|
the trusted setup params and compile the source code. This might take
|
|
|
-some time if it's your first time building the project.
|
|
|
+some time.
|
|
|
|
|
|
```
|
|
|
$ make
|
|
|
@@ -31,9 +29,10 @@ $ make
|
|
|
We will now install the project. This will install the binaries on
|
|
|
your device in /usr/local, so you can run darkfi from the command-line
|
|
|
directly. It will also create a new directory for config files at
|
|
|
-$HOME/.config/darkfi. Feel free to review the installed config files,
|
|
|
-but you don't need to change anything to run the testnet. The defaults
|
|
|
-will work fine.
|
|
|
+$HOME/.config/darkfi.
|
|
|
+
|
|
|
+Feel free to review the installed config files, but you don't need to
|
|
|
+change anything to run the testnet. The defaults will work fine.
|
|
|
|
|
|
```
|
|
|
$ sudo make install
|
|
|
@@ -44,9 +43,9 @@ $ sudo make install
|
|
|
Darkfi consists of several software daemons or processes. These daemons
|
|
|
have seperate, isolated concerns.
|
|
|
|
|
|
-As a user, your interest is in the `darkfid` daemon. This is a user
|
|
|
+As a user, your interest is in the `darkfid` daemon. This is a user
|
|
|
node that interacts with your wallet and communicates with services on
|
|
|
-the darkfi network. It is operated using the `drk` command-line tool.
|
|
|
+the darkfi network. It is operated using the `drk` command-line tool.
|
|
|
|
|
|
After the installation, you should have `drk` and `darkfid` binaries in
|
|
|
`/usr/local`. Also, the params and configuration files should be in
|
|
|
@@ -91,20 +90,23 @@ SUBCOMMANDS:
|
|
|
|
|
|
## Deposit
|
|
|
|
|
|
-Let's start by depositing some coins into darkfi.
|
|
|
+We'll go through the main features one by one. Let's start by depositing
|
|
|
+some coins into darkfi.
|
|
|
|
|
|
-First, we'll need testnet coins on either Bitcoin or Solana. For Bitcoin
|
|
|
-these can be acquired from a faucet like []. You will need to switch
|
|
|
-your Bitcoin wallet to testnet mode.
|
|
|
+First, we need testnet coins on either Bitcoin or Solana. For
|
|
|
+Bitcoin these can be acquired from a faucet like [this one](https://testnet-faucet.mempool.co/).
|
|
|
+You will need to switch your Bitcoin wallet to testnet mode.
|
|
|
|
|
|
For Solana, you can either install the Solana command-line suite or
|
|
|
-use sollet.io. Follow this tutorial for the Solana command-line [].
|
|
|
-For sollet.io, switch the network to testnet and click the ... to airdrop
|
|
|
-yourself some testnet coins.
|
|
|
+use [sollet](sollet.io).
|
|
|
+
|
|
|
+Follow [this tutorial] (https://docs.solana.com/cli) for the Solana
|
|
|
+command-line For sollet.io, switch the network to testnet and click the
|
|
|
+... to airdrop yourself some testnet coins.
|
|
|
|
|
|
-Now that we have testnet coins we can deposit into DarkFi.
|
|
|
+Now that we have testnet coins we can deposit into darkfi.
|
|
|
|
|
|
-We'll do this by sending testnet coins to the DarkFi cashier, which will
|
|
|
+We'll do this by sending testnet coins to the darki cashier, which will
|
|
|
issue darkened versions of the deposted coin. This process of darkening
|
|
|
involves the cashier minting new anonymous tokens that are 1:1 redeemable
|
|
|
for deposits.
|
|
|
@@ -133,38 +135,24 @@ $ ./target/release/drk deposit [ASSET] --network solana
|
|
|
This command will send a deposit request to the cashier. After running
|
|
|
it, you should get an address printed to your terminal, like this:
|
|
|
|
|
|
-[image]
|
|
|
+```
|
|
|
+Deposit your coins to the following address: "734JBp3FRPoDs6ibSMyq3CV9zyMiDeynxMQRbSxVvozN"
|
|
|
+```
|
|
|
|
|
|
Using Bitcoin or Solana, deposit the desired tokens to the specified
|
|
|
-cashier address. This ...
|
|
|
-
|
|
|
-## Configure
|
|
|
-
|
|
|
-Now that you have a copy of the software on your device, you will need
|
|
|
-to compile the project. But first we must configure our preferences.
|
|
|
-
|
|
|
-DarkFi is highly configurable by design. Key system parameters can be
|
|
|
-changed inside the config files.
|
|
|
-
|
|
|
-Default config files can be found here: [example/config](example/config).
|
|
|
-
|
|
|
-First create a new directory for your config files:
|
|
|
+address.
|
|
|
|
|
|
-```
|
|
|
-$ mkdir ~/.config/darkfi
|
|
|
-```
|
|
|
+## Transfer
|
|
|
|
|
|
-Copy darkfid.toml and drk.toml to ~/.config/darkfi.
|
|
|
+TODO
|
|
|
|
|
|
-```
|
|
|
-$ cp example/config/darkfid.toml example/config/drk.toml ~/.config/darkfi
|
|
|
-```
|
|
|
+## Withdraw
|
|
|
|
|
|
-Take some time to familiarize yourself with the config options.
|
|
|
-The defaults should be sufficient for most users and are safe to use
|
|
|
-for demo purposes.
|
|
|
+TODO
|
|
|
|
|
|
-See the cashier tutorial [] for how to modify `darkfid.toml` to work
|
|
|
-with any cashier.
|
|
|
+## Configure
|
|
|
|
|
|
+DarkFi is highly configurable by design. Key system parameters can be
|
|
|
+changed inside the config files.
|
|
|
|
|
|
+TODO
|
lunar-mining