Skip to content

Commit

Permalink
chore: release 0.65.0
Browse files Browse the repository at this point in the history
Signed-off-by: James Ebert <[email protected]>
  • Loading branch information
JamesKEbert committed Jul 23, 2024
1 parent e32fe1b commit 6b61991
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 27 deletions.
20 changes: 10 additions & 10 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ members = [
]

[workspace.package]
version = "0.64.0"
version = "0.65.0"
authors = [
"Absa Group Limited",
"Hyperledger Indy Contributors <[email protected]>",
Expand Down Expand Up @@ -73,4 +73,3 @@ unused_import_braces = "warn"
unused_lifetimes = "warn"
unused_qualifications = "warn"
let_underscore_drop = "allow"

2 changes: 1 addition & 1 deletion aries/agents/aath-backchannel/src/controllers/general.rs
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ pub async fn get_status(agent: web::Data<RwLock<HarnessAgent>>) -> impl Responde
#[get("/version")]
pub async fn get_version() -> impl Responder {
// Update this with aries-vcx
HttpResponse::Ok().body("0.64.0")
HttpResponse::Ok().body("0.65.0")
}

#[get("/did")]
Expand Down
33 changes: 21 additions & 12 deletions aries/aries_vcx/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,52 @@
# `aries_vcx` crate
Provides basic tools to build didcomm/aries enabled application in Rust. This can include native mobile apps, or
webservers for VC issuance/verification, didcomm mediator service etc.

Provides basic tools to build didcomm/aries enabled application in Rust. This can include native mobile apps, or
webservers for VC issuance/verification, didcomm mediator service etc.

#### What this crate can do for you

- Create encrypted wallet.
- Read/write from/to Indy ledger.
- Establish didcomm connections and exchange messages.
- Create and process Aries messages to drive Aries protocols (especially for VC issuance and presentation).

#### What does crate does NOT DO for you
- Provide message outbounds - `aries_vcx` helps you to create correct response & encrypt it, but you have to take care

- Provide message outbounds - `aries_vcx` helps you to create correct response & encrypt it, but you have to take care
of sending it to the right place.
- Automatic inbound processing - you have to take care of receiving messages and passing them to `aries_vcx` for processing.
You need to keep track of your ongoing aries "conversations" and match incoming messages (typically based on message thread id).

# Getting started

To use `aries_vcx` in your project, you need to add GitHub dependency to your `Cargo.toml`, and best
define a version through a `tag`:

```toml
aries-vcx = { tag = "0.64.0", git = "https://github.com/hyperledger/aries-vcx" }
aries-vcx = { tag = "0.65.0", git = "https://github.com/hyperledger/aries-vcx" }
```

It's also advisable to follow these [instructions](TUTORIAL.md) to check your environment is properly configured.

# Projects built with aries-vcx

- [mediator](../agents/rust/mediator) - Message mediator web service, useful for mobile device to receive messages while the device is offline.
- [unifii_aries_vcx](../../uniffi_aries_vcx) - Mobile wrapper to autogenerate Swift and Kotlin wrappers. Also comes with sample native mobile app.
- [aries-vcx-agent](../agents/rust/aries-vcx-agent) - Sample agent framework adding persistence and message matching on top of `aries_vcx`. Used for cross-compatibility testing with other aries implementations.

## Implemented Aries protocols
* ✅ Connection Protocol 1.0: [`https://didcomm.org/connections/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0160-connection-protocol)
* ✅ Out of Band 1.1: [`https://didcomm.org/out-of-band/1.1/*`](https://github.com/hyperledger/aries-rfcs/blob/main/features/0434-outofband)
* ✅ Basic Message 1.0: [`https://didcomm.org/basicmessage/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0095-basic-message)
* ✅ Credential Issuance 1.0 [`https://didcomm.org/issue-credential/1.0/*`](https://github.com/hyperledger/aries-rfcs/blob/master/features/0036-issue-credential)
* ✅ Credential Presentation 1.0: [`https://didcomm.org/present-proof/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0037-present-proof)
* ✅ Trust Ping 1.0: [`https://didcomm.org/trust_ping/1.0/*`](https://github.com/hyperledger/aries-rfcs/blob/master/features/0048-trust-ping/README.md)
* ✅ Discover Features 1.0: [`https://didcomm.org/discover-features/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0031-discover-features)
* ✅ Revocation notification 2.0: [`https://didcomm.org/revocation_notification/2.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0031-discover-features)

- ✅ Connection Protocol 1.0: [`https://didcomm.org/connections/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0160-connection-protocol)
- ✅ Out of Band 1.1: [`https://didcomm.org/out-of-band/1.1/*`](https://github.com/hyperledger/aries-rfcs/blob/main/features/0434-outofband)
- ✅ Basic Message 1.0: [`https://didcomm.org/basicmessage/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0095-basic-message)
- ✅ Credential Issuance 1.0 [`https://didcomm.org/issue-credential/1.0/*`](https://github.com/hyperledger/aries-rfcs/blob/master/features/0036-issue-credential)
- ✅ Credential Presentation 1.0: [`https://didcomm.org/present-proof/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0037-present-proof)
- ✅ Trust Ping 1.0: [`https://didcomm.org/trust_ping/1.0/*`](https://github.com/hyperledger/aries-rfcs/blob/master/features/0048-trust-ping/README.md)
- ✅ Discover Features 1.0: [`https://didcomm.org/discover-features/1.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0031-discover-features)
- ✅ Revocation notification 2.0: [`https://didcomm.org/revocation_notification/2.0/*`](https://github.com/hyperledger/aries-rfcs/tree/master/features/0031-discover-features)

### State machines guidelines

Please follow these [guidelines](docs/guidelines.md) when implementing new state machines.

## Architecture
Expand Down
2 changes: 1 addition & 1 deletion did_core/did_methods/did_peer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Add the Peer DID library as a dependency in your `Cargo.toml` file:

```toml
[dependencies]
peer_did = { tag = "0.64.0", git = "https://github.com/hyperledger/aries-vcx" }
peer_did = { tag = "0.65.0", git = "https://github.com/hyperledger/aries-vcx" }
```

## Demo
Expand Down
2 changes: 1 addition & 1 deletion did_core/did_parser_nom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ Add the did_parser library as a dependency in your `Cargo.toml` file:

```toml
[dependencies]
did_parser_nom = { tag = "0.64.0", git = "https://github.com/hyperledger/aries-vcx" }
did_parser_nom = { tag = "0.65.0", git = "https://github.com/hyperledger/aries-vcx" }
```

0 comments on commit 6b61991

Please sign in to comment.