hid-node

README

Hypersign Identity Network

The Hypersign Identity Network is a permissionless blockchain network to manage digital identity and access rights. It aims to empower humans to gain control of their data and access on the internet by providing scalable, interoperable and secure verifiable data registry (VDR) to implement use cases on Self Sovereign Identity (SSI) principles. The Hypersign Identity Network is built using Cosmos-SDK and is fully compatible with W3C DID specifications.

Features

• Register, Update and Deactivate DID Documents
• Store/Update Credential Schema
• Store/Update status of a Verifiable Credential
• Stake $HID tokens
• Submit Governance Proposals
• Transfer $HID tokens within and across different Tendermint-based blockchains

Prerequisite

Following are the prerequisites that needs to be installed:

• Golang (Installation Guide: https://go.dev/doc/install) (version: 1.18+)
• make

Get started

Local

Clone the repository and install the binary:

git clone https://github.com/hypersign-protocol/hid-node.git
cd hid-node
make install

The binary hid-noded will be generated in $GO_PATH/bin directory. To explore its functionalities, type hid-noded --help in a seperate terminal window.

Running the Blockchain

To start a single-node blockchain, run the following command to initialize the node:

sh ./scripts/localnet-single-node/setup.sh

Note: The above script requires jq to be installed.

Run the hid-node:

hid-noded start --home ~/.hid-node

Docker

To run a single node hid-node docker container, follow the below steps:

1. Pull the image:

   docker pull ghcr.io/hypersign-protocol/hid-node:latest
   

2. Run the following:

   docker run --rm -d \
    -p 26657:26657 -p 1317:1317 -p 26656:26656 -p 9090:9090 \
    --name hid-node-container \
    ghcr.io/hypersign-protocol/hid-node start
   

Documentation

Topic	Reference
Decentralised Identifiers	https://docs.hypersign.id/self-sovereign-identity-ssi/decentralized-identifier-did
Credential Schema	https://docs.hypersign.id/self-sovereign-identity-ssi/schema
Verifiable Credential Status	https://docs.hypersign.id/self-sovereign-identity-ssi/verifiable-credential-vc/credential-revocation-registry