If you haven't done so already, please visit the main resource for all things "Indy" to get acquainted with the code base, helpful resources, and up-to-date information: Hyperledger Wiki-Indy.

This is the official SDK for Hyperledger Indy, which provides a distributed-ledger-based foundation for self-sovereign identity. The major artifact of the SDK is a c-callable library; there are also convenience wrappers for various programming languages and Indy CLI tool.

All bugs, stories, and backlog for this project are managed through Hyperledger's Jira in project IS (note that regular Indy tickets are in the INDY project instead...). Also, join us on Hyperledger's Rocket.Chat at #indy-sdk to discuss.

Indy SDK release process defines the following release channels:

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

Please refer to release workflow for more details.

It is recommended to install packages with APT:

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 libindy

{release channel} must be replaced with master, rc or stable to define corresponded release channel. See section "Release channels" for more details.

1. follow to https://repo.sovrin.org/windows/libindy/{release-channel}.
2. download last version of libindy.
3. unzip archives to directory, where you want to save working library.
4. After unzip you will get next structure of files:

• Your working directory
  • include
    • ...
  • lib
    • indy.dll
    • libeay32md.dll
    • libsodium.dll
    • libzmq.dll
    • ssleay32md.dll

include contains c-header files which contains all necessary declarations that may be need for your applications.

lib contains all necessary binaries which contains libindy and all it's dependencies. You must add to PATH environment variable path to lib. It's necessary for dynamic linkage your application with libindy.

{release channel} must be replaced with master, rc or stable to define corresponded release channel. See section "Release channels" for more details.

See wrapper iOS install documentation.

Now we haven't prebuild library in some shared place. You can build library yourself. Please refer to How-to-build section.

After build add to LD_LIBRARY_PATH and to DYLD_LIBRARY_PATH environment variables path to builded library. It's necessary for dynamic linkage your application with libindy. At first dynamic linker browse library in LD_LIBRARY_PATH, if library in your application doesn't include directory names. If library in your application include any directory name, then dynamic linker will search library in DYLD_LIBRARY_PATH(not LD_LIBRARY_PATH). So for reliability we recommend you set both this variables.

Now we haven't prebuild library in some shared place. You can build library yourself. Please refer to How-to-build section.

After build add to LD_LIBRARY_PATH environment variable path to builded library. It's necessary for dynamic linkage your application with libindy.

• Ubuntu based distro (Ubuntu 16.04)
• RHEL based distro (Amazon Linux 2017.03)
• Windows
• MacOS

Start local nodes pool on 127.0.0.1:9701-9708 with Docker:

docker build -f ci/indy-pool.dockerfile -t indy_pool .
docker run -itd -p 9701-9708:9701-9708 indy_pool

Dockerfile ci/indy-pool.dockerfile supports optional pool_ip param that allows changing ip of pool nodes in generated pool configuration. The following commands allow to start local nodes pool in custom docker network and access this pool by custom ip in docker network:

docker network create --subnet 10.0.0.0/8 indy_pool_network
docker build --build-arg pool_ip=10.0.0.2 -f ci/indy-pool.dockerfile -t indy_pool .
docker run -d --ip="10.0.0.2" --net=indy_pool_network indy_pool

Note that for Windows and MacOS this approach has some issues. Docker for these OS run in their virtual environment. First command creates network for container and host can't get access to that network because container placed on virtual machine. You must appropriate set up networking on your virtual environment.

The following wrappers are tested and complete. There is also active work on wrappers for Go and node.js; visit #indy-sdk on Rocket.Chat for details.

• .Net
• Java
• Python
• iOS

• Indy CLI

This extended tutorial shows how the whole ecosystem works, and how functions in the SDK can be used to construct rich clients. (You may also want to look at the older guide that explored the ecosystem via command line. That material is being rewritten but still contains some useful ideas.)

• Libindy Getting-Started Guide

Short, simple tutorials that demonstrate how to accomplish common tasks are also available. See the doc/how-tos folder.