plenteum-crypto

    3.0.6 • Public • Published

    image

    NPM

    Master Build Status

    Build Status Build status

    Plenteum: Standalone Cryptography Library

    This repository contains the necessary files to compile the cryptography library used within Plenteum as a standalone library that can be included in various other projects in a variety of development environments, including:

    • Node.js >= 6.x
    • C++
    • C# (via C++ shared library & P/Invoke)
    • Native Javascript
    • WASM

    Node.js Module

    Dependencies

    • Node.js >= +6.x LTS (or Node v11)

    Windows

    Prerequisites

    Read very careful if you want this to work right the first time.

    1. Open a Windows Powershell console as Administrator
    2. Run the command: npm install -g windows-build-tools --vs2015 This will take a while. Sit tight.

    Linux

    Installation

    npm install plenteum-crypto

    Intialization

    const PlenteumCrypto = require('plenteum-crypto')

    C++ Library

    How To Compile

    Build Optimization

    The CMake build system will, by default, create optimized native builds for your particular system type when you build the software. Using this method, the binaries created provide a better experience and all together faster performance.

    However, if you wish to create portable binaries that can be shared between systems, specify -DARCH=default in your CMake arguments during the build process. Note that portable binaries will have a noticable difference in performance than native binaries. For this reason, it is always best to build for your particuar system if possible.

    Linux

    Ubuntu, using GCC
    sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
    sudo apt-get update
    sudo apt-get install aptitude -y
    sudo aptitude install -y build-essential git cmake
    git clone -b master --single-branch https://github.com/plenteum/plenteum-crypto
    cd plenteum-crypto
    mkdir build
    cd build
    cmake ..
    make -j

    The static library will be built as libplenteum-crypto.a in the build folder.

    Ubuntu, using Clang
    sudo add-apt-repository ppa:ubuntu-toolchain-r/test -y
    wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -

    You need to modify the below command for your version of ubuntu - see https://apt.llvm.org/

    • Ubuntu 14.04 (Trusty)
    • sudo add-apt-repository "deb https://apt.llvm.org/trusty/ llvm-toolchain-trusty 6.0 main"
    • Ubuntu 16.04 (Xenial)
    • sudo add-apt-repository "deb https://apt.llvm.org/xenial/ llvm-toolchain-xenial 6.0 main"
    • Ubuntu 18.04 (Bionic)
    • sudo add-apt-repository "deb https://apt.llvm.org/bionic/ llvm-toolchain-bionic 6.0 main"
    sudo apt-get update
    sudo apt-get install aptitude -y
    sudo aptitude install -y -o Aptitude::ProblemResolver::SolutionCost='100*canceled-actions,200*removals'
    sudo aptitude install build-essential clang-6.0 libstdc++-7-dev git cmake
    export CC=clang-6.0
    export CXX=clang++-6.0
    git clone -b master --single-branch https://github.com/plenteum/plenteum-crypto
    cd plenteum-crypto
    mkdir build
    cd build
    cmake ..
    make -j

    The following library files will be created in the build folder:

    • libplenteum-crypto-static.a
    Generic Linux

    Ensure you have the dependencies listed above.

    If you want to use clang, ensure you set the environment variables CC and CXX. See the ubuntu instructions for an example.

    git clone -b master --single-branch https://github.com/plenteum/plenteum-crypto
    cd plenteum-crypto
    mkdir build
    cd build
    cmake ..
    make -j

    The following library files will be created in the build folder:

    • libplenteum-crypto-static.a

    OSX/Apple, using Clang

    Prerequisites
    • Install XCode and Developer Tools.
    Building
    which brew || /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
    brew install --force cmake boost llvm
    export CC=/usr/local/opt/llvm/bin/clang
    export CXX=/usr/local/opt/llvm/bin/clang++
    git clone -b master --single-branch https://github.com/plenteum/plenteum-crypto
    cd plenteum-crypto
    mkdir build
    cd build
    cmake ..
    make

    The following library files will be created in the build folder:

    • libplenteum-crypto-static.a

    Windows

    Prerequisites
    Building
    • From the start menu, open 'x64 Native Tools Command Prompt for vs2017'.
    cd <your_plenteum-crypto_directory>
    mkdir build
    cd build
    set PATH="C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\Common7\IDE\CommonExtensions\Microsoft\CMake\CMake\bin";%PATH%
    cmake -G "Visual Studio 15 2017 Win64" ..
    

    Note: If you have errors on this step about not being able to find the some libraries, you may need to update your cmake. Open 'Visual Studio Installer' and click 'Update'.

    MSBuild plenteum-crypto.sln /p:Configuration=Release /m

    The following library files will be created in the build/Release folder:

    • plenteum-crypto-static.lib
    • plenteum-crypto-shared.lib
    • plenteum-crypto-shared.dll

    Native Javascript & WASM

    Prerequisites

    You will need the following packages: CMake (2.8 or higher), make, and git.

    Compiling

    git clone -b master --single-branch https://github.com/plenteum/plenteum-crypto
    cd plenteum-crypto
    bash ./build_js.sh

    This script will install the necessary dependencies on your machine and then proceed to compile the library to Native Javascript and WASM.

    The following library files will be created in the jsbuild folder:

    • Native Javascript
      • plenteum-crypto.js
    • WASM
      • plenteum-crypto-wasm.js

    Thanks

    Cryptonote Developers, Bytecoin Developers, Monero Developers, Forknote Project, TurtleCoin Community

    Copypasta for license when editing files

    Hi Plenteum contributor, thanks for forking and sending back Pull Requests. Extensive docs about contributing are in the works or elsewhere. For now this is the bit we need to get into all the files we touch. Please add it to the top of the files.

    // Copyright (c) 2012-2017, The CryptoNote developers, The Bytecoin developers
    // Copyright (c) 2014-2018, The Monero Project
    // Copyright (c) 2018-2019, The TurtleCoin Developers
    // Copyright (c) 2018-2019, The Plenteum Developers
    //
    // Please see the included LICENSE file for more information.
    

    Keywords

    none

    Install

    npm i plenteum-crypto

    DownloadsWeekly Downloads

    1

    Version

    3.0.6

    License

    GPL-3.0

    Unpacked Size

    1.1 MB

    Total Files

    138

    Last publish

    Collaborators

    • plenteum