The purpose of this @cheqd/sdk NPM package is to provide base functionality for interacting with cheqd network. It combines the DID and DID-Linked Resources modules, and putting them into a Cosmos transaction wrapper using CosmJS.
This package is consumed by other SDKs/libraries such as Veramo SDK for cheqd and Hyperledger Aries Framework JavaScript (AFJ) to add cheqd network support.
This package includes:
- TypeScript Protobuf definitions for custom cheqd Cosmos SDK modules
- CosmJS, for base Cosmos SDK module functions
Our identity documentation site provides tutorials for utilising the identity features on cheqd network.
With this SDK, developers are able to:
- ✅ Create a
did:cheqdmethod DID - ✅ Update a
did:cheqdmethod DID - ✅ Deactivate a
did:cheqdmethod DID - ✅ Create or update a DID-Linked Resource
- ✅ Raw payload creator: Enables users to generate a valid raw DID payload which is ready to be populated, depending on the use case. For example,
did-provider-cheqdleverages this helper in the CLI application. - ✅ Identity key converter: Enables users to convert specific key formats from different kinds of SDKs, by transforming the input keys into valid sign inputs for a cheqd specific DID transaction (e.g.
createDidDocTx,updateDidDocTx). For example, the Veramo SDK for cheqd uses this helper to enable users to pass a key in a Veramo SDK specific format to a cheqd sign input keys interface.
To install this NPM package in a project that needs ESM builds, use our latest release channel to install the stable version:
npm install @cheqd/sdk@latestTo install beta releases instead, use our -develop releases from the beta channel:
npm install @cheqd/sdk@betaTo install this NPM package in a project that needs CommonJS builds, use our cjs release channel to install the latest stable CommonJS version:
npm install @cheqd/sdk@cjsOur identity documentation site explains how @cheqd/sdk is consumed in Veramo SDK for cheqd (as an example of how this package can be consumed).
Our Discord server is the primary chat channel for our open-source community, software developers, and node operators.
Please reach out to us there for discussions, help, and feedback on the project.
