Skip to content

left-arm/aries-vcx

 
 

Repository files navigation

Hyperledger Aries logo AriesVCX

CI build codecov Chat

Aries-vcx is Rust library implementing Aries protocols. It can be used to build Aries agents.

AriesVCX currently requires instance of mediator agency - in particular NodeVCX Agency. To get your started with aries-vcx quickly, you can use our deployment at https://ariesvcx.agency.staging.absa.id/agency

C-Bindings

  • libvcx is library, which provides C-interface to interact with AriesVCX. C-bindings exists for:
    • Java (+Android)
    • iOS,
    • NodeJS

Get started

The best way to get your hands on.

Implemented Aries protocols

Versioning

  • The project currently does not follow semantic versioning. Fow now we are releasing versions 0.x.x.
  • Although the API is mostly stable, breaking changes still occur in our releases. See changelogs at releases page.
  • See our roadmap for what's coming.

Project architecture

The architecture is evolving - you can compare the diagram below with diagram under roadmap.

AriesVCX architecture diagram

Artifacts

Number of artifacts are built for every CI run (unless it's coming from a forked repository due to limitations of Github Actions). Artifacts tied with particular release can be found on release page.

Artifacts produced:

  • Alpine based docker image with precompiled libvcx.so
  • iOS wrapper
  • Android wrapper
  • NodeJS wrapper

When looking for artifacts for a particular CI run:

  • NodeJS wrapper is published at npmjs
  • NodeJS agent is published at npmjs
  • Docker images are in Github Packages
  • Mobile artifacts are attached to CI runs (click on particular CI run to see the artifacts)

Packages

 
 
 

Languages

  • Rust 70.0%
  • Java 8.3%
  • TypeScript 7.9%
  • Objective-C 7.0%
  • JavaScript 3.4%
  • C 2.3%
  • Other 1.1%