mirror of
https://github.com/darkrenaissance/darkfi.git
synced 2026-01-09 14:48:08 -05:00
121 lines
4.1 KiB
Markdown
121 lines
4.1 KiB
Markdown
# DarkFi
|
|
|
|
|
|
[](https://dark.fi)
|
|
[](https://dark.fi/manifesto.html)
|
|
[](https://darkrenaissance.github.io/darkfi)
|
|
|
|
## About DarkFi
|
|
|
|
DarkFi is a new Layer 1 blockchain, designed with anonymity at the
|
|
forefront. It offers flexible private primitives that can be wielded
|
|
to create any kind of application. DarkFi aims to make anonymous
|
|
engineering highly accessible to developers.
|
|
|
|
DarkFi uses advances in zero-knowledge cryptography and includes a
|
|
contracting language and developer toolkits to create uncensorable
|
|
code.
|
|
|
|
In the open air of a fully dark, anonymous system, cryptocurrency has
|
|
the potential to birth new technological concepts centered around
|
|
sovereignty. This can be a creative, regenerative space - the dawn of
|
|
a Dark Renaissance.
|
|
|
|
|
|
## Connect to DarkFi IRC
|
|
|
|
Follow the [installation instructions](https://darkrenaissance.github.io/darkfi/misc/ircd/ircd.html)
|
|
for the P2P IRC daemon.
|
|
|
|
## Build
|
|
|
|
This project requires the Rust compiler to be installed.
|
|
Please visit [Rustup](https://rustup.rs/) for instructions.
|
|
|
|
Minimum Rust version supported is **1.64.0**.
|
|
|
|
The following dependencies are also required:
|
|
|
|
| Dependency | Debian-based |
|
|
|------------------------------|------------------|
|
|
| gcc, gcc-c++, kernel headers | build-essential |
|
|
| cmake | cmake |
|
|
| jq | jq |
|
|
| 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:
|
|
|
|
```shell
|
|
# apt-get update
|
|
# apt-get install -y build-essential cmake jq wget pkg-config \
|
|
clang libclang-dev llvm-dev libudev-dev libfreetype6-dev \
|
|
libexpat1-dev
|
|
```
|
|
|
|
Alternatively, users can try using the automated script under `contrib`
|
|
folder by executing:
|
|
|
|
```shell
|
|
% sh contrib/dependency_setup.sh
|
|
```
|
|
|
|
The script will try to recognize which system you are running,
|
|
and install dependencies accordingly. In case it does not find your
|
|
package manager, please consider adding support for it into the script
|
|
and sending a patch.
|
|
|
|
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.
|
|
|
|
```shell
|
|
% 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](https://darkrenaissance.github.io/darkfi/development.html).
|
|
|
|
|
|
## Install
|
|
|
|
This will install the binaries on your system (`/usr/local` by
|
|
default). The configuration files for the binaries are bundled with the
|
|
binaries and contain sane defaults. You'll have to run each daemon once
|
|
in order for them to spawn a config file, which you can then review.
|
|
|
|
```shell
|
|
# make install
|
|
```
|
|
|
|
## Bash Completion
|
|
This will add the options auto completion of `drk` and `darkfid`.
|
|
```shell
|
|
% echo source \$(pwd)/contrib/auto-complete >> ~/.bashrc
|
|
```
|
|
|
|
### Examples and usage
|
|
|
|
See the [DarkFi book](https://darkrenaissance.github.io/darkfi)
|
|
|
|
## 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.
|