-
Notifications
You must be signed in to change notification settings - Fork 83
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* adjust didpeer docs, aries readme mobile components * fix: adjust mobile-demo path Signed-off-by: James Ebert <jamesebert.k@gmail.com> --------- Signed-off-by: James Ebert <jamesebert.k@gmail.com>
- Loading branch information
1 parent
58bbc0a
commit 7477458
Showing
2 changed files
with
21 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,14 @@ | ||
# <img alt="Hyperledger Aries logo" src="docs/aries-logo.png" width="45px" /> Aries components | ||
|
||
## Aries components | ||
- [`aries_vcx`](aries_vcx) - Library implementing DIDComm protocols, with focus on verifiable credential issuance and verification. | ||
- [`messages`](messages) - Library for building and parsing Aries messages. | ||
- [`aries_vcx_core`](aries_vcx_core) - Interfaces for interaction with ledgers, wallets and credentials. | ||
- [`aries-vcx-agent`](agents/rust/aries-vcx-agent) - simple aries agent framework built on top of `aries_vcx` library. | ||
- [`mediator`](agents/rust/mediator) - Aries message mediator service | ||
|
||
- [`aries_vcx`](aries_vcx) - Library implementing DIDComm protocols, with focus on verifiable credential issuance and verification. | ||
- [`messages`](messages) - Library for building and parsing Aries messages. | ||
- [`aries_vcx_core`](aries_vcx_core) - Interfaces for interaction with ledgers, wallets and credentials. | ||
- [`aries-vcx-agent`](agents/rust/aries-vcx-agent) - simple aries agent framework built on top of `aries_vcx` library. | ||
- [`mediator`](agents/rust/mediator) - Aries message mediator service | ||
|
||
## Aries mobile 📱 components | ||
- [`../tools/uniffi_aries_vcx`](../uniffi_aries_vcx) - UniFFI wrapper for `aries_vcx` and sample mobile app | ||
|
||
- [`uniffi-aries-vcx`](wrappers/uniffi-aries-vcx) - UniFFI wrapper for `aries_vcx`. | ||
- [`mobile-demo`](agents/mobile_demo/) - Sample Android App using UniFFI wrapper. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,36 @@ | ||
# did_peer | ||
|
||
## Overview | ||
Rust crate for creation, parsing, validation, and resolution of [Peer DIDs](https://identity.foundation/peer-did-method-spec). | ||
Peer DIDs are a special type of decentralized identifiers designed for direct peer-to-peer interactions, without the | ||
|
||
Rust crate for creation, parsing, validation, and resolution of [Peer DIDs](https://identity.foundation/peer-did-method-spec). | ||
Peer DIDs are a special type of decentralized identifiers designed for direct peer-to-peer interactions, without the | ||
need for a blockchain or other centralized registry. | ||
|
||
## Features | ||
- **Numalgo Support**: The library implements various version of did:peer. The different versions are referred to as "numalgos". | ||
Currently supports numalgo 1, 2, and 3. | ||
|
||
- **Numalgo Support**: The library implements various version of did:peer. The different versions are referred to as "numalgos". | ||
Currently supports numalgo 1, 2, 3, and 4. | ||
- **DID Parsing**: Capability to parse `did:peer` strings, ensuring they comply with the Peer DID specifications. | ||
- **DID Creation from DIDDoc**: Functionality to create `did:peer` identifiers from DID documents. | ||
- **Numalgo Conversion**: Ability to convert between different numalgos, specifically from Numalgo 2 to Numalgo 3. | ||
- **Validation**: Verification that DIDs adhere to the required specifications and format. | ||
|
||
## Getting Started | ||
|
||
### Installation | ||
|
||
Add the Peer DID library as a dependency in your `Cargo.toml` file: | ||
|
||
```toml | ||
[dependencies] | ||
peer_did = { tag = "0.63.0", git = "https://github.com/hyperledger/aries-vcx" } | ||
``` | ||
|
||
## Demo | ||
To get you off the ground, have a look at the [demo](examples/demo.rs). It demonstrates how to create, parse. You can | ||
|
||
To get you off the ground, have a look at the [demo](examples/demo.rs). It demonstrates how to create, parse. You can | ||
run the demo with the following command: | ||
|
||
```bash | ||
cargo run --example demo | ||
``` | ||
|
||
|