Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #463

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #463

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,28 @@

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
* W3C-VC JWT credentials
* W3C-VC JSON-LD ed25519 credentials using StatusList 2021
* W3C-VC JSON-LD BBS2023 credentials using accumulators for revocation
* W3C-VC JSON-LD BBDT16 credentials using accumulators for revocation

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).
This JavaScript SDK depends on:
* The [Dock Rust Crypto Library](https://github.com/docknetwork/crypto)
* The [TypeScript wrapper to the Dock Crypto Library](https://github.com/docknetwork/crypto-wasm-ts)
* [The Arkworks math library](https://github.com/arkworks-rs/algebra)

You are welcome to explore the [tutorials](./tutorials) and [examples](./examples) to get a basic understanding.

## Monorepository Packages

Features five packages, such as
This repository builds five packages:

- [`@docknetwork/credential-sdk`](./packages/credential-sdk) - An API-agnostic Javascript library for working with Verifiable Credentials, DIDs, Claim Deduction, and more.
- [`@docknetwork/dock-blockchain-api`](./packages/dock-blockchain-api) - A Javascript library built with PolkadotJS, for use with the [Dock Substrate Node] (https://github.com/docknetwork/dock-substrate) or our public main/test networks.*
- [`@docknetwork/dock-blockchain-modules`](./packages/dock-blockchain-modules) - A JavaScript library designed for handling credential SDK elements (DIDS, Accumulators, etc) on the Dock blockchain.
- [`@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`.
Expand All @@ -33,4 +37,5 @@ In essence, the architecture is structured as follows:
* 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
* Revocation registries based on StatusList2017
* [Anchoring content to the chain](./examples/anchor.js)
Loading