README.md

Welcome to Atala PRISM TypeScript SDK

Atala PRISM TypeScript SDK provides a library and documentation for developers to build TypeScript-based SSI applications with Atala PRISM. It provides a set of utilities for building SSI Edge Agents speaking DIDComm V2 protocols.

Basic considerations

Atala PRISM

Atala PRISM 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 in multiple repositories:

• atala-prism-wallet-sdk-swift - Repo that implements Atala PRISM for Apple platforms in Swift.
• atala-prism-wallet-sdk-kmm - Repo that implements Atala PRISM for Apple platforms in kmm, jvm.
• atala-prism-wallet-sdk-ts - Repo that implements Atala PRISM for Browser and NodeJS platforms in TypeScript.
• atala-prism-building-blocks - Repo that contains the platform Building Blocks.

SDK Overview

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

Getting started

This repository includes a browser and a nodejs demo application, and also a step by step documented process.

Running a demo project

To be able to run the demos, we have to build prism-wallet-sdk-ts.

From the repository, cd into {path}/prism-wallet-sdk-ts:

npm i
npm run build

For NodeJS

After building prism-wallet-sdk-ts, cd into {path}/prism-wallet-sdk-ts/demos/node:

npm i
node index.js

:::note The installation in the demos/node directory requires the build folder from the wallet-sdk to be available. :::

For browser

After building prism-wallet-sdk-ts, cd into the demo directory "demos/browser"

cd demos/browser
npm i
npm run start

Demo development mode

To run browser demo app, just run npm run dev:browser and browser will automatically open and load the demo app.

To run Node.js demo app, run npm run dev:node to build the demo app and then run it with node build/node-test/index.js.

2. To see how the step by steps examples can guide you refer to each section inside docs folder, Apollo, Castor, Pollux, Mercury, Pluto, Agent

3. Jump straight into the SDK-REFERENCE