TypeScript SDK for cheqd

ℹ️ Overview

The purpose of this @cheqd/sdk NPM package is to provide a mechanism of integrating cheqd functionality in an application without using a 3rd-party SDK like Veramo SDK for cheqd.

This package includes:

• TypeScript Protobuf definitions for custom cheqd Cosmos SDK modules
• CosmJS, for base Cosmos SDK module functions

If you are using Veramo SDK for cheqd, this SDK package is automatically installed and consumed by the @cheqd/did-provider-cheqd Veramo plugin.

🆔 Features

With this SDK, developers are able to:

• ✅ Create a did:cheqd method DID
• ✅ Update a did:cheqd method DID
• ✅ Create Resource within a did:cheqd method DID

🧰 Tooling

• ✅ 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-cheqd leverages 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.

📖 Documentation

Our identity documentation site explains how @cheqd/sdk is consumed in Veramo SDK for cheqd (as an example of how this package can be consumed).

💬 Community

The cheqd Community Slack is our primary chat channel for the open-source community, software developers, and node operators.

Please reach out to us there for discussions, help, and feedback on the project.

🙋 Find us elsewhere