The following will explain how to use the SDK in your project, how to prepare your development environment if you wish to contribute and some basic considerations around the project.
This SDK provides a library and documentation for developers to build Android and JVM-connected SSI applications with Identus.
Edge Agent is a self-sovereign identity (SSI) platform and service suite for verifiable data and digital identity. Built on Cardano, 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:
- edge-agent-sdk-swift - Repo that implements Edge Agent for Apple platforms in Swift.
- edge-agent-sdk-ts - Repo that implements Edge Agent for Browser and Node.js platforms in Typescript.
- identus-cloud-agent - Repo that contains the platform Building Blocks.
- mediator - Repo for DIDComm V2 Mediator.
Edge Agent SDK KMP provides the following building blocks to create, manage and resolve decentralized identifiers, issue, manage and verify verifiable credentials, establish and manage trusted, peer-to-peer connections and interactions between DIDs, and store, manage, and recover verifiable data linked to DIDs.
- Apollo: Building block that provides a suite of cryptographic operations.
- Castor: Building block that provides a suite of DID operations in a user-controlled manner.
- Pollux: Building block that provides a suite of credential operations in a privacy-preserving manner.
- Mercury: Building block that provides a set of secure, standards-based communications protocols in a transport-agnostic and interoperable manner.
- Pluto: Building block that provides an interface for storage operations in a portable, storage-agnostic manner.
- EdgeAgent: EdgeAgent, using all the building blocks, provides an agent that can provide a set of high-level DID functionalities.
To get started with the Edge Agent SDK KMP, you can set up the SDK and start a new project or integrate it into an existing project. Before you start, make sure you have the following installed on your development machine:
- Android: API level 21 and above.
- Kotlin 1.9.24 or later.
- JVM: 17 or later.
To integrate the SDK into an existing project, you have to import the SDK into your project:
implementation("org.hyperledger.identus:edge-agent-sdk:<latest version>")