Skip to content

Commit

Permalink
Additional updates
Browse files Browse the repository at this point in the history
Signed-off-by: Patrik Stas <patrik.stas@absa.africa>
  • Loading branch information
Patrik-Stas committed Aug 19, 2023
1 parent 1d40be1 commit d167095
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 46 deletions.
1 change: 0 additions & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ env:
DOCKER_IMAGE_AGENCY: ghcr.io/absaoss/vcxagencynode/vcxagency-node:2.6.0
DOCKER_IMAGE_POOL: ghcr.io/hyperledger/aries-vcx/indy_pool_localhost:1.15.0

DOCKER_REPO_LOCAL_LIBVCX: libvcx
DOCKER_REPO_LOCAL_VDRPROXY: vdrproxy

RUST_TOOLCHAIN_VERSON: 1.65.0
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ members = [
[workspace.package]
version = "0.57.1"
authors = ["Absa Group Limited", "Hyperledger Indy Contributors <hyperledger-indy@lists.hyperledger.org>"]
description = "Absa's fork of HL LibVCX"
description = "Library to work with Aries protocols & collection of supporting components"
license = "Apache-2.0"
edition = "2021"

Expand Down
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,17 @@ The repository contains

## If you are Rust 🦀 developer
You can build your Rust project on top of
- [`aries-vcx`](aries_vcx) - ready to go Rust library to work with Aries protocols, both from
issuer/verifier's side or as a credential holder/prover.
- [`aries-vcx`](aries_vcx) - ready to go Rust library to work with Aries protocols for didcomm, VC issuance and verification.

Additionally, `aries-vcx` is built on top of smaller Rust crates which are part of this repo:
- [`aries_vcx_core`](aries_vcx_core) - foundational APIs to interact with ledger, wallet and anoncreds.
- [`messages`](messages) - crate for building and parsing Aries messages
- [`diddoc`](diddoc) - crate to work with DIDDocs
- [`did_doc`](diddoc) - crate to work with DIDDocs

## If you are mobile 📱 developer
Aries-vcx can be used to build native mobile applications. There are 2 approaches:
- **deprecated**: [`libvcx`](./libvcx) and its Java and Objective-C wrappers is complete, but deprecated
- **encouraged**, but in stage of POC: [`uniffi_aries_vcx`](./uniffi_aries_vcx) is next generation approach
to enable `aries-vcx` on mobile, providing Swift and Kotlin wrappers. However, this is yet in POC stage
and new adopters of `aries-vcx` on mobile are highly encouraged to contribute to its development.

Read more about `libvcx` deprecation and `unifii` benefits [here](./libvcx/README.md)
Aries-vcx can be used to build native mobile applications. You can write part of your mobile backend in Rust on top of
`aries-vcx` crate. Then expose FFI API for iOS/android environments.
- There's POC in progress [`uniffi_aries_vcx`](./uniffi_aries_vcx) using UniFFI library to autogenerate Swift and Kotlin wrappers.

# Reach out 👋
- Ask a question on [discord](https://discord.com/channels/905194001349627914/955480822675308604)
Expand All @@ -35,6 +31,5 @@ Read more about `libvcx` deprecation and `unifii` benefits [here](./libvcx/READM
## Versioning & releases
- All releases have currently major version `0`
- We bump minor version on releases containing new features, significant refactors or breaking changes.
- We bump patch version if release only contains fixes or smaller refactoring.
- See more info on [releases](./docs/RELEASES.md)
- We bump patch version if release only contains fixes or smaller refactoring.
- See [releases](https://github.com/hyperledger/aries-vcx/releases) page.
1 change: 0 additions & 1 deletion aries_vcx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ It's also advisable to follow these [instructions](TUTORIAL.md) to check your en
# Projects built with aries-vcx
- [aries-vcx-agent](../agents/rust/aries-vcx-agent) - sample agent with local persistence. Used for cross-compatibility testing with other aries implementations.
- [unifii_aries_vcx](../uniffi_aries_vcx) - wrapper around `aries-vcx` to generate Swift and Kotlin wrappers for mobile use-cases
- [libcx](../libvcx) (**deprecated**) - wrapper around `aries-vcx` to build Java, Objective-C, NodeJS wrappers.

## 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)
Expand Down
17 changes: 0 additions & 17 deletions docs/RELEASES.md

This file was deleted.

14 changes: 0 additions & 14 deletions libvcx_core/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,7 @@
# libvcx_core
This is foundational crate for
- now deprecated [`libvcx`](../libvcx) dynamic library
- NodeJS wrapper [`vcx-napi-rs`](../wrappers/vcx-napi-rs)

# Testing
Before you try to build/test `libvcx` crate on your machine, make sure you can build `aries-vcx` - see
[aries-vcx README](../aries_vcx).

- Run unit tests:
```
cargo test --features -- --test-threads=1
```
- Run integration tests (you need to have Indy pool running)
```
TEST_POOL_IP=127.0.0.1 cargo test -- --ignored --test-threads=1
```

## Architecture

<img alt="Libvcx architecture diagram" src="../docs/architecture/architecture_230223_libvcx.png"/>

0 comments on commit d167095

Please sign in to comment.