An open API service indexing awesome lists of open source software.

https://github.com/meshplus/bitxid

A DID framework comply with W3C DID(Decentralized Identifiers) supporting multiple storage and multiple methods.
https://github.com/meshplus/bitxid

Last synced: 5 months ago
JSON representation

A DID framework comply with W3C DID(Decentralized Identifiers) supporting multiple storage and multiple methods.

Awesome Lists containing this project

README

          

# BitXID

![build](https://github.com/meshplus/bitxid/workflows/build/badge.svg)
[![codecov](https://codecov.io/gh/bitxhub/bitxid/branch/master/graph/badge.svg)](https://codecov.io/gh/bitxhub/bitxid)
[![Go Report Card](https://goreportcard.com/badge/github.com/meshplus/bitxid)](https://goreportcard.com/report/github.com/meshplus/bitxid)

BitXID is a DID framework which complys with W3C DID(Decentralized Identifiers) specifications. It has the following features:

1. **Multiple storage management**: BitXID offers both on-chain storage and off-chain storage for DID storage. The best practice will be store small amounts of data(e.g. id, status, etc.) on-chain while store large amounts of data(e.g. public keys, authentication methods, etc.) off-chain(e.g. IPFS), and combines them by store hash of the data on-chain.
2. **Multiple methods management**: not only can BitXID be used to build digital identity for a blockchain but also it can be to build digital identity ecosystem for a blockchain network(i.e. cross-chain platform).

## Installation

Install `bitxid` package:

```shell
go get -u github.com/meshplus/bitxid
```

import it in your code:

```go
import "github.com/meshplus/bitxid"
```

## Example

BitXID is already used by several great projects, among which [BitXHub](https://github.com/meshplus/bitxhub) is one of them. BitXHub DID has already registered on [DIF Universal Resolver](https://github.com/decentralized-identity/universal-resolver). You can find BitXHub DID Implementation [here](https://github.com/meshplus/did-registry) and the design of BitXHub DID in the latest [BitXHub WhitePaper](https://upload.hyperchain.cn/BitXHub白皮书.pdf).

## Usage

Usage guide documantation can be found in [here](./docs/usage-chn.md).

## Contact

Email: bitxhub@hyperchain.cn

Wechat: If you‘re interested in BitXID or BitXHub, please add the assistant to join our community group.

## License

BitXID is under the APACHE LICENSE VERSION 2.0.