symbol / qr-library

QR library for Symbol

Symbol Monorepo

In Q1 2021, we consolidated a number of projects into this repository. It includes our specialized binary payload DSL (parser and schemas), clients and sdks.

component	lint	build	test	coverage	package
@catbuffer/parser
@client/catapult
@client/rest
@sdk/javascript
@sdk/python
@linters
@jenkins

Full Coverage Report

Detailed version can be seen on codecov.io.

qr-library's Issues

Migrate to EsLint and Prettier

Like most of our Typescript projects.

Use typescript as reference

https://github.com/nemtech/symbol-sdk-typescript-javascript/blob/main/.eslintrc.js
https://github.com/nemtech/symbol-sdk-typescript-javascript/blob/main/.prettierrc.js
https://github.com/nemtech/symbol-sdk-typescript-javascript/blob/main/package.json#L16

update sdk to 0.14.4

Feature request: Enable creating a QR code from any object

There are several methods available to create a QR code, however, they all have a generationHash and a networkType as arguments

For this library to be complete, it would be good to be able to create a "free" QR code, so an app using the library when needing to represent a random object as a QR code

ChainId: should be renamed to generationHash and not defaulted

I think that it should be whether defaulted with an empty string or throw an error if not provided a with a valid generationHash.

https://github.com/nemfoundation/nem2-qr-library/blob/8b365194ad2f43533f51dd2a836a88f5d8d3533f/src/QRCodeGenerator.ts#L58

Rebranding

• Rebranding branch created
• New design applied (font, logos, colors)
• Codename references renamed
• Ticker references renamed
• Links reviewed
• README reviewed
• PR created
• Package renamed
• Package deployed/tag created

Bug: TransactionRequest QR unreadble issue.

TransactionRequest QR code seems to be unreadable. Currently, TransactionRequest QR renders with Version 40.

about MnemonicQR argument in README.md

I Think

not
new MnemonicQR(mnemonic, password, NetworkType.MIJIN_TEST, 'no-chain-id');

but
new MnemonicQR(mnemonic, "password", NetworkType.MIJIN_TEST, 'no-chain-id');

it seems that password needs quotation.

QR Codes containing more data(level > 13) such as MnemonicQR are unreadable

Error Description
When I try to read an exported MnemonicQR code in one of the Online QR Code Readers(i.e https://webqr.com ) or try to read with JS QRCode libraries (jsQR, vue-qrcode-reader), it fails to read(relatively small size QR codes succeed).

To Reproduce
Steps to reproduce the behaviour:

1. Go to 'Account' page
2. Click on 'Backup Mnemonic'
3. Download 'MnemonicQR Code'
4. Open a browser and navigate to https://webqr.com
5. Upload the downloaded MnemonicQR Code
6. See the result => error decoding QR Code

To reproduce with js QR libraries:

• https://jsfiddle.net/bahadiryilmaz/7xm1zeyw/61/
• https://codesandbox.io/s/jsqr-file-reader-forked-i17ch?file=/index.js

Expected behavior
Content of the QR Code should be shown

Screenshots & Attachments

mnemonicqr-doesntwork:

transactionqr-with-231-chars-message-doesnt-work:

qrcode-with-less-data-works:

Remove SDK hard dependency

Atm, this library depends on the TS SDK. Each SDK release requires a release of this library which is annoying. Especially when working on bigger clients like the desktop wallet where different SDK versions are referenced.

If the library references interfaces instead of contract SDK objects, the dependency management would be a lot simpler. The SDK could be a dev dependency for unit test.