Skip to content

A JavaScript SDK built ontop of PolkadotJS for interaction with Dock's Substrate node and compatible chains

License

Notifications You must be signed in to change notification settings

docknetwork/sdk

Repository files navigation

Dock SDK

Overview

The Dock SDK is an opensource library that powers Dock's SaaS API. It provides the credential management, cryptography, and blockchain storage features for Dock's supported credential variants:

  • W3C VC JSON-LD ed25519 credential using StatusList 2021 for revocation targetted at interoperability
  • W3C VC JSON-LD BBS credential using accumulators for revocation targetted at privacy
  • W3C VC JSON-LD KVAC credential using accumulators for revocation allowing monetization of credentials

Most of the SDK is written in JavaScript / TypeScript with safety-critical code written in Rust. The SDK depends on the Arkworks math library.

Monorepository Packages

Features five packages, such as

You are welcome to explore the tutorials and examples to get a basic understanding.

In essence, the architecture is structured as follows:

  • The fundamentals of VC, including types, cryptography, and abstract modules, are housed in @docknetwork/credential-sdk.
  • Specific implementations for the Dock and Cheqd blockchain modules can be found in @docknetwork/dock-blockchain-modules* and @docknetwork/cheqd-blockchain-modules, respectively.
  • Basic blockchain connectors for the Dock and Cheqd blockchain are available through @docknetwork/dock-blockchain-api* and @docknetwork/cheqd-blockchain-api.

Deprecated Features

Some features of the SDK are deprecated and will be removed in a future release:

  • StatusList2017

About

A JavaScript SDK built ontop of PolkadotJS for interaction with Dock's Substrate node and compatible chains

Resources

License

Stars

Watchers

Forks

Packages

No packages published