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:
- 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.
We highly recommend you check out the docs 🗺️
You will need the following:
- Bash
- Rust (cargo) and wasm-pack installed.
- Node JS Version (20/LTS Recommended)
- Protobuf compiler (https://protobuf.dev/installation/)
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-sdkor
yarn add @hyperledger/identus-sdkPlease 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 buildnpx nx run @hyperledger/identus-sdk:testRequires you to have a Cloud Agent running and to configure the appropiate env vars in ./integration-tests/e2e-tests/.env with the following content:
AGENT_URL=http://localhost:8085 MEDIATOR_OOB_URL=http://localhost:8080/invitationOOB SECP256K1_PUBLISHED_DID= SECP256K1_JWT_SCHEMA_GUID= SECP256K1_ANONCRED_DEFINITION_GUID= ED25519_PUBLISHED_DID= ED25519_JWT_SCHEMA_GUID= ED25519_ANONCRED_DEFINITION_GUID= Running the tests is pretty straight forward
npx nx run e2e:testThis still requires the .env var in ./integration-tests/e2e-tests/.env properly configured.
yarn testIf you have any issues while building you can try building from docker (this runs exaclty the same build):
docker build -t atalaprismwalletsdkts:latest "." docker run -v $(pwd)/build:/app/build atalaprismwalletsdkts:latest