github/self
1
1
Fork 0
mirror of https://github.com/selfxyz/self.git synced 2026-04-27 03:01:15 -04:00
Code Issues Packages Projects Releases Wiki Activity

update to npm packages format

Browse Source
This commit is contained in:
turnoffthiscomputer
2024-06-13 14:40:49 +02:00
parent 9252366004
commit cd686d6d4b
7 changed files with 105 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
sdk/ProofOfPassportVerifierReport.ts Normal file
View File

@@ -0,0 +1,33 @@
export class ProofOfPassportVerifierReport {
scope: boolean = false;
merkle_root: boolean = false;
attestation_id: boolean = false;
current_date: boolean = false;
issuing_state: boolean = false;
name: boolean = false;
passport_number: boolean = false;
nationality: boolean = false;
date_of_birth: boolean = false;
gender: boolean = false;
expiry_date: boolean = false;
older_than: boolean = false;
owner_of: boolean = false;
proof: boolean = false;
valid: boolean = true;
public user_identifier: number;
public nullifier: number;
constructor() { }
exposeAttribute(attribute: keyof ProofOfPassportVerifierReport) {
(this[attribute] as boolean) = true;
this.valid = false;
}
toJson() {
return JSON.stringify(this);
}
}

84
sdk/sdk.ts → sdk/ProofOfPassportWeb2Verifier.ts
View File

@@ -1,9 +1,9 @@
import { groth16 } from 'snarkjs';
import fs from 'fs';
import { attributeToPosition, countryCodes, DEFAULT_RPC_URL, PASSPORT_ATTESTATION_ID, SBT_ABI, SBT_CONTRACT_ADDRESS } from '../common/src/constants/constants';
import { ethers } from 'ethers';
import { attributeToGetter, checkMerkleRoot, getCurrentDateFormatted, parsePublicSignals, unpackReveal } from './utils';
import { attributeToPosition, countryCodes, DEFAULT_RPC_URL, PASSPORT_ATTESTATION_ID } from '../common/src/constants/constants';
import { checkMerkleRoot, getCurrentDateFormatted, parsePublicSignals, unpackReveal } from './utils';
import dotenv from 'dotenv';
import { ProofOfPassportVerifierReport } from './ProofOfPassportVerifierReport';
dotenv.config();
@@ -94,83 +94,6 @@ export class ProofOfPassportWeb2Verifier {
return this.report;
}
}
export class ProofOfPassportWeb3Verifier {
scope: string;
attestationId: string;
requirements: Array<[string, number | string]>;
rpcUrl: string;
report: ProofOfPassportVerifierReport;
constructor(options: { scope: string, attestationId?: string, requirements?: Array<[string, number | string]>, rpcUrl?: string }) {
this.scope = options.scope;
this.attestationId = options.attestationId || PASSPORT_ATTESTATION_ID;
this.requirements = options.requirements || [];
this.rpcUrl = options.rpcUrl || DEFAULT_RPC_URL;
this.report = new ProofOfPassportVerifierReport();
}
async verify(address: string, tokenID: number): Promise<ProofOfPassportVerifierReport> {
const provider = new ethers.JsonRpcProvider(this.rpcUrl);
const contract = new ethers.Contract(SBT_CONTRACT_ADDRESS, SBT_ABI, provider);
//1. Verify the user owns a soulbond token
const ownerOfToken = await contract.ownerOf(tokenID);
if (ownerOfToken !== address) {
this.report.exposeAttribute('owner_of');
}
//2. Verify attributes of the soublond token
for (const requirement of this.requirements) {
const attribute = requirement[0];
const value = requirement[1];
const getterName = attributeToGetter[attribute];
if (typeof contract[getterName] !== 'function') {
console.error(`No such function ${getterName} on contract`);
continue;
}
const SBTAttribute = await contract[getterName](tokenID);
if (SBTAttribute !== value) {
this.report.exposeAttribute(attribute as keyof ProofOfPassportVerifierReport);
}
}
return this.report;
}
}
class ProofOfPassportVerifierReport {
scope: boolean = false;
merkle_root: boolean = false;
attestation_id: boolean = false;
current_date: boolean = false;
issuing_state: boolean = false;
name: boolean = false;
passport_number: boolean = false;
nationality: boolean = false;
date_of_birth: boolean = false;
gender: boolean = false;
expiry_date: boolean = false;
older_than: boolean = false;
owner_of: boolean = false;
proof: boolean = false;
valid: boolean = true;
public user_identifier: number;
public nullifier: number;
constructor() { }
exposeAttribute(attribute: keyof ProofOfPassportVerifierReport) {
(this[attribute] as boolean) = true;
this.valid = false;
}
toJson() {
return JSON.stringify(this);
}
}
export class ProofOfPassportWeb2Inputs {
publicSignals: string[];
@@ -181,4 +104,3 @@ export class ProofOfPassportWeb2Inputs {
this.proof = proof;
}
}

48
sdk/ProofOfPassportWeb3Verifier.ts Normal file
View File

@@ -0,0 +1,48 @@
import { DEFAULT_RPC_URL, PASSPORT_ATTESTATION_ID, SBT_ABI, SBT_CONTRACT_ADDRESS } from '../common/src/constants/constants';
import { ethers } from 'ethers';
import { attributeToGetter } from './utils';
import { ProofOfPassportVerifierReport } from "./ProofOfPassportVerifierReport";
export class ProofOfPassportWeb3Verifier {
scope: string;
attestationId: string;
requirements: Array<[string, number | string]>;
rpcUrl: string;
report: ProofOfPassportVerifierReport;
constructor(options: { scope: string, attestationId?: string, requirements?: Array<[string, number | string]>, rpcUrl?: string }) {
this.scope = options.scope;
this.attestationId = options.attestationId || PASSPORT_ATTESTATION_ID;
this.requirements = options.requirements || [];
this.rpcUrl = options.rpcUrl || DEFAULT_RPC_URL;
this.report = new ProofOfPassportVerifierReport();
}
async verify(address: string, tokenID: number): Promise<ProofOfPassportVerifierReport> {
const provider = new ethers.JsonRpcProvider(this.rpcUrl);
const contract = new ethers.Contract(SBT_CONTRACT_ADDRESS, SBT_ABI, provider);
//1. Verify the user owns a soulbond token
const ownerOfToken = await contract.ownerOf(tokenID);
if (ownerOfToken !== address) {
this.report.exposeAttribute('owner_of');
}
//2. Verify attributes of the soublond token
for (const requirement of this.requirements) {
const attribute = requirement[0];
const value = requirement[1];
const getterName = attributeToGetter[attribute];
if (typeof contract[getterName] !== 'function') {
console.error(`No such function ${getterName} on contract`);
continue;
}
const SBTAttribute = await contract[getterName](tokenID);
if (SBTAttribute !== value) {
this.report.exposeAttribute(attribute as keyof ProofOfPassportVerifierReport);
}
}
return this.report;
}
}

4
sdk/README.md
View File

@@ -2,6 +2,10 @@
## Installation
yarn add @proofofpassport/sdk
## Development
```bash
yarn install-sdk
```

9
sdk/index.ts Normal file
View File

@@ -0,0 +1,9 @@
import { ProofOfPassportWeb2Verifier } from './ProofOfPassportWeb2Verifier';
import { ProofOfPassportWeb2Inputs } from './ProofOfPassportWeb2Verifier';
import { ProofOfPassportWeb3Verifier } from './ProofOfPassportWeb3Verifier';
export {
ProofOfPassportWeb2Verifier,
ProofOfPassportWeb3Verifier,
ProofOfPassportWeb2Inputs
};

8
sdk/package.json
View File

@@ -1,8 +1,13 @@
{
"name": "sdk",
"name": "proof-of-passport-sdk",
"version": "1.0.0",
"main": "index.js",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/zk-passport/proof-of-passport"
},
"author": "turnoffthiscomputer",
"dependencies": {
"@types/chai-as-promised": "^7.1.8",
"@types/expect": "^24.3.0",
@@ -34,6 +39,7 @@
"ts-node": "^10.9.2"
},
"scripts": {
"build": "tsc",
"test": "yarn ts-mocha -p ./tsconfig.json tests/sdk.test.ts --exit",
"install-sdk": "cd ../common && yarn && cd ../sdk && yarn"
}

2
sdk/tests/sdk.test.ts
View File

@@ -7,7 +7,7 @@ import { poseidon2, poseidon6 } from "poseidon-lite";
import { PASSPORT_ATTESTATION_ID } from "../../common/src/constants/constants";
import { formatMrz, packBytes } from '../../common/src/utils/utils';
import { getLeaf } from '../../common/src/utils/pubkeyTree';
import { ProofOfPassportWeb2Inputs, ProofOfPassportWeb2Verifier, ProofOfPassportWeb3Verifier } from '../sdk';
import { ProofOfPassportWeb2Inputs, ProofOfPassportWeb2Verifier, ProofOfPassportWeb3Verifier } from '../index';
import dotenv from 'dotenv';
dotenv.config();