Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/cheqd/node-docs

Technical documentation for cheqd-node, the ledger-side code for cheqd's decentralised identity network
https://github.com/cheqd/node-docs

blockchain cheqd cosmos-sdk decentralized-identity documentation hacktoberfest self-sovereign-identity

Last synced: about 4 hours ago
JSON representation

Technical documentation for cheqd-node, the ledger-side code for cheqd's decentralised identity network

Host: GitHub
URL: https://github.com/cheqd/node-docs
Owner: cheqd
License: other
Created: 2022-05-14T01:51:49.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-12-11T13:12:37.000Z (11 days ago)
Last Synced: 2024-12-11T13:42:29.870Z (11 days ago)
Topics: blockchain, cheqd, cosmos-sdk, decentralized-identity, documentation, hacktoberfest, self-sovereign-identity
Homepage: https://docs.cheqd.io/node
Size: 5.35 MB
Stars: 3
Watchers: 6
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

        # Node documentation for cheqd network

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/cheqd/cheqd-node?color=green\&label=stable%20release\&style=flat-square)](https://github.com/cheqd/cheqd-node/releases/latest) ![GitHub Release Date](https://img.shields.io/github/release-date/cheqd/cheqd-node?color=green\&style=flat-square) [![GitHub license](https://img.shields.io/github/license/cheqd/cheqd-node?color=blue\&style=flat-square)](https://github.com/cheqd/cheqd-node/blob/main/LICENSE)

[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/cheqd/cheqd-node?include\_prereleases\&label=dev%20release\&style=flat-square)](https://github.com/cheqd/cheqd-node/releases/) ![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/cheqd/cheqd-node/latest?style=flat-square) [![GitHub contributors](https://img.shields.io/github/contributors/cheqd/cheqd-node?label=contributors%20%E2%9D%A4%EF%B8%8F\&style=flat-square)](https://github.com/cheqd/cheqd-node/graphs/contributors)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/cheqd-node/dispatch.yml?label=workflows\&style=flat-square)](https://github.com/cheqd/cheqd-node/actions/workflows/dispatch.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/cheqd/cheqd-node/codeql.yml?label=CodeQL\&style=flat-square)](https://github.com/cheqd/cheqd-node/actions/workflows/codeql.yml) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/cheqd/cheqd-node?style=flat-square) ![GitHub repo size](https://img.shields.io/github/repo-size/cheqd/cheqd-node?style=flat-square)

## ℹ️ Overview

[**cheqd**](https://www.cheqd.io) is a public self-sovereign identity (SSI) network for building secure 🔐 and private 🤫 self-sovereign identity systems on [Cosmos](https://cosmos.network) 💫. Our core vision is to add viable commercial models to decentralised digital 🆔

`cheqd-node` is the ledger/node component of the cheqd network tech stack, built using [Cosmos SDK](https://github.com/cosmos/cosmos-sdk) and [Tendermint](https://github.com/tendermint/tendermint).

## ▶️ Quick start for joining cheqd networks

Join our [**cheqd D**](http://cheqd.link/join-cheqd-slack)[**iscord Server**](https://discord.com/invite/4VZszdE7HH) for help, questions, and support if you are looking to join our [mainnet](https://explorer.cheqd.io) or [testnet](https://testnet-explorer.cheqd.io). 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](https://explorer.cheqd.io) is as simple as...

1. Install [the latest stable release](https://github.com/cheqd/cheqd-node/releases/latest) of `cheqd-node` software (currently `v2.x.x`) on a hosting platform of your choice by [following the setup guide](docs/setup-and-configure/).

2. Once you have acquired CHEQ tokens, [promote your node to a validator](docs/validator-guide/)

If successfully configured, your node would become the latest validator on the cheqd mainnet. Welcome to the new digital ID revolution!

### 🚧 Testnet

Our [testnet](https://testnet-explorer.cheqd.io) is the easiest place for developers and node operators to get started if you're not _quite_ ready yet to dive into building apps on our mainnet. To get started...

1. Install [the latest stable release](https://github.com/cheqd/cheqd-node/releases/latest) of `cheqd-node` software (currently `v2.x.x`) on a hosting platform of your choice by [following the setup guide](docs/setup-and-configure/).

2. Acquire testnet CHEQ tokens through [our testnet faucet](https://testnet-faucet.cheqd.io).

3. Once you have acquired CHEQ tokens, [promote your node to a validator](docs/validator-guide/)

## 🧑‍💻 Using cheqd

Once installed, `cheqd-node` can be controlled using the [cheqd Cosmos CLI guide](docs/cheqd-cli/).

### 📌 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](https://docs.cheqd.io/identity/architecture/adr-list/adr-001-cheqd-did-method), DID Documents ("DIDDocs")

* Querying DIDs/DIDDocs using our [Universal Resolver driver](https://docs.cheqd.io/identity/advanced/did-resolver)

* Creating and managing Verifiable Credentials anchored to DIDs on cheqd mainnet

* Creating [on-ledger DID-Linked "resources" (e.g., schemas, visual representations of credentials, etc)](https://docs.cheqd.io/identity/guides/did-linked-resources) that can be used in DIDDocs and Verifiable Credentials. This is used to support [AnonCreds on cheqd](https://docs.cheqd.io/identity/guides/anoncreds)

* Custom [pricing for DID and Resources](https://product.cheqd.io/essentials/why-cheqd/pricing) with burn to manage inflation

* Revocation registry/list support to revoke issued credentials

* Trust registry support to manage accreditations betweeen organisations, using DIDs and DID-Linked Resources

* Holder-pays-issuer and verifier-pays-issuer [payment rails for Verifiable Credential exchange](https://blog.cheqd.io/cheqds-product-vision-for-2022-6a92e8e4d296).

We plan on adding new functionality rapidly and on a regular basis and welcome feedback on our [**cheqd Discord server**](https://discord.com/invite/4VZszdE7HH). 

See our **detailed Product Docs** below for more information:

Product DocsDive into our product docs to learn more about cheqd Studio, Creds and our identity packages & SDKs, including Credo, Veramo, the Universal Resolver and Registrar.https://docs.cheqd.io/product

## 🛠 Developing & contributing to cheqd

`cheqd-node` is written in Go and built using Cosmos SDK. The [Cosmos SDK Developer Guide](https://docs.cosmos.network/) explains a lot of the [basic concepts](https://docs.cosmos.network/v0.46/basics/app-anatomy.html) of how the cheqd network functions.

If you want to build a node from source or contribute to the code, please read our guide to [building and testing](docs/build-and-networks/).

### 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](docs/build-and-networks/) for development purposes.

## 🐞 Bug reports & 🤔 feature requests

If you notice anything not behaving how you expected, or would like to make a suggestion / request for a new feature, please create a [**new issue**](https://github.com/cheqd/cheqd-node/issues/new/choose) and let us know.

## 💬 Community

The [**cheqd Discord**](https://discord.com/invite/4VZszdE7HH) is our primary 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.

## 🙋 Find us elsewhere

[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge\&logo=telegram\&logoColor=white)](https://t.me/cheqd) [![Discord](https://img.shields.io/badge/Discord-7289DA?style=for-the-badge\&logo=discord\&logoColor=white)](http://cheqd.link/discord-github) [![Twitter](https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge\&logo=twitter\&logoColor=white)](https://twitter.com/intent/follow?screen\_name=cheqd\_io) [![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge\&logo=linkedin\&logoColor=white)](http://cheqd.link/linkedin) [![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge\&logo=slack\&logoColor=white)](http://cheqd.link/join-cheqd-slack) [![Medium](https://img.shields.io/badge/Medium-12100E?style=for-the-badge\&logo=medium\&logoColor=white)](https://blog.cheqd.io) [![YouTube](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge\&logo=youtube\&logoColor=white)](https://www.youtube.com/channel/UCBUGvvH6t3BAYo5u41hJPzw/)