From 12c53a43f83ed72dfdbccbbe8b31eb6879858969 Mon Sep 17 00:00:00 2001 From: Dan Yamamoto Date: Thu, 28 Sep 2023 00:48:08 +0000 Subject: [PATCH] add README and CHANGELOG --- CHANGELOG.md | 19 +++++++++++++++++++ README.md | 12 ++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 CHANGELOG.md create mode 100644 README.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..f730051 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,19 @@ +# Changelog + +## [0.8.0] - 2023-09-28 + +### Added + +- Blind signing feature +- PPID feature +- `domain` parameter to `derive_proof` and `verify_proof` +- Allow inclusion of committed secrets in VP, generated by `derived_proof`, for using VP as an issuance request for bound VC +- Helper functions for mutual conversion between ark object and multibase +- Set current datetime for `created` if not provided +- Type aliases to abstract cryptographic structs like `Bls12_381`, `SignatureParamsG1`, and so forth + +### Changed + +- Rename `nonce` to `challenge` +- Modify `sign`, `sign_string`, `blind_sign`, `blind_sign_string` to generate the entire proof, not just the proof value +- Simplify serialization and deserialization of proofValue (`ProofWithIndexMap`) and serialization of proof spec context (`ProofSpecContext`) diff --git a/README.md b/README.md new file mode 100644 index 0000000..85e5336 --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +# rdf-proofs + +**WORK IN PROGRESS** + +This library enables the attachment of BBS+ signatures to RDF graphs to create Verifiable Credentials. +It allows for the combination of multiple Verifiable Credentials and provides the capability to selectively disclose specific parts, resulting in the generation of a Verifiable Presentation as an RDF dataset. +Internally, it utilizes the BBS+ signature library and the proof-system library from [docknetwork/crypto](https://github.com/docknetwork/crypto). +Note that this is still in an experimental phase and is not suitable for practical use. + +## Usage + +TBD