PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.0.0-beta.8

npm

@0xpolygonid/snap-example

PolygonID MetaMask Snap example

Published19 Jul 2023
Direct dependencies36
Transitive dependenciesNot calculated

README

Current package documentation

PolygonID snap example

Welcome to the PolygonID snap example repository! This repository serves as a demo project showcasing the usage of the snap library from 0xPolygonID for Verifiable Credentials and did:pkh.

Overview

The PolygonID snap example repository demonstrates how to integrate and utilize the snap project to enable zero-knowledge proof sharing for Verifiable Credentials and did:pkh. With snap, you can enhance privacy and security in credential verification processes by leveraging zero-knowledge proofs.

This example project provides a clear starting point for understanding and experimenting with the capabilities of snap in the context of Verifiable Credentials and did:pkh. It showcases how to set up the project and utilize the library to perform zero-knowledge proof sharing.

Features

  • Demonstrates zero-knowledge proof sharing for Verifiable Credentials and did:pkh.
  • Includes sample code showcasing the usage of snap in a practical scenario.
  • Requires the installation of Metamask and Flask for a complete demonstration.

Getting Started

To get started with the PolygonID snap example project, follow these steps:

  1. Clone the repository: Begin by cloning this repository to your local machine using the following command:

     git clone https://github.com/0xPolygonID/snap-example.git


2. **Install dependencies**: Navigate into the project directory and install the required dependencies using Yarn or npm:

cd snap-example yarn install


3. **Install Metamask Flask**: Install Metamask Flask, a browser extension wallet, to interact with the demo application. You can find installation instructions on the [Metamask website](https://metamask.io/flask/).

4. **Run the project**: Once the dependencies are installed, you can run the project using the provided scripts:

yarn start


This command will start the application, and you can access it in your browser at `http://localhost:8000`.

5. **Explore the demo**: The project includes sample code and a guided demonstration of zero-knowledge proof sharing for Verifiable Credentials and did:pkh. Follow the instructions provided in the demo application to understand and experience the capabilities of `snap`.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 36

Native requirements
36 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0xpolygonid/js-sdk
Environment
{
  "local_name": "@0xpolygonid/js-sdk",
  "alias": false,
  "peer_metadata": null
}
git+https://github.com/0xPolygonID/js-sdk.git#v2runtime
@iden3/js-iden3-core
Environment
{
  "local_name": "@iden3/js-iden3-core",
  "alias": false,
  "peer_metadata": null
}
git+https://github.com/iden3/js-iden3-core.git#v2runtime
@iden3/js-jwz
Environment
{
  "local_name": "@iden3/js-jwz",
  "alias": false,
  "peer_metadata": null
}
^1.0.0-beta.2runtime
@iden3/js-merkletree
Environment
{
  "local_name": "@iden3/js-merkletree",
  "alias": false,
  "peer_metadata": null
}
^1.0.0-beta.4runtime
@metamask/snaps-types
Environment
{
  "local_name": "@metamask/snaps-types",
  "alias": false,
  "peer_metadata": null
}
^0.32.2runtime
@metamask/snaps-ui
Environment
{
  "local_name": "@metamask/snaps-ui",
  "alias": false,
  "peer_metadata": null
}
^0.32.2runtime
buffer
Environment
{
  "local_name": "buffer",
  "alias": false,
  "peer_metadata": null
}
^6.0.3runtime
did-jwt
Environment
{
  "local_name": "did-jwt",
  "alias": false,
  "peer_metadata": null
}
^6.11.6runtime
did-resolver
Environment
{
  "local_name": "did-resolver",
  "alias": false,
  "peer_metadata": null
}
^4.1.0runtime
ethers
Environment
{
  "local_name": "ethers",
  "alias": false,
  "peer_metadata": null
}
^6.4.0runtime
intl
Environment
{
  "local_name": "intl",
  "alias": false,
  "peer_metadata": null
}
^1.2.5runtime
@lavamoat/allow-scripts
Environment
{
  "local_name": "@lavamoat/allow-scripts",
  "alias": false,
  "peer_metadata": null
}
^2.0.3development
@metamask/auto-changelog
Environment
{
  "local_name": "@metamask/auto-changelog",
  "alias": false,
  "peer_metadata": null
}
^2.6.0development
@metamask/eslint-config
Environment
{
  "local_name": "@metamask/eslint-config",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
@metamask/eslint-config-jest
Environment
{
  "local_name": "@metamask/eslint-config-jest",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
@metamask/eslint-config-nodejs
Environment
{
  "local_name": "@metamask/eslint-config-nodejs",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
@metamask/eslint-config-typescript
Environment
{
  "local_name": "@metamask/eslint-config-typescript",
  "alias": false,
  "peer_metadata": null
}
^10.0.0development
@metamask/snaps-cli
Environment
{
  "local_name": "@metamask/snaps-cli",
  "alias": false,
  "peer_metadata": null
}
^0.32.2development
@types/uuid
Environment
{
  "local_name": "@types/uuid",
  "alias": false,
  "peer_metadata": null
}
^9.0.1development
@typescript-eslint/eslint-plugin
Environment
{
  "local_name": "@typescript-eslint/eslint-plugin",
  "alias": false,
  "peer_metadata": null
}
^5.33.0development
@typescript-eslint/parser
Environment
{
  "local_name": "@typescript-eslint/parser",
  "alias": false,
  "peer_metadata": null
}
^5.33.0development
esbuild
Environment
{
  "local_name": "esbuild",
  "alias": false,
  "peer_metadata": null
}
^0.17.19development
esbuild-plugin-replace
Environment
{
  "local_name": "esbuild-plugin-replace",
  "alias": false,
  "peer_metadata": null
}
^1.4.0development
eslint
Environment
{
  "local_name": "eslint",
  "alias": false,
  "peer_metadata": null
}
^8.21.0development
eslint-config-prettier
Environment
{
  "local_name": "eslint-config-prettier",
  "alias": false,
  "peer_metadata": null
}
^8.1.0development
eslint-plugin-import
Environment
{
  "local_name": "eslint-plugin-import",
  "alias": false,
  "peer_metadata": null
}
^2.26.0development
eslint-plugin-jest
Environment
{
  "local_name": "eslint-plugin-jest",
  "alias": false,
  "peer_metadata": null
}
^26.8.2development
eslint-plugin-jsdoc
Environment
{
  "local_name": "eslint-plugin-jsdoc",
  "alias": false,
  "peer_metadata": null
}
^39.2.9development
eslint-plugin-node
Environment
{
  "local_name": "eslint-plugin-node",
  "alias": false,
  "peer_metadata": null
}
^11.1.0development
eslint-plugin-prettier
Environment
{
  "local_name": "eslint-plugin-prettier",
  "alias": false,
  "peer_metadata": null
}
^4.2.1development
node-stdlib-browser
Environment
{
  "local_name": "node-stdlib-browser",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
prettier
Environment
{
  "local_name": "prettier",
  "alias": false,
  "peer_metadata": null
}
^2.2.1development
prettier-plugin-packagejson
Environment
{
  "local_name": "prettier-plugin-packagejson",
  "alias": false,
  "peer_metadata": null
}
^2.2.11development
rimraf
Environment
{
  "local_name": "rimraf",
  "alias": false,
  "peer_metadata": null
}
^3.0.2development
through2
Environment
{
  "local_name": "through2",
  "alias": false,
  "peer_metadata": null
}
^4.0.2development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
^4.7.4development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "integrity": "sha512-4bUUIHqVXg1c+djMujIH6IS5XOjn7r3R2RvQehhFdlx9nOsVndus5jYVsuHQBte3+/rFz/vQLQvfc2pkfqTsxQ==",
  "shasum": "579bf61dab771aeaeafc0d6fd0ca3d10a8d07fed",
  "tarball": "https://registry.npmjs.org/@0xpolygonid/snap-example/-/snap-example-1.0.0-beta.8.tgz",
  "fileCount": 5,
  "unpackedSize": 142790842,
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEQCIE9mo8sLJaZS2G/+5gcZxBP/ElLUHhJswIqFZd38tY2KAiAskY1w8hEqNV2Kk+JnyW9HH5vaJug1HDKM8hK7Ar4QWw=="
    }
  ]
}

Repository

PENDING
0xpolygonid/snap-example

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 21 Oct, 09:31 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:a8d0b34ca2ad1b574e6a8f4ebe26bcd2ba0bc91aee92baf9adc5d4ecd7616412

Other collected versions

1.0.0-beta.91 Aug1.0.0-beta.718 Jul1.0.0-beta.618 Jul1.0.0-beta.511 Jul1.0.0-beta.410 Jul1.0.0-beta.36 JulView all collected versions →