cheqd-node

README

cheqd: Node Documentation

cheqd is a purpose-built network for decentralised identity.

cheqd-node is the server/node portion of the cheqd network stack, built using Cosmos SDK and Tendermint.

Quick start for joining cheqd networks

Join our cheqd Community Slack for help, question, and support if you are looking at joining either the cheqd mainnet or the testnet/ Either the cheqd team, or one of your fellow node operators will be happy to offer some guidance.

Mainnet

Getting started as a node operator on the cheqd network mainnet requires the following steps:

1. Install the cheqd-node software (version 0.3.1+) on a hosting platform of your choice.
2. When you have a node successfully installed, please fill out our mainnet node operator onboarding form. You will need to have the following details on hand to fill out the form:
   1. Node ID for your node
   2. IP address / DNS record that points to the node (if you're using an IP address, a static IP is recommended)
   3. Peer-to-peer (P2P) connection port (defaults to 26656)
   4. Validator account address (begins with cheqd)
   5. Moniker (Nickname/moniker that is set for your mainnet node)
3. Once you have received or purchased your tokens, promote your node to a validator.
4. If successfully configured, your node would become the latest validator on the cheqd mainnet!

Testnet

Joining the cheqd tetsnet is very similar to the instructions above for mainnet, with a few key differences:

1. Install v0.2.7 of cheqd-node (instead of v0.3.1+)
2. Fill our testnet node operator onboarding form with the same details as above.

Usage

Once installed, cheqd-node can be controlled using the cheqd Cosmos CLI guide.

Currently supported functionality

• Basic token functionality for holding and transferring tokens to other accounts on the same network
• Creating, managing, and configuring accounts and keys on a cheqd node
• Staking and participating in public-permissionless governance
• Governance framework for public-permissionless self-sovereign identity networks
• Creating did:cheqd method DIDs, DID Documents ("DIDDocs), and querying full DIDDocs

Upcoming functionality

A non-exhaustive list of future planned functionality (not necessarily in order of priority) is highlighted below:

• Creating and managing Verifiable Credentials anchored to DIDs on cheqd mainnet
• Querying DIDDoc fragments and specific resources
• Defining Schemas and Credential Definitions

We plan on adding new functionality rapidly and on a regular basis. We will be sharing regular updates through our Live Product Updates page which includes our product roadmap, release notes, node operator FAQs and more. We welcome feedback on our cheqd Community Slack workspace.

Building from source

cheqd-node is created with Starport. If you want to build a node from source or contribute to the code, please read our guide to building and testing.

Creating a local network

If you are building from source, or otherwise interested in running a local network, we have instructions on how to set up a new network for development purposes.

Community

The cheqd Community Slack is our chat channel for the open-source community, software developers, and node operators.

Please reach out to us there for discussions, help, and feedback on the project.

Bug Reporting & New Feature Requests

If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please submit a bug_report or feature_request by creating a New Issue and selecting the relevant template.

Social media

Follow the cheqd team on our social channels for news, announcements, and discussions.

• @cheqd_io on Twitter
• @cheqd on Telegram (with a separate announcements-only channel)
• Medium blog
• LinkedIn