Documentation | Guides | News

CSCRYPTO

Cscrypto is credits company's crypto library supporting:

• digital signatures
• hashing and HMAC
• random data generation
• memory protection
• private data ciphering
• deterministic keys derivation
• keys recovery from mnemonic phrase
• key exchange

Building from source

Basic requirements :

• cmake 3.10 or newer
• compiler with C++17 support

To build with tests add the following argument when run cmake:

 -Dbuild_cscrypto_tests=ON

Windows:

 git clone https://github.com/CREDITSCOM/cscrypto.git
 cd cscrypto
 mkdir build
 cd build
 cmake -DCMAKE_BUILD_TYPE=Release -A x64 ..
 cmake --build . --target ALL_BUILD --config Release

Unix:

 $ git clone https://github.com/CREDITSCOM/cscrypto.git
 $ cd cscrypto
 $ mkdir build && cd build
 $ cmake -DCMAKE_BUILD_TYPE=Release ..
 $ make

Ubuntu & Debian

Build requirements:

 $ sudo apt-get install build-essential libtool autoconf

To build with gui:

 $ sudo apt-get install libqt5gui5 libqt5core5a libqt5dbus5 qttools5-dev qttools5-dev-tools libprotobuf-dev protobuf-compiler

Fedora

Build requirements:

 $ sudo dnf install gcc-c++ libtool make autoconf

To build with gui:

 $ sudo dnf install qt5-qttools-devel qt5-qtbase-devel protobuf-devel

Contribution

Thank you for considering to help out with the source code! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes! If you'd like to contribute to Cscrypto, please fork, fix, commit and send a pull request for the maintainers to review and merge into the main code base. If you wish to submit more complex changes though, please check up with the core devs first on our Developers portal and Contribution file to ensure those changes are in line with the general philosophy of the project and/or get some early feedback which can make both your efforts much lighter as well as our review and merge procedures quick and simple. Please make sure your contributions adhere to our coding guidelines:

• Code must adhere to the Credits coding style
• Pull requests need to be based on and opened against the master branch
• Commit messages should be prefixed with the package(s) they modify

Resources

CREDITS Website

Documentation

Whitepaper

Technical paper

Developers portal

Credits forum

Community links