Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 4.84 KB

README.md

File metadata and controls

53 lines (36 loc) · 4.84 KB

Header

Klayr DID Monorepo

Repo Size Build status Coverage report Lerna Version License: Apache 2.0

Welcome to the Klayr DID Monorepo! This repository contains a set of powerful tools and packages that empower sidechain developers to build robust and innovative W3C Decentralized Identifier (DID) and Verifiable Credentials (VC) solutions within the Klayr Ecosystem.

About Klayr

Klayr is an open-source blockchain application platform written in Javascript, designed to bridge the gap between accessibility and web3 adoption. Learn more about Klayr from their official website, as well as it's public GitHub Repository.

About did:klayr Method

did:klayr is a DID method specifically designed for Klayr sidechain, which outlines syntax, data model, and operations that adheres to W3C Decentralized Identifiers (DIDs) Specification.

A did:klayr DID consist of a method, chainspace, namespace, and unique-id that suitable for specific, tailored, self-sovereign identity use case. An example of a did:klayr identifier, is as follows:

did:klayr:enevti:address:kly9gxy8ua2n5sj7eqvtp554hvce8m39sy39sjwzu

Please refer to the did:klayr method spec draft for further explanation. As its still in under active development, community contribution will be much appreciated.

Packages

This monorepo consist of 5 packages, as follows:

Packages Description
klayr-did Klayr DID/VC Development Kit, which bundles @klayr-did/klayr-did-module, @klayr-did/klayr-decentralized-identifier, and @klayr-did/klayr-verifiable-credentials into one single package
@klayr-did/klayr-did-module Klayr module which implements on-chain logic for Klayr decentralized identifiers (DIDs)
@klayr-did/klayr-decentralized-identifier A library to work with W3C Decentralized Identifier (DID) for Klayr sidechains with the Klayr DID module
@klayr-did/klayr-verifiable-credentials A library for working with W3C verifiable credentials (VC) and verifiable presentations (VP) using Klayr DID
klayr-did-docs Documentation website for Klayr DID packages

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.