jovfer/libsovtoken

This is a payment handler library to work with libindy. It may one day be merged into libindy.

Table of Contents

1. LibSovToken
   1. Requirements
      1. Installing Indy-SDK
   2. Running Indy Pool
      1. Build the pool
      2. run the poool
      3. Compiling libsovtoken and running tests
   3. How To Contribute

LibSovToken

Adds Sovrin's token functionality to HyperLedger's Indy-SDK.

Requirements

• Rust Lang (Stable)
• LibIndy (Stable)
• Indy Pool (Provided)

Installing Indy-SDK

1. Ubuntu

   sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
   sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial stable"
   sudo apt-get update
   sudo apt-get install -y libindy>=1.6.0
   

2. macOS

   git clone https://github.com/hyperledger/indy-sdk.git
   cd indy-sdk
   git checkout stable 
   cd libindy
   cargo clean 
   cargo update
   cargo build
   

   Libsovtoken build needs to know how to find Indy-SDK. This is done through the environment variable LIBINDY_DIR.

   Create an environment variable LIBINDY_DIR. Have it point the directory containing indy-sdk binaries.

   Use pwd to get path to current directory

   Add this to your bash profile:

   # EXAMPLE 
   export LIBINDY_DIR='/my/path/to/indy-sdk/libindy/target/debug/'
   

   Note anytime you get latest for indy-sdk, you must rebuild the libraries before building libsovtoken, as the libsovtoken build does not compile indy-sdk.

Running Indy Pool

Build the pool

cd devops/indy-pool/ && docker build -t indy_pool . 

run the poool

docker run -itd -p 9701-9708:9701-9708 indy_pool

Compiling libsovtoken and running tests

1. Make sure you meet the requirements above, including building the projects, if you elect to use source code.

2. Get latest for libsovtoken at https://github.com/sovrin-foundation/libsovtoken.git

3. The source code is in a sub-directory called libsovtoken

4. Run the following commands from the libsovtoken subdirectory

   1. cargo update
   2. cargo build

5. Run the tests to ensure everything is in good order.

   1. cargo test

How to build Libsovtoken from source

• Windows

Installing the Sovtoken

Release channels

The Sovtoken release process defines the following release channels:

• master - development builds for each push to master branch.
• stable - stable releases.

Ubuntu based distributions (Ubuntu 16.04)

It is recommended to install the SDK packages with APT:

sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial {release channel}"
sudo apt-get update
sudo apt-get install -y libsovtoken

Windows

1. Go to https://repo.sovrin.org/windows/libsovtoken/{release-channel}
2. Download last version of libsovtoken.
3. Unzip archives to the directory where you want to save library.

iOS

1. Go to https://repo.sovrin.org/ios/libsovtoken/{release-channel}/libsovtoken-core/.
2. 5 target architecture are supported as of now aarch64-apple-ios, armv7-apple-ios, armv7s-apple-ios, i386-apple-ios, x86_64-apple-ios and universal.
3. Download latest version of libsovtoken.
4. Unzip archives to the directory where you want to save library.

Android

1. Go to https://repo.sovrin.org/android/libsovtoken/{release-channel}.
2. 3 architecture are supported as of now arm,arm64 and x86.
3. Download latest version of libsovtoken.
4. Unzip archives to the directory where you want to save library.

How To Contribute

Please follow the guide here.