Identus TypeScript SDK

Identus is a self-sovereign identity (SSI) platform and service suite for verifiable data and digital identity. Built on Cardano, as a distributed ledger, it offers core infrastructure for issuing DIDs (Decentralized identifiers) and verifiable credentials, alongside tools and frameworks to help expand your ecosystem. The complete platform is separated into multiple repositories:

• Cloud Agent - Repo that contains the Cloud Agent that provides self-sovereign identity services to build products and solutions.
• Mediator - Repo for the DIDComm V2 Mediator.
• SDK TS - Repo for the Typescript SDK.

We also have SDKs for other platforms:

• SDK Swift - Repo for the Swift SDK.
• SDK KMP - Repo for the Kotlin Multi-Platform SDK.

SDK Overview

• Apollo: Provides a suite of necessary cryptographic operations.
• Castor: Provides a suite of operations to create, manage and resolve decentralized identifiers.
• Mercury: Provides a suite of operations for handling DIDComm V2 messages.
• Pluto: Provides an interface for storage operations in a portable, storage-agnostic manner.
• Agent: A component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols.

Getting started

We highly recommend you check out the docs :world_map:

Requirements

You will need the following:

• Bash
• Rust (cargo) and wasm-pack installed.
• Node JS Version (20/LTS Recommended)
• Protobuf compiler (https://protobuf.dev/installation/)

Install

NOTE: The package was renamed from @hyperledger/identus-edge-agent-sdk to @hyperledger/identus-sdk. Modify the scripts if you ready to use the new package accordingly.

npm i @hyperledger/identus-sdk

or

yarn add @hyperledger/identus-sdk

Building from source

Please make sure that all the requirements are met, then run the following commands:

sh externals/run.sh -x update # To fetch and initialize anoncreds and didcomm submodules
yarn build

Testing

In order to run the unitary tests tests simply run yarn test or with coverage:

yarn coverage

Testing e2e

Requires you to have Cloud Agent and Mediator running.

To run the tests from root level, simply:

./integration-tests/e2e-tests/run.sh

Read more

If you have any issues while building you can try building from docker (this runs exactly the same build):

docker build -t identus-sdk-ts:latest "."
docker run  -v $(pwd)/build:/app/build identus-sdk-ts:latest