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.
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 into multiple repositories:
This repository includes a browser and a Node.js demo application, and also a step-by-step documented process to run it.
To be able to run the demos, we have to build prism-wallet-sdk-ts
.
In order to install the package you must have created a github token with access to github repository packages and create a .npmrc file with the follwing content (assumming):
//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}
@input-output-hk:registry=https://npm.pkg.github.com
From the repository root run:
npm i
npm run build
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.
:::
After building prism-wallet-sdk-ts
, cd into the demo directory "demos/browser"
cd demos/browser
npm i
npm run start
This SDK exposes Pluto, a storage interface that should be implemented by the user, in the most appropriate way for a particular use case.
We don't provide a default implementation out of the box at the moment, but we do provide a couple of demo implementations that can be used to get started with demos and testing.
Provided demo implementations are intentionally oversimplified and SHOULD NOT be used in production.
To run the browser demo app, just run npm run dev:browser
, and the browser will automatically open and load the demo app.
To run the 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
.
To see how the step-by-step examples can guide you, refer to each section inside the docs folder: Apollo, Castor, Pollux, Mercury, Pluto, Agent
Jump straight into the SDK-REFERENCE