tirl-validator v0.5.0
tirl-validator
Utilities to enable verifying TrustlessIRL physical labels. Built for React Native
Installation
npm install --save tirl-validator
# If building for IOS
npx pod-installAbout
This library facilitates easy integration with the TrustlessIRL protocol by enabling mobile applications to perform camera based scans of TIRL labels.
Read more about the TrustlessIRL protocol here.
Successful scans must capture images of the label with the camera tilted slightly to the left, and slightly to the right - as TIRL labels are 3-Dimensional.
Usage
The TirlValidator class exposes a single function:
validate(imagePath): Promise
Read the image at imagePath and return result if scan completed, or further scan requirements if not.
Params
- imagePath
string- should contain an image of a valid TIRL label
Returns
{
labelId: string; // ID of TIRL label being scanned
scanDone: boolean; // Returns true when both scanLeft and scanRight are true. Indicates scanning has completed.
valid: boolean; // Notifies whether scanned label is authentic. Field is set only when scanDone === true
scanLeft: boolean; // Indicates whether sufficient data has been captured with the camera tilted left.
scanRight: boolean; // Indicates whether sufficient data has been captured with the camera tilted right.
error: Object; // Any errors will be returned here
}Error Handling
Occasionally the validate() function can return a property called error. The following is a list of common errors and how best to handle them based on the error.message property.
| Code | Description | Handling |
|---|---|---|
| 1 | Indicates that the image being processed does not contain a TIRL label or is out of focus | Safe to continue with scan. Can optionally prompt the user to adjust camera distance |
| 2 | Indicates that the user may be scanning multiple unique labels within a single scan session. | Should instantiate a new instance of the TirlValidator class and restart the scan |
| 3 | Indicates a network request to fetch label data has failed. | Safe to continue with scan. May indicate general connectivity issues |
| 4 | Indicates that the Tirl label being scanned is not known by the network | FATAL: This label is not known by the network and cannot be validated |
| 999 | Indicates an unexpected error was thrown by the image processing module | Safe to continue with scan. Can inspect error.message for more detail |
Example
A full example can be found in this repository which utilizes vision-camera and react-native-fs
Running the example
Make sure you have followed all of the steps required for setting up your React Native Development Environment
Running on an IOS Device
Follow the instructions for running React Native on your IOS Device
Running on Android
npm run bootstrap
cd example
npm run androidYou may need to add the following to the example/android/local.properties file
# On Windows
sdk.dir=C:\\Users\\<name>\\AppData\\Local\\Android\\sdk
# On Mac
sdk.dir=/Users/<name>/Library/Android/sdkYou will also need to have a working webcam or camera device attached to your mobile simulator
Contributing
See the contributing guide to learn how to contribute to the repository and the development workflow.
License
MIT
Made with create-react-native-library