web3-credential-ui v0.0.3

Web3 Credential Dialog

A React library that simplifies integration of a decentralized credential standard such as Verite.

Web3 Credential Dialog renders a dialog that does the following:

Prompts for Credential Requirement:

• Prompts users that a certain credential is required
• Explains why the credential is required and the basics of decentralized credentials such as they preserve user privacy.

• Links to more information about decentralized credentials

  Verifies Credential Requirement:

• Allows user to specify their choice of supported credential issuer

• Can check on-chain registry or verify credential JWT

  Assists with Credential Setup:

• Includes instructions for credential setup for the issuer chosen by the user

  Getting Started

Run yarn from the project root directory and run yarn dev from the demo directory to try the demo.

To use the CredentialDialog component, import it and include it in a parent component's render function:

import { CredentialDialog } from "web3-credential-ui"; 

<CredentialDialog 
    page={credentialDialogPage} 
    setPage={setCredentialDialogPage} 
    onCancel={() => console.log('cancelled credential dialog')}
    onVerify={() => console.log('verfied credential')}
/>
</div>

While the parent component rendering CredentialDialog is required to pass in page and setPage props to facilititate handling of page state, the component will be refactored to not require state to be handled by the parent component.

Demo App

A demo application based on web3-react is in the demo directory.

There is currently a bug that requires removing react and react-dom from demo/node_modules for the demo to load.

TODO

• Use web3.js to verify contract using isVerified method in credential registry.
• Implement example registry and instructions for testing locally using (hardhat)https://github.com/NomicFoundation/hardhat