npm install https://github.com/zkpassport/zkpassport-sdk.git
import { ZkPassport } from 'zkpassport-sdk'
// Replace with your domain
const zkPassport = new ZkPassport('demo.zkpassport.id')
// Specify your app name, logo and the purpose of the request
// you'll send to your visitors or users
const queryBuilder = await zkPassport.request({
name: 'ZKpassport',
logo: 'https://zkpassport.id/logo.png',
purpose: 'Proof of country and first name',
})
// Specify the data you want to disclose
// Then you can call the `done` method to get the url and the callbacks to follow the progress
// and get back the result along with the proof
const { url, requestId, onQRCodeScanned, onGeneratingProof, onProofGenerated, onReject, onError } = queryBuilder
.disclose('nationality')
.disclose('firstname')
.done()
// Generate a url with the url and let your user scan it
// or transform it into a button if the user is on mobile
onQRCodeScanned(() => {
// The user scanned the QR code or clicked the button
// Essentially, this means the request popup is now opened
// on the user phone
console.log('QR code scanned')
})
onGeneratingProof(() => {
// The user accepted the request and the proof is being generated
console.log('Generating proof')
})
onProofGenerated((result: ProofResult) => {
// The proof has been generated
// You can retrieve the proof, the verification key and the result of your query
// Note: the verify function will soon be added to the SDK so you can verify the proof
// directly
console.log('Proof', result.proof)
console.log('Verification key', result.verificationKey)
console.log('Query result', result.queryResult)
console.log('firstname', result.queryResult.firstname.disclose.result)
console.log('nationality', result.queryResult.nationality.disclose.result)
})git clone https://github.com/zkpassport/zkpassport-sdk.git
cd zkpassport-sdkbun installbun testSimulate mobile websocket messages: bun run scripts/simulate.ts mobile
Simulate frontend websocket messages: bun run scripts/simulate.ts frontend