Skip to content

An app for exploring Monetha digital identities on blockchain

Notifications You must be signed in to change notification settings

monetha/passport-scanner

Repository files navigation

Digital Identity Scanner

Build Status

Digital Identity Scanner is a Monetha Platform accompanying tool which helps to explore digital identity passports and information provided by multiple data sources.

In order to better understand what a digital identity passport is and how it works please look into Verifiable data layer documentation of Monetha platform

You can as well checkout the latest deployed version https://scanner.monetha.io

alt text

Installation

Install Node.js 8+ LTS version.

Once you have Node installed, you can clone the repository and install its dependencies:

  git clone https://github.com/monetha/passport-scanner.git
  cd passport-scanner
  npm install

Running in development environment

The development server is a combination of Node.js Express and Webpack. In order to start the development server use the command below:

  npm start

Once the compilation is done the web app will be available in your browser at http://localhost:3000. Hot Reloading is enabled so the browser will live update as you edit the source files.

Running in production environment

We have prepared a script that prepares an optimized version of the app.

  npm run build

After typescript compilation completes a folder build is created with all necessary assets for website hosting. This then can be deployed to any web server of your choice or Amazon S3.

Custom networks

Web application is pre-configured to communicate with 2 Ethereum networks: Mainnet, Ropsten. Monetha have boostrapped smart contracts, needed for passports on those networks. If you would like to use Rinkerby network or a local node - you can enter custom url in upper-right dropdown in running app.

Another way is to add custom networks configuration file in project root directory, called networks.json, and build the project. Please see networks.default.json file as an example for file structure.

Caveats

This tools is a work in progress and we believe there are multiple improvements that can be done to it.

  • Digital Identity Scanner has a hard dependency on the version of PassportFactory in order to show all digital identities in a "Digital identity registry". Meaning in case of upgrade of PassportFactory contract this web app needs to make sure of backward compatibility.

Security

Please disclose any vulnerabilities found responsibly - report any security problems found to the maintainers privately.

Contribution

Please submit bug reports, suggestions and pull requests to the GitHub issue tracker.