Skip to content

Latest commit

 

History

History
77 lines (58 loc) · 3.77 KB

README.md

File metadata and controls

77 lines (58 loc) · 3.77 KB
Raw

Onchain merklized issuer demo

NOTE: This is a demo only. Do not use it in a production environment.

Description

This is a demo service that communicates with the merklized on-chain issuer to issuer merklized credential. At first glance, it may appear to be a decentralized issuer, but it is not. In the case of a merklized credential, the service issues a credential locally, then calculates the Merkle root for the credential and saves the core claim of the credential on-chain. As a result, the user will have a MTP proof, and the issuer will manage all of their trees on-chain. After that, the user can use the MTP proof to build a ZK proof to prove the claim on-chain with an on-chain verifier.
If you want to have a decentralized on-chain issuer, consider using this contract and this demo.

Quick Start Installation

Requirements:

  • Docker
  • Docker-compose
  • Ngrok

Steps to run:

  1. Deploy the on-chain merklized issuer contract. Script to deploy or use the npm command.

  2. Copy .env.example to .env

    cp .env.example .env

  3. Run ngrok on 8080 port.

    ngrok http 8080

  4. Use the utility to calculate the issuerDID from the smart contract address:

    go run utils/convertor.go --contract_address=<ADDRESS_OF_ONCHAIN_ISSUER_CONTRACT>

    Available flags:

    • contract_address - contract address that will convert to did
    • network - network of the contract. Default: polygon
    • chain - chain of the contract. Default: amoy

  5. Fill the .env config file with the proper variables:

    SUPPORTED_RPC="80002=<RPC_POLYGON_AMOY>"
ISSUERS_PRIVATE_KEY="<ISSUER_DID>=<PRIVATE_KEY_OF_THE_CONTRACT_DEPLOYER>"
EXTERNAL_HOST="<NGROK_URL>"

    ISSUERS_PRIVATE_KEY supports a list of issuers in the format "issuerDID=ket,issuerDID2=key2"

  6. Use the docker-compose file:

    docker-compose build
docker-compose up -d

  7. Open: http://localhost:3000

How to verify the balance claim:

  1. Visit https://tools.privado.id/query-builder.
  2. In the URL to JSON-LD context field, select the schema ipfs://QmbbTKPTJy5zpS2aWBRps1duU8V3zC84jthpWDXE9mLHBX.
  3. In the Attribute field text box, select the balance field.
  4. In the Proof type field, select Merkle Tree Proof (MTP) proof type.
  5. In the Circuit ID drop down, select the Credential Atomic Query MTP v2 circuit.
  6. Select a query type in the Query type section.
  7. Select a Operator if you have selected the Conditional check box in the Query type section.
  8. Provide an attribute value in the Attribute value field if you have selected the Conditional check box.
  9. Click the Create query button.
  10. Scan the QR code using the mobile application.

License

onchain-merklized-issuer-demo is part of the 0xPolygonID project copyright 2024 ZKID Labs AG

This project is licensed under either of

at your option.