wallet-sdk

README

Wallet SDK

The TrustBloc Wallet SDK repo contains APIs to issue/present W3C Verifiable Credentials(VCs) signed/verified using W3C Decentralized Identifiers(DIDs). These APIs are useful for the holder role defined in the W3C VC Specification.

This project contains:

• A Go SDK
  • For building native Go applications.
• A gomobile-compatible Go SDK
  • For generating gomobile-compatible bindings (see below).
  • To jump straight to usage documentation, see here.
• Scripts to generate Android and iOS-compatible bindings
  • Allows the Go SDK to be used in an Android or iOS app.

The repo also has code to generate a Reference iOS or Android App built using the Flutter framework.

Build/Run

• GoMobile Bindings (iOS/Android)
• Demo/Reference App

Library/Package

Android

The Wallet SDK Android package is available on GitHub Maven Repository. Please check this page for the latest SNAPSHOT versions.

<dependency>
 <groupId>dev.trustbloc</groupId>
 <artifactId>vc-wallet-sdk</artifactId>
 <version>0.1.0-SNAPSHOT-7e3a6ed</version>
</dependency>

Refer here for using the android package in your project.

Gradle Config

Add the following GitHub maven repository to dependencyResolutionManagement.repositories

maven {
  url = $URL
  credentials {
    username = $GITHUB_USER
    password = $GITHUB_TOKEN
  }
 }

Use the following URL based on snapshot or release dependency: SNAPSHOT_REPO_URL=https://maven.pkg.github.com/trustbloc-cicd/snapshot RELEASE_REPO_URL=https://maven.pkg.github.com/trustbloc/wallet-sdk

Project structure

The Go SDK is defined in pkg. If you want to build a native Go application, then this is what you'd use.

The gomobile-compatible version of the aforementioned Go SDK is defined in cmd/wallet-sdk-gomobile. It's similar to the Go SDK, except that the various functions, methods, and interfaces only use a subset of Go types that are compatible with the gomobile tool. The gomobile-compatible SDK generally acts as a wrapper for the Go SDK. Internally, it converts between the gomobile-compatible types and the types used by the Go SDK as needed.

Contributing

Thank you for your interest in contributing. Please see our community contribution guidelines for more information.

License

Apache License, Version 2.0 (Apache-2.0). See the LICENSE file.