Kanak

Copyright (c) 2017, Project Kanak

Development Resources

• Web: coming soon
• Forum: https://www.reddit.com/r/ProjectKanak/
• Mail: project-kanak@gmx.com
• GitHub: https://github.com/Project-Kanak/kanak-master

Introduction

Kanak is a private, secure, untraceable, decentralised digital currency. You are your bank, you control your funds, and nobody can trace your transfers unless you allow them to do so.

Privacy: Kanak uses a cryptographically sound system to allow you to send and receive funds without your transactions being easily revealed on the blockchain (the ledger of transactions that everyone has). This ensures that your purchases, receipts, and all transfers remain absolutely private by default.

Security: Using the power of a distributed peer-to-peer consensus network, every transaction on the network is cryptographically secured. Individual wallets have a 25 word mnemonic seed that is only displayed once, and can be written down to backup the wallet. Wallet files are encrypted with a passphrase to ensure they are useless if stolen.

Untraceability: By taking advantage of ring signatures, a special property of a certain type of cryptography, Kanak is able to ensure that transactions are not only untraceable, but have an optional measure of ambiguity that ensures that transactions cannot easily be tied back to an individual user or computer.

About this Project

This is the core implementation of Cryptonote Protocol. It is open source and completely free to use without restrictions, except for those specified in the license agreement below. There are no restrictions on anyone creating an alternative implementation of kanak that uses the protocol and network in a compatible manner.

As with many development projects, the repository on Github is considered to be the "staging" area for the latest changes. Before changes are merged into that branch on the main repository, they are tested by individual developers in their own branches, submitted as a pull request, and then subsequently tested by contributors who focus on testing and code reviews. That having been said, the repository should be carefully considered before using it in a production environment, unless there is a patch in the repository for a particular show-stopping issue you are experiencing. It is generally a better idea to use a tagged release for stability.

Anyone is welcome to contribute to Kanak's codebase!

Supporting the Project

Kanak development can be supported directly through donations.

The Kanak donation adress is: KjRFSKpPXW4iSmzcAMbhPLhxt2sasX2jNV8s3igzbB26ZiAYYkE7nKVMSaakUjZvvmY4HxQDQRDTzeSBpnGyStg95jV5zst

The Bitcoin donation address is: 1KznGrhJqsboRqg3K397wVXvogQJn5YuU5

The Ethereum donation address is: 0x9901a6bae92934b291ad78ee46f38aadd221e990

The Dogecoin donation address is: DBGjzacQbanhU4dvCn6o7fSKqtNE7LDUGt

The Monero donation address is: 4AeUSUSoXHnFUUhBEkTAnkNc3WpxdSLFsDEyWfviGvW7dwuggrrzt1r8GQdwxMJ66H57mKJK1AJDv8QpywoMsukHLR1MQvo

License

See LICENSE.

Compiling Kanak from Source

Dependencies

The following table summarizes the tools and libraries required to build. A few of the libraries are also included in this repository (marked as "Vendored"). By default, the build uses the library installed on the system, and ignores the vendored sources. However, if no library is found installed on the system, then the vendored source will be built and used. The vendored sources are also used for statically-linked builds because distribution packages often include only shared library binaries (.so) but not static library archives (.a).

Dep	Min. Version	Vendored	Debian/Ubuntu Pkg	Arch Pkg	Purpose
GCC	4.7.3	NO	build-essential	base-devel
CMake	3.0.0	NO	cmake	cmake
pkg-config	any	NO	pkg-config	base-devel
Boost	1.58	NO	libboost-all-dev	boost	C++ libraries
OpenSSL	basically any	NO	libssl-dev	openssl	sha256 sum
libunbound	1.4.16	YES	libunbound-dev	unbound	DNS resolver

[^] On Debian/Ubuntu libgtest-dev only includes sources and headers. You must build the library binary manually. This can be done with the following command sudo apt-get install libgtest-dev && cd /usr/src/gtest && sudo cmake . && sudo make && sudo mv libg* /usr/lib/

Build instructions

Kanak uses the CMake build system and a top-level Makefile that invokes cmake commands as needed.

On Linux and OS X

• Install the dependencies

• Change to the root of the source code directory and build:

    cd kanak-master
    make
  

  Optional: If your machine has several cores and enough memory, enable parallel build by running make -j<number of threads> instead of make. For this to be worthwhile, the machine should have one core and about 2GB of RAM available per thread.

• The resulting executables can be found in build/release/bin

• Add PATH="$PATH:$HOME/kanak/build/release/bin" to .profile

• Run Monero with kanakd --detach

• Optional: build and run the test suite to verify the binaries:

    make release-test
  

  NOTE: coretests test may take a few hours to complete.

• Optional: to build binaries suitable for debugging:

     make debug
  

• Optional: to build statically-linked binaries:

     make release-static
  

• Optional: build documentation in doc/html (omit HAVE_DOT=YES if graphviz is not installed):

    HAVE_DOT=YES doxygen Doxyfile
  

On Windows:

Binaries for Windows are built on Windows using the MinGW toolchain within MSYS2 environment. The MSYS2 environment emulates a POSIX system. The toolchain runs within the environment and cross-compiles binaries that can run outside of the environment as a regular Windows application.

Preparing the Build Environment

• Download and install the MSYS2 installer, either the 64-bit or the 32-bit package, depending on your system.

• Open the MSYS shell via the MSYS2 Shell shortcut

• Update packages using pacman:

    pacman -Syuu  
  

• Exit the MSYS shell using Alt+F4

• Edit the properties for the MSYS2 Shell shortcut changing "msys2_shell.bat" to "msys2_shell.cmd -mingw64" for 64-bit builds or "msys2_shell.cmd -mingw32" for 32-bit builds

• Restart MSYS shell via modified shortcut and update packages again using pacman:

    pacman -Syuu  
  

• Install dependencies:

  To build for 64-bit Windows:

    pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake mingw-w64-x86_64-boost
  

  To build for 32-bit Windows:

    pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake mingw-w64-i686-boost
  

• Open the MingW shell via MinGW-w64-Win64 Shell shortcut on 64-bit Windows or MinGW-w64-Win64 Shell shortcut on 32-bit Windows. Note that if you are running 64-bit Windows, you will have both 64-bit and 32-bit MinGW shells.

Building

• If you are on a 64-bit system, run:

    make release-static-win64
  

• If you are on a 32-bit system, run:

    make release-static-win32
  

• The resulting executables can be found in build/release/bin

Running kanakd

The build places the binary in bin/ sub-directory within the build directory from which cmake was invoked (repository root by default). To run in foreground:

./bin/kanakd

To list all available options, run ./bin/kanakd --help. Options can be specified either on the command line or in a configuration file passed by the --config-file argument. To specify an option in the configuration file, add a line with the syntax argumentname=value, where argumentname is the name of the argument without the leading dashes, for example log-level=1.

kanak