indy-sdk
The Indy SDK has been deprecated in favor of the Indy and Aries shared libraries. Please use the following libraries and projects to replace your use of the Indy SDK.
A module for interacting with the Indy Node ledger.
A secure (encrypted at rest) storage and a key management service suitable for use with Hyperledger Aries agents and possibly other digital trust agents. Askar is a replacement implementation (with lessons learned!) of the indy-wallet part of the Hyperledger Indy SDK. Askar has been demonstrated to be more performant and stable than the Indy SDK when under comparable load.
Rust library and reference implementation of the Anoncreds V1.0 specification. Supporting ledger agnostic anoncreds.
The a feature parity replacement for the indy-cli from the indy-sdk.
This is the official SDK for Hyperledger Indy, which provides a distributed-ledger-based foundation for self-sovereign identity. Indy provides a software ecosystem for private, secure, and powerful identity, and the Indy SDK enables clients for it. 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, make sure to join us on Hyperledger's Rocket.Chat at #indy-sdk to discuss. You will need a Linux Foundation login to get access to these channels
If you have just started learning about self-sovereign identity, here are some resources to increase your understanding:
This extended tutorial introduces Indy, explains how the whole ecosystem works, and how the functions in the SDK can be used to construct rich clients: Indy-SDK Getting-Started Guide
Hyperledger Indy Working Group calls happen every Thursday at 8amPT, 9amMT, 11amET, 4pmBST. Add to your calendar and join from any device: https://zoom.us/j/232861185
A recent webinar explaining self-sovereign identity using Hyperledger Indy and Sovrin: SSI Meetup Webinar
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.
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.
The major artifact of the SDK is a C-callable library that provides the basic building blocks for the creation of applications on the top of Hyperledger Indy. It is available for most popular desktop, mobile and server platforms.
A set of libindy wrappers for developing Indy-based applications in your favorite programming language. Indy SDK provides libindy wrappers for the following programming languages and platforms:
Indy CLI is the official command line interface that helps Indy developers and administrators.
Libnullpay is a libindy plugin that can be used for development of applications that use the Payments API of Indy SDK.
Libvcx is a c-callable library built on top of libindy that provides a high-level credential exchange protocol. It simplifies creation of agent applications and provides better agent-2-agent interoperability for Hyperledger Indy infrastructure.
This library is currently in an experimental state and is not part of official releases.
A set of libvcx wrappers for developing vcx-based applications in your favorite programming language.
Indy SDK provides libvcx wrappers for the following programming languages and platforms:
These wrappers are currently in experimental state and it is not part of official releases.
LibVCX can be used with mediator agency which enables asynchronous communication between 2 parties.
Short, simple tutorials that demonstrate how to accomplish common tasks are also available. See the docs/how-tos folder.
The 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 our release workflow for more details.
It is recommended to install the SDK packages with APT:
sudo apt-get install ca-certificates -y
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys CE7709D068DB5E88
sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb (xenial|bionic) {release channel}"
sudo apt-get update
sudo apt-get install -y {library}https://repo.sovrin.org/windows/{library}/{release-channel}.Your working directory for libindyinclude...libindy.dlllibeay32md.dlllibsodium.dlllibzmq.dllssleay32md.dllinclude 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.
{library} must be replaced with libindy, libnullpay, libvcx or indy-cli.
See wrapper iOS install documentation.
https://repo.sovrin.org/android/{library}/{release-channel}..so files.Your working directory for libindyinclude...liblibindy.solibindy_shared.solibindy.ainclude contains c-header files which contains all necessary declarations
that may be need for your applications.
lib contains three types of binaries.
libindy.so - This is a shared library which is statically linked with all the depenedencies.
You dont need to sidelaod other dependencies like zmq, sodium and openssl to android app if you use this.
libindy_shared.so - This is pure shared library. It is not dynamically linked to its dependencies.
You need to sideload the binaries with its dependencies. You can download the needed pre-built dependencies from here
libindy.so before loading it into the app. This will help you in having the compatibility with existing wrappers.libindy.a - This is a static library, which is compiled with NDK.
{library} must be replaced with libindy, libnullpay or libvcx.
{release channel} must be replaced with rc or stable to define corresponded release channel. See section "Release channels" for more details.
Note :
https://repo.sovrin.org/rpm/{library}/{release-channel}.rpm -i library-version.rpm.{library} must be replaced with libindy, libnullpay, libvcx, indy-cli to define corresponded library.
{release channel} must be replaced with master, rc or stable to define corresponded release channel. See section "Release channels" for more details.
https://repo.sovrin.org/macos/{library}/{release-channel}.Your working directoryinclude - contains c-header files which contains all necessary declarations that may be need for your applications....lib - contains lNo open issues yet, or sync has not completed.