Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 3.88 KB

README.md

File metadata and controls

65 lines (40 loc) · 3.88 KB
Raw

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 testnet

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

  1. Install the cheqd-node software on a hosting platform of your choice.
  2. When you have a node successfully installed, please fill out our node operator onboarding form so that you can acquire CHEQ testnet tokens required for staking on the network. 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)
  3. Once you have received your tokens, promote your node to a validator.
  4. If successfully configured, your node would become the latest validator on the cheqd Testnet! Say hi to the other node operators on the #testnet-node-operators channel.

Any time you have questions or need support, join our cheqd Community Slack and ask for help.

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

Upcoming functionality

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

  • DID method specification
  • Creating and querying DIDDocs
  • Creating and managing Verifiable Credentials anchored to DIDs on cheqd testnet

We plan on adding new functionality rapidly and on a regular basis. We are also exploring mechanisms to showcase our product roadmap and gather feedback from our community members. 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.

Social media

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