Skip to content

Commit

Permalink
add README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
yamdan committed Sep 28, 2023
1 parent 5260e0b commit 12c53a4
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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`)
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 12c53a4

Please sign in to comment.