Giter Club home page Giter Club logo

libvcx's Introduction

VCX

LibVCX is Aries c-callable implementation written in Rust with language wrappers currently available in Java, Python, iOS, NodeJS.

Installing the VCX

Building LibVCX on OSX

Instructions can be found here

Building LibVCX on mobile

Instructions cane be foun here

Wrappers documentation

The following wrappers are tested and complete.

Library initialization

Libvcx library must be initialized with one of the functions:

  • vcx_init_with_config - initializes with passed as JSON string.
  • vcx_init - initializes with a path to the file containing .
  • vcx_init_minimal - initializes with the minimal (without any agency configuration).

Each library function will use this data after the initialization. The list of options can be find here An example of file can be found here

If the library works with an agency vcx_agent_provision function must be called before initialization to populate configuration and wallet for this agent. The result of this function is JSON which can be extended and used for initialization.

To change a user must call vcx_shutdown and then call initialization function again.

Getting started guide

The tutorial which introduces Libvcx and explains how the whole ecosystem works, and how the functions in the SDK can be used to construct rich clients.

Example use

For the main workflow example check demo.

Actors

Libvcx provides APIs for acting as different actors. The actor states, transitions and messages depend on communication method is used.

There are two communication methods: proprietary and aries. The default communication method is proprietary. The communication method can be specified as a config option on one of *_init functions.

How to migrate

The documents that provide necessary information for Libvcx migrations.

libvcx's People

Contributors

anastasia-tarasova avatar andkononykhin avatar artemkaaas avatar ashcherbakov avatar axelnennker avatar cybermag avatar dhh1128 avatar dkulic avatar faisal00813 avatar farskipper avatar hadleym avatar ianco avatar jovfer avatar keichiri avatar khagesh avatar kithat avatar lovesh avatar michaeldboyd avatar mikelodder7 avatar mirgee avatar mrjcrunch avatar nsivraj avatar p5n avatar patrik-stas avatar peacekeeper avatar rytmarsh avatar sergeypalamarchuk avatar srottem avatar techwritingwhiz avatar tmarkovski avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.