https://github.com/docknetwork/sdk
A JavaScript SDK built ontop of PolkadotJS for interaction with Dock's Substrate node and compatible chains
https://github.com/docknetwork/sdk
Last synced: 5 months ago
JSON representation
A JavaScript SDK built ontop of PolkadotJS for interaction with Dock's Substrate node and compatible chains
- Host: GitHub
- URL: https://github.com/docknetwork/sdk
- Owner: docknetwork
- License: mit
- Created: 2020-03-04T20:42:03.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-04-17T14:40:04.000Z (about 1 year ago)
- Last Synced: 2025-05-13T14:22:06.306Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://www.dock.io
- Size: 20.1 MB
- Stars: 86
- Watchers: 14
- Forks: 20
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# `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](https://github.com/arkworks-rs/algebra).
## Monorepository Packages
Features four packages, such as
- [`@docknetwork/credential-sdk`](./packages/credential-sdk) - An API-agnostic Javascript library for working with Verifiable Credentials, DIDs, Claim Deduction, and more.
- [`@docknetwork/cheqd-blockchain-api`](./packages/cheqd-blockchain-api) - A Javascript library built atop of `@cheqd/sdk` that allows to interact with the `Cheqd` blockchain.
- [`@docknetwork/cheqd-blockchain-modules`](./packages/cheqd-blockchain-modules) - A JavaScript library created for managing credential SDK components such as DIDs, accumulators etc on the Cheqd blockchain.
You are welcome to explore the [tutorials](./tutorials) and [examples](./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
* Dock blockchain will be sunset in 2025. [More information.](https://www.dock.io/post/dock-and-cheqd-form-alliance-to-accelerate-global-adoption-of-decentralized-id#stronglong-termstrong)
Some features of the SDK are deprecated and will be removed in a future release:
* StatusList2017