Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add DistributedComplianceLedger #24

Merged
merged 10 commits into from
Aug 30, 2024
Merged

Add DistributedComplianceLedger #24

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d9c69bd
Create DistributedComplianceLedger.md
jcps07 Jun 20, 2024
eae0177
Update DistributedComplianceLedger.md
jcps07 Jun 20, 2024
b07063b
Update DistributedComplianceLedger.md
jcps07 Jun 25, 2024
cc421d6
MOve DCL to Guides and add header
sammachin Jul 10, 2024
73ff5c1
Merge pull request #1 from sammachin/main
jcps07 Jul 10, 2024
d87c8ee
Update content/Guides/DistributedComplianceLedger.md
sammachin Jul 10, 2024
750209f
Update content/Guides/DistributedComplianceLedger.md
sammachin Jul 10, 2024
b078507
Update content/Guides/_index.md
jcps07 Jul 15, 2024
bc1c98c
Update DistributedComplianceLedger.md
jcps07 Jul 15, 2024
882ed47
Update content/Guides/DistributedComplianceLedger.md
sammachin Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@ The following people have contributed to the contents of this site.
- Ann Olivo
- Jeff Bumgardner
- Joni Thrift
- Juan Carlos Pacheco
- Sam Machin
142 changes: 142 additions & 0 deletions content/Guides/DistributedComplianceLedger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
+++
title = "Distributed Compliance Ledger (DCL)"

chapter = false
weight = 10
+++


## Table of Contents
- [DCL Introduction](#dcl-introduction)
- [Types of nodes that operate in the DCL](#types-of-nodes-that-operate-in-the-dcl)
- [Types of account roles that can interact with the DCL](#types-of-account-roles-that-can-interact-with-the-dcl)
- [Main-Net and Test-Net?](#main-net-and-test-net)
- [Access and Interaction with the DCL](#access-and-interaction-with-the-dcl)
- [Getting an account for writing to the DCL](#getting-an-account-for-writing-to-the-dcl)
- [Interacting with the DCL](#interacting-with-the-dcl)
- [Web User Interface](#web-user-interface)
- [Command Line Interface](#command-line-interface)
- [Observer Nodes](#observer-nodes)
- [Main-Net public ONs](#main-net-public-ons)
- [Test-Net public ONs](#test-net-public-ons)
- [FAQs](#faqs)
- [Why is my Vendor information not listed in the DCL?](#why-is-my-vendor-information-not-listed-in-the-dcl)
- [When should I write my product information to the Main-Net DCL?](#when-should-i-write-my-product-information-to-the-main-net-dcl)
- [Contact](#contact)

## DCL Introduction
The DCL is a blockchain-based system owned and hosted by Alliance members. It is used by the Matter protocol for storing information such as:

| Information | Description | Account Role involved |
| -------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| Vendor | Information about the manufacturer or vendor of a device. | Data is entered by an approved Vendor account. |
| Product | Information about the product device including description, software version, OTA information, etc. | Data is entered by an approved Vendor account. |
| Compliance status | Information about the certification status including certification ID, certification date, etc. | Data is entered by the Alliance's Certification Center account.|
| PAA Root CAs | Information about Product Attestation Authorities (PAA) Root CAs used by commissioners during Device Attestation process. | Data is proposed by the Alliance's Trustee and approved by other DCL Trustees.|
jcps07 marked this conversation as resolved.
Show resolved Hide resolved

Additional information available in the [Distributed Compliance Ledger (DCL) Policies, Procedure and Governance](https://groups.csa-iot.org/wg/members-all/document/26075).

### Types of nodes that operate in the DCL

| Type of Node | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Validator Node (VN) | It participates in creating a "consensus" process to add information into the ledger. |
| Sentry Node (SN) | It doesn\'t participate in consensus and wraps the VN representing it for the rest of the network as one of the ways for DDoS and access protection. |
| Observer Node (ON) | It doesn\'t participate in consensus and is optimized for public data read and authenticated write interactions with the ledger. |
jcps07 marked this conversation as resolved.
Show resolved Hide resolved

### Types of account roles that can interact with the DCL

| Account Role | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |
| Trustee | It is entrusted to approve or deny other DCL roles and PAA Root CAs in the ledger, as well as to disable Validator Nodes. |
| Node Admin | It can instantiate a single Validator Node. |
| Vendor | It can write vendor and product information to the ledger. Alliance members can have one or more vendor accounts. |
| Vendor Admin | It can add and update the Vendor information table of the ledger. |
| Certification Center | It can submit, update, delete or revoke certification status of a product based on the Certification application in the Certification Tool. |
jcps07 marked this conversation as resolved.
Show resolved Hide resolved

### Main-Net and Test-Net

| DCL Deployment | Description |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Main-Net | It is the DCL utilized by the public and is regarded as the production environment. Transactions on the Main-Net involve real products and data. |
| Test-Net | It is used for testing and development purposes. It provides a safe environment for experimentation and troubleshooting before deploying to the Main-Net. |
jcps07 marked this conversation as resolved.
Show resolved Hide resolved

### Access and interaction with the DCL

- **Write** access to the ledger is restricted to approved accounts in the DCL.

- **Read** access is broadly available through observer nodes.

### Getting an account for writing to the DCL

- Enrollment for Main-Net DCL accounts is managed through the "DCL Account(s)" section in the Certification Tool system (Knack). You can request access to the Certification Tool
by sending an email to <help@csa-iot.org>.

> Note: The Certification Tool portal will depend on the Membership type.

- Enrollment for Test-Net DCL accounts can be requested by sending an email to <dcl-admin@csa-iot.org>

Review the following document for instructions: [HowTo - Writing to the DCL.pdf](https://groups.csa-iot.org/wg/members-all/document/27881)

### Interacting with the DCL

There are different options available for users and/or systems to interact with the DCL:

- Web User Interface, for intuitive navigation.
- API, for seamless integration.
- Command Line Interface (CLI), for efficient management.

#### Web User Interface
The Web UI allows users to interact with the DCL through a visual interface, making tasks more intuitive and reducing the likelihood of errors. There is no need to install any
application client or configuration setup.

#### Command Line Interface

The DCL CLI software (dcld) allows users to interact with the DCL via command line using a connection to a specific available ON. The CLI software is available at the following link:
jcps07 marked this conversation as resolved.
Show resolved Hide resolved
<https://github.com/zigbee-alliance/distributed-compliance-ledger/releases>.

The instructions for the DCL client are available at the following link: <https://github.com/zigbee-alliance/distributed-compliance-ledger/blob/master/docs/how-to.md>.

### Observer Nodes

An Observer Node (ON) offers APIs or Web User Interfaces for users or systems to interact with the DCL. This facilitates both manual and automated authorized writes, as well as
public queries to the DCL.

It is not a requirement to deploy an Observer Node. The Alliance has ONs available in various regions across the globe, including trusted ONs managed by our members. This ensures
broad accessibility and reliable interaction with the DCL from different locations.

#### Main-Net public ONs

| Host Owner | Region | Web User Interface | URL for API | REST | RPC | gRPC |
| ---------------- | ------------ | ---------------------------------- | --------------------------- | ------- | ------- | ------- |
| The Alliance | US, EU | <https://webui.dcl.csa-iot.org> | on.dcl.csa-iot.org | 443 | 26657 | 8443 |
| TrustAsia | CN | <https://main-net.trustasia.com> | on.main-net.trustasia.com | 443 | 26657 | 8443 |
| Tuya | CN | N/A | on-dcl.tuyacn.com | 1317 | 26657 | 9090 |

#### Test-Net public ONs

| Host Owner | Region | Web User Interface | URL for API | REST | RPC | gRPC |
| ---------------- | ------------ | ---------------------------------- | --------------------------- | ------- | ------- | ------- |
| The Alliance | US, EU | <https://testnet.iotledger.io> | on.test-net.dcl.csa-iot.org | 443 | 26657 | 8443 |
| TrustAsia | CN | <https://test-net.trustasia.com> | on.test-net.trustasia.com | 443 | 26657 | 8443 |
| Tuya | CN | N/A | on-dcl-testnet.tuyacn.com | 1317 | 26657 | 9090 |

## FAQs

### Why is my Vendor information not listed in the DCL?

Each member must add their own Vendor information using an approved Vendor account.

Review the following document for instructions: [HowTo - Writing to the DCL.pdf](https://groups.csa-iot.org/wg/members-all/document/27881)

### When should I write my product information to the Main-Net DCL?

The DCL\'s product information comprises a Model and a Model-Version of the product. Members add this information using an approved Vendor account. This can be done before or after
completing the certification process. The Compliance entry in the DCL is submitted by the Alliance's Certification team after the certification process is finalized. For this to
take place, the Model and Model-Version must already be listed in the DCL, match the data from the Certification Tool, and the member must notify the Certification team that the
DCL information is ready.

Review the following document for instructions: [HowTo - Writing to the DCL.pdf](https://groups.csa-iot.org/wg/members-all/document/27881)

## Contact
For any questions related to the DCL, please contact the DCL Admin (<dcl-admin@csa-iot.org>).
12 changes: 12 additions & 0 deletions content/Guides/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
+++
title = "Guides"
chapter = true
weight = 5
pre = "<b>5. </b>"
+++

# Guides

This section contains detailed explanations of specific areas of Matter, There is not yet comprehensive coverage of all areas but we will endevour to expand the topics over time.
jcps07 marked this conversation as resolved.
Show resolved Hide resolved


Loading