/JubiterSDK_C

Jubiter的纯C语言接口的SDK

Primary LanguageC++

Introduction

JuBiter SDK is an open source, cross-platform, mobile-focused library implementing low-level cryptographic wallet functionality for a certain number of blockchains. It is a core part of the JuBiter Wallet, and some other projects. Most of the code is C++ with a set of strict C interfaces, and idiomatic interfaces for supported languages: Swift for iOS and Java for Android.

Supported Blockchains

JuBiter Core supports more than 20 blockchains: Bitcoin, Ethereum, and some major blockchain platforms.

Special Note for COS v2.0.04 and below, this version of COS does not support the following currencies:

  • EOS
  • FIL
  • DOT
  • KSM
Index Name Symbol URL
0000 Bitcoin BTC https://bitcoin.org
0001 Testnet(all coins) - https://bitcoin.org
0002 Litecoin LTC https://litecoin.org
0005 Dash DASH https://dash.org
0060 Ethereum ETH https://ethereum.org
0061 Ethereum Classic ETC https://ethereumclassic.org
0144 Ripple XRP https://ripple.com/xrp
0145 Bitcoin Cash BCH https://bitcoincash.org
0171 Hcash HC https://h.cash/
0194 EOS EOS http://eos.io
0195 Tron TRX https://tron.network
0354 Polkadot DOT https://polkadot.network
0434 Kusama KSM https://kusama.network
0461 Filecoin FIL https://filecoin.io
2301 Qtum QTUM https://qtum.org
---- USDT USDT https://tether.to

API

JuBiter SDK supports software & hardware implementation for JuBiter wallet. Hardware support mainly JuBiter series products, including JuBiter Blade, JuBiter Bio and JuBiter Lite.

JuBiter Blade JuBiter Bio JuBiter Lite JuBiter Crypto
HID ☑ ☑ ☑ ☒
BLE ☑ ☑ ☒ ☒
NFC ☒ ☒ ☑ ☒
Impl in software ☒ ☒ ☒ ☑
VM(simulator) ☑ ☑ ☒(In the plan) ☒

Accordingly, JuBiter SDK is divided into the following modules, common module, device operation related module, Blade related module, Bio related module, Lite related module, coin related module, and software wallet module, etc.

There are two IDs in JuBiter SDK, deviceID and contextID. The first one is used to operate and connect hardware devices, and the last one is used for device-related and coin-related operations in a coin context. So, deviceID is obtained through the device operation related interface, and contextID is obtained through the coin-related interface.

API include:

  • Virtual Device in software implementation mode related module (see here)
  • Device in HID mode related module (see here)
  • Device in BLE mode related module (see here)
  • Device in NFC mode related module (see here)
  • Virtual Device(simulator for applet) in socket mode related module (see here)
  • Device operation related module (see here)
  • Coin related module (see here)
  • Core module (see here)
  • JuBiter SDK for Production tools (see here)

Dependency

Name URL Note
Trust Wallet Core https://github.com/trustwallet/wallet-core.git Source level integration, based on v2.2.10. The code added by JuBiter is identified as "JuBiter-defined".
trezor-crypto https://github.com/trezor/trezor-crypto.git Source level integration, based on 'master'. The code added by JuBiter is identified as "JuBiter-defined".
JSON for Modern C++ https://github.com/nlohmann/json.git Source level integeration, based on v3.9.1.
C++ Big Integer Library https://mattmccutchen.net/bigint Source level integeration, based on 'bigint-2010.04.30.tar.bz2.
uint256_t https://github.com/calccrypto/uint256_t.git An unsigned 256 bit integer type for C++.
sr25519-crust https://github.com/Warchant/sr25519-crust.git Library level integeration, based on master.
Bluetooth communication library for JuBiter Blade & Bio --- JuBiter developed.
NFC communication library for JuBiter Lite --- JuBiter developed.

Code branch management

  • 'Master' is the development line, continuously integrated development of new coins and SDK features.
  • 'v2.x.x' is the current version of Jubiter Wallet 2.0.

Compiler Installation

** Using CMake to build JuBiter SDK project **

  1. Install CMake 3+.
  2. For MacOS & Linux, you need install hidapi-dev.
  3. For Windows, we don't support using visual stutio, should install hidapi-dev in a Cygwin environment.
  4. Android requires NDK20+ installed.
git submodule update --init --recursive

macOS

  • Please use Brew-v3.18.4, because Brew-v3.16 and v3.19 are not guaranteed to succeed, There may be problems with not finding the framework.
  • Because of the bug of CMake, we couldn't build FatLib, packaging need points platform, see.
  • Temporarily closed RPATH, if you need to refer to 'RPATH handling '
mkdir buildMacOS & cd buildMacOS
cmake -G Xcode -DCMAKE_OSX_ARCHITECTURES=x86_64 ..
cmake --build . --config Release

Linux, Cygwin

mkdir build & cd build
cmake ..
make

Android

You can import CMake directly into your Android Studio project, or you can use it from the command line Android_ABI can be armeabi-v7a, arm64-v8a, x86, x86_64, MIPS, mips64.

mkdir buildAndroid & cd buildAndroid

cmake -G "Unix Makefiles" -DANDROID_ABI=arm64-v8a -DCMAKE_BUILD_TYPE=Release -DANDROID_STL=c++_static -DCMAKE_TOOLCHAIN_FILE=/path/to/sdk/ndk-bundle/build/cmake/android.toolchain.cmake ..

make

iOS

mkdir buildIOS & cd buildIOS
cmake .. -G Xcode -DCMAKE_TOOLCHAIN_FILE=../deps/ios-cmake/ios.toolchain.cmake -DENABLE_BITCODE=0 -DPLATFORM=OS64
cmake --build . --config Release

macOS Xcode Project file generation

mkdir build & cd build
cmake -G Xcode ..

Special Note for macOS

Remove dot-underscore files. Merges ._* files with corresponding native files. When got error like :

xxx/JubiterSDK_C/src/._JUB_SDK_DEV.cpp:2:3932: error: 
      source file is not valid UTF-8
  ...<FF><FF>
     ^
xxx/JubiterSDK_C/src/._JUB_SDK_DEV.cpp:2:3933: error: 
      source file is not valid UTF-8
  ...<FF>
     ^

Using command to solves this problem:

dot_clean <directory>

JuBiter SDK for Production tools

mkdir build & cd build
cmake -DdevOnly=1 ..
make

SDK encapsulation for other languages

  • JuBiter SDK for Android integration sample code
  • JuBiter SDK for iOS integration sample code
    • For Objective-C integration in the 'ObjC' directory.
    • For Swift integration is not yet implemented, but it is in the plan.
    • Other two directories are integrations using the Jubiter Wallet protocol.

Demo reference