@gimly-blockchain/gimlyid-qr-code-generator

GimlyID QR code Generator

A GimlyID QR code generator component. This library works with React and React Native (using React Native SVG). It is a simple way to generate a QR code with a unique state value when you request a page that has the component installed.

Example

import React from 'react';
import ReactDOM from 'react-dom';
import GimlyIDQRCode, {QRType, QRMode} from '@gimly-blockchain/gimlyid-qr-code';

ReactDOM.render(<GimlyIDQRCode 
                 type={QRType.AUTHENTICATION} 
                 did={'did:ethr:0xcBe71d18b5F1259faA9fEE8f9a5FAbe2372BE8c9'} 
                 mode={QRMode.DID_AUTH_SIOP_V2}
                 redirectUrl={'https://example.com'}
                 onGenerate={content => console.log(JSON.stringify(content))}
               />);

/*
Example output of onGenerate:
{"state":"vqKLNzmYYPDmt8YWs9ftYE","type":"auth","did":"did:ethr:0xcBe71d18b5F1259faA9fEE8f9a5FAbe2372BE8c9","mode":"didauth","redirectUrl":"https://example.com","qrValue":"{\"state\":\"vqKLNzmYYPDmt8YWs9ftYE\",\"type\":\"auth\",\"did\":\"did:ethr:0xcBe71d18b5F1259faA9fEE8f9a5FAbe2372BE8c9\",\"mode\":\"didauth\",\"redirectUrl\":\"https://example.com\"}"}
*/

API

prop	type	default value	description
type	QRType		This is the type stored within the QR code. Options: [AUTHENTICATION].
did	string		This is the DID that the relying party (the party that integrated the authentication support on their website) will use to sign/encrypt data towards the client. This will be stored within the QR code.
mode	QRMode		This is the mode stored within the QR code. Options: [DID_AUTH_SIOP_V2].
redirectUrl	string		This is a redirect url that will be stored within the QR code.
bgColor (optional)	string	'#FFFFFF'	This will set the background color of the QR code.
fgColor (optional)	string	'#000000'	This will set the foreground color of the QR code.
level (optional)	string ('L' 'M' 'Q' 'H')	'L'	This will set the level of the QR code.
size (optional)	number	256	This will set the size of the QR code.
title (optional)	string		This will set the title of the QR code.
onGenerate (optional)	Function		onGenerate will be called when the QR code is generated and will have access to the QR content.

DID Auth SIOP

The purpose of this QR code is to initiate the authentication between two parties by redirecting to an endpoint that returns an Authentication Request using using the DID Auth SIOP library. The DID Auth SIOP library is an authentication library for having clients/people conforming to the Self Issued OpenID Provider v2 (SIOPv2) and OpenID Connect for Verifiable Presentations (OIDC4VP) as specified in the OpenID Connect working group.

Installation

yarn add @gimly-blockchain/gimlyid-qr-code

When using this library with React Native, you will also need to have react-native-svg installed.

yarn add react-native-svg
cd ios && pod install

Build

yarn build

Test

The test command runs:

• eslint
• prettier
• jest
• coverage

You can also run only a single section of these tests, using for example yarn test:unit.

yarn test

Utility scripts

There are other utility scripts that help with development.

• yarn fix - runs eslint --fix as well as prettier to fix code style.