https://github.com/hypersign-protocol/hid-ssi-js-sdk
Java script sdk for creating and verifying dids, diddocs, verifiable credentials and verifiable presentations.
https://github.com/hypersign-protocol/hid-ssi-js-sdk
did diddoc identity javascript npm-package sdk verifiable-credentials verifiable-presentation
Last synced: 5 months ago
JSON representation
Java script sdk for creating and verifying dids, diddocs, verifiable credentials and verifiable presentations.
- Host: GitHub
- URL: https://github.com/hypersign-protocol/hid-ssi-js-sdk
- Owner: hypersign-protocol
- Created: 2020-09-06T02:32:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2026-01-14T05:32:26.000Z (5 months ago)
- Last Synced: 2026-01-14T09:17:27.001Z (5 months ago)
- Topics: did, diddoc, identity, javascript, npm-package, sdk, verifiable-credentials, verifiable-presentation
- Language: JavaScript
- Homepage:
- Size: 3.64 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hypersign Self Sovereign Identity (SSI) SDK 
This SDK is an implementation of proposed [DID](https://www.w3.org/TR/did-core/) framework by the [W3C Credential Community Group](https://w3c-ccg.github.io/).
## Building
```sh
npm i
npm run build
```
## Testing
```bash
## Run this to test all features
npm run test
## OR Run individual test cases
npm run test-did
npm run test-schema
npm run test-credential
npm run test-presentation
```
## Install
```js
npm i https://github.com/hypersign-protocol/hid-ssi-js-sdk --save
```
**Supported node version: ^v16**
## Usage
```javascript
// Import SSI SDK
import { HypersignSSISdk } from "hs-ssi-sdk";
// Instantiate SSI SDK
const hsSdk = new HypersignSSISdk(
offlineSigner,
namespace: 'testnet'
nodeRpcEndpoint: "https://rpc.jagrat.hypersign.id", // RPC
nodeRestEndpoint: "https://api.jagrat.hypersign.id" // REST Endpoint
);
// Mandatory method call to initialize offlineSigner
await hsSdk.init();
// Exposes these 4 instance of objects
const hypersignDID: HypersignDID = hsSdk.did;
const hypersignVC: HypersignVerifiableCredential = hsSdk.vc;
const hypersignVP: HypersignVerifiablePresentation = hsSdk.vp;
const hypersignSchema: HypersignSchema = hsSdk.schema;
```
### OfflineSigner
You may follow this [this code snnipet](https://github.com/hypersign-protocol/hid-ssi-js-sdk/blob/develop/src/tests/config.ts) for creating OfflineSigner
```js
offlineSigner = await createWallet(mnemonic);
```
## APIs
### Hypersign DID SDK
Read [documentation](/docs/did.md)
### Hypersign Schema SDK
Read [documentation](/docs/schema.md)
### Hypersign Verifiable Credential SDK
Read [documentation](/docs/vc.md)
### Hypersign Verifiable Presentation SDK
Read [documentation](/docs/vp.md)
## Issue
This sdk is in highly under development. In case you find any bug, kindly report it ASAP. Thank You!