Anonymous. Uncensored. Sovereign. https://dark.fi

parazyd ec7a4a9c34 book/zkas/sapling: Update some text and add a few footnotes.		vor 4 Jahren
.github	4ab35f46a4 github: Use nightly channel for rustfmt.	vor 4 Jahren
bin	6398d919e6 map: updated Cargo.toml	vor 4 Jahren
book	ec7a4a9c34 book/zkas/sapling: Update some text and add a few footnotes.	vor 4 Jahren
contrib	d965a9b9f8 contrib: Add LPEG lexer for the zkas language.	vor 4 Jahren
doc	a1e293eb48 add a doc describing p2p irc test usage	vor 4 Jahren
example	ef575206fe config: Update default cashier public key.	vor 4 Jahren
old	f1985e7559 proof: Move pism scripts to old/	vor 4 Jahren
org	8211feecbc Add org directory for project management	vor 4 Jahren
proof	f1985e7559 proof: Move pism scripts to old/	vor 4 Jahren
script	ca8a3378ad script/run_network.sh	vor 4 Jahren
sql	49e1699702 walletdb: add the option to set/get the default keypair	vor 4 Jahren
src	24bc06daf8 cli: print the path when there is an error parsing the config file	vor 4 Jahren
testdata	b7e9bfef57 create test json file ro erc20 token list	vor 4 Jahren
zkas	fe6c62f38a zkas: Prepend magic AND version.	vor 4 Jahren
.envrc	c97f30f4dc Add minimal envrc for flake direnv	vor 4 Jahren
.gitignore	5e16334047 book/zkas/sapling: Remove semicolons at ends of section declarations.	vor 4 Jahren
Cargo.lock	1b08707e07 Set sqlx version to 0.5.10.	vor 4 Jahren
Cargo.toml	1b08707e07 Set sqlx version to 0.5.10.	vor 4 Jahren
IDEOLOGY.md	1bd2fced86 annotated 'definition of democratic civilization' to improve readability	vor 5 Jahren
LICENSE.md	b5b1e4ca54 Relicense code to AGPL-3.	vor 4 Jahren
Makefile	abf96fd767 Makefile: Default to building gatewayd as well.	vor 4 Jahren
README.md	0aa596749f Update dependency list in the Readme.	vor 4 Jahren
king.png	7de40e7f01 removed /lisp and added king.png	vor 4 Jahren
rustfmt.toml	a3117e7f84 wrap_comments to false in rustfmt.toml	vor 4 Jahren
todo.md	5e3db18f2c todo.md: moved v0-release tasks to issues and deleted completed tasks	vor 4 Jahren

DarkFi

Build

This project requires the Rust compiler to be installed. Please visit https://rustup.rs/ for instructions.

The following dependencies are also required:

| Dependency | Debian-based |
|------------------------------|------------------| | gcc, gcc-c++, kernel headers | build-essential | | cmake | cmake | | wget | wget | | pkg-config | pkg-config | | clang | clang | | clang libs | libclang-dev | | llvm libs | llvm-dev | | udev libs | libudev-dev | | freetype2 libs | libfreetype6-dev | | expat xml lib | libexpat1-dev |

Users of Debian-based systems (e.g. Ubuntu) can simply run the following to install the required dependencies:

% sudo apt-get update
% sudo apt-get install -y build-essential cmake wget pkg-config clang \
    libclang-dev llvm-dev libudev-dev libfreetype6-dev libexpat1-dev

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
% cd darkfi/
% make

Development

If you want to hack on the source code, make sure to read some introductory advice in the DarkFi book.

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

N.B. On OSX this is /Users/x/Library/Application Support/darkfi.

Bash Completion

This will add the options auto completion of drk and darkfid.

% echo source $(pwd)/contrib/auto-complete >> ~/.bashrc

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 0.2.0
darkfi <dev@dark.fi>
Anonymous. Uncensored. Sovereign.

USAGE:
    drk [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -c, --config <CONFIG>    Sets a custom config file
    -h, --help               Print help information
    -v                       Increase verbosity
    -V, --version            Print version information

SUBCOMMANDS:
    deposit     Deposit clear tokens for Dark tokens
    features    Show what features the cashier supports
    hello       Say hello to the RPC
    help        Print 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 the DarkFi book

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.

README.md