From f0908aa2336e962cd6f16ea099b3d1b36736ea33 Mon Sep 17 00:00:00 2001 From: George Mulhearn Date: Wed, 27 Nov 2024 10:45:25 +1000 Subject: [PATCH] readme updates Signed-off-by: George Mulhearn --- README.md | 1 + did_core/did_methods/did_cheqd/README.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11a2560a82..0c868bdb99 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ The repository contains Rust crates to build - [`did_parser`](did_core/did_parser_nom) - Building and parsing [DIDs](https://w3c.github.io/did-core/) - [`did_peer`](did_core/did_methods/did_peer) - https://identity.foundation/peer-did-method-spec/ - [`did_sov`](did_core/did_methods/did_resolver_sov) - https://sovrin-foundation.github.io/sovrin/spec/did-method-spec-template.html + - [`did_cheqd`](did_core/did_methods/did_cheqd) - https://docs.cheqd.io/product/architecture/adr-list/adr-001-cheqd-did-method - [`did_web`](did_core/did_methods/did_resolver_web) - https://w3c-ccg.github.io/did-method-web/ - [`did_key`](did_core/did_methods/did_key) - https://w3c-ccg.github.io/did-method-key/ diff --git a/did_core/did_methods/did_cheqd/README.md b/did_core/did_methods/did_cheqd/README.md index f609b759e8..3c62ecd4e6 100644 --- a/did_core/did_methods/did_cheqd/README.md +++ b/did_core/did_methods/did_cheqd/README.md @@ -5,7 +5,7 @@ The implementations in this crate are largely inspired from cheqd's own typescri This crate uses gRPC types and clients generated using [tonic](https://github.com/hyperium/tonic). The generated rust code is checked-in to this repository for monitoring, [see here](./src/proto/mod.rs). These generated rust files are checked-in alongside the V2 cheqd proto files & dependencies, [here](./cheqd_proto_gen/proto/), which are sourced from [cheqd's Buf registry](https://buf.build/cheqd/proto/docs). -Since the generated code & proto files are not relatively large nor overwhelming in content, they are checked-in rather than pulled and/or generated at build time. The benefit is that the contents of the files can be monitored with each update, making supply-chain attacks obvious. The drawback is that it introduces some more manual maintainence. +Since the generated code & proto files are not relatively large nor overwhelming in content, they are checked-in rather than pulled and/or generated at build time. The benefit is that the contents of the files can be monitored with each update, making supply-chain attacks obvious. It also reduces the build time complexity for consumers - such as reducing requirements for any 3rd party build tools to be installed (`protobuf`). The drawback is that it introduces some more manual maintainence. ## Crate Maintainence If there is an update to the `.proto` files, or `tonic` had a breaking update, the checked-in files may be due for a manual update. To do so, update any proto files in the [proto dir](./cheqd_proto_gen/proto/), then re-generate the rust files by using the [cheqd-proto-gen](./cheqd_proto_gen/) binary within this directory: