This Holder ULA plugin responds to an incoming ChallengeRequest from the issuer and/or verifier. This implementation uses secp256k1 by default. If you want to use a different cryptographic algorithm, then provide your own crypt-util instance.
If you work with QR codes, please read the instructions in the ula-process-eth-barcode repository. Also, in order to save credentials properly, we advise to install the ula-vc-data-management plugin as well.
In an existing project (with
package.json), install the plugin by running the following commands:
npm install universal-ledger-agent --savenpm install crypt-util --savenpm install vp-toolkit --savenpm install ula-vp-controller-plugin --save
This is an example of enabling this plugin in the ULA in a browser environment.
;;;;// Prepare plugin dependencies// Instantiate the plugin// Setup the ULA and inject the plugin
Using an existing ULA plugin
Add the ula-process-eth-barcode plugin to receive input from that plugin and you're set to go!
However, if you want to invoke this plugin manually, send a ULA message with this format:
toAttest fields are optional. You can use both at the same time or omit one of them. If you omit both fields, the plugin will complete without sending any visual feedback.
When the plugin has finished, the callback function will be called twice. The first time for updating the user interface and the second time for passing operation details (in this case, only a status code).
In case of a successful situation:
// Dont show loading screen, show success screencallbacknew UlaResponsecallbacknew UlaResponse // Everything went OK
In case of an error:
// Don't show loading screen, but show failure screencallbacknew UlaResponsecallbacknew UlaResponse // No information available
Besides unit testing with Mocha, the effectivity of all tests are also measured with the Stryker mutation testing framework.
npm run testnpm run stryker
We aim to achieve a coverage of 100%. Stryker and/or mocha test scores below 80% will fail the build.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License and disclaimer
We discourage the use of this work in production environments as it is in active development and not mature enough.