Basic DIDComm v2 support for React Native framework (Android only).

This package is React Native wrapper for DIDComm JVM library. It contains native modules that are using DIDComm JVM API and exposes Javascript/Typescript API using React Native bridge.

Design documentation for complex parts of implementation can be found in docs folder.

In your project root, create .npmrc file with following content to be able to install package from GitHub registry:

@sicpa-dlab:registry=https://npm.pkg.github.com

Login into GitHub packages registry:

1. Create GitHub Personal Access Token with read:packages scope if you don't have one
2. Run following command and login using your Personal Access Token instead of password:

   npm login --registry=https://npm.pkg.github.com

For detailed GitHub packages installation guide please see: https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#installing-a-package

If you need to use this package in another RN library:

• Please see: https://github.com/callstack/react-native-builder-bob#how-do-i-add-a-react-native-library-containing-native-code-as-a-dependency-in-my-library
• Note that you need to add this package as end application dependency in order to make native modules work

Add following DIDComm resolvers initialization code to your App (it's a workaround that will be removed later):

import { NativeModules, NativeEventEmitter } from 'react-native'
import { useEffect } from 'react'
import { DIDCommResolversProxy } from "@sicpa-dlab/didcomm-react-native"

const { DIDCommResolversProxyModule } = NativeModules

export default function App() {

    useEffect(() => {
        const nativeEventEmitter = new NativeEventEmitter(DIDCommResolversProxyModule)
        DIDCommResolversProxy.start(nativeEventEmitter)
        return () => DIDCommResolversProxy.stop()
    },[])


    return ...
}

A general usage of the API is the following:

• Sender Side:
  • Build a Message (plaintext, payload).
  • Convert a message to a DIDComm Message for further transporting by calling one of the following:
    • Message.pack_encrypted to build an Encrypted DIDComm message
    • Message.pack_signed to build a Signed DIDComm message
    • Message.pack_plaintext to build a Plaintext DIDComm message
• Receiver side:
  • Call Message.unpack on receiver side that will decrypt the message, verify signature if needed and return a Message for further processing on the application level.

yarn bootstrap
yarn demo android

On Intel Mac:

yarn bootstrap
cd ./demo/ios && pod install && cd ./../..
yarn demo ios

On M1 Mac:

yarn bootstrap
cd ./demo/ios && arch -x86_64 pod install && cd ./../..
arch -x86_64 yarn demo ios

If you have write access to the repo, you can publish new version using following steps:

• Create GitHub Personal access token with full repo and write:packages scopes if you don't have one
• Run npm login --registry=https://npm.pkg.github.com command and log-in using your access token as a password
• Run npm publish command from the repo root

• Error message:

  > A failure occurred while executing com.android.build.gradle.internal.tasks.CheckDuplicatesRunnable
  > Duplicate class com.google.crypto.tink.Aead found in modules jetified-tink-1.6.1 (com.google.crypto.tink:tink:1.6.1) and jetified-tink-android-1.5.0 (com.google.crypto.tink:tink-android:1.5.0)
   Duplicate class com.google.crypto.tink.BinaryKeysetReader found in modules jetified-tink-1.6.1 (com.google.crypto.tink:tink:1.6.1) and jetified-tink-android-1.5.0 (com.google.crypto.tink:tink-android:1.5.0)
   Duplicate class com.google.crypto.tink.BinaryKeysetWriter found in modules jetified-tink-1.6.1 (com.google.crypto.tink:tink:1.6.1) and jetified-tink-android-1.5.0 (com.google.crypto.tink:tink-android:1.5.0)
  

• Solution: Exclude com.google.crypto.tink:tink module from library native package using gradle configuration

  implementation (project(":sicpa-dlab_didcomm-react-native")) {
      exclude(group: "com.google.crypto.tink", module: "tink")
  }