@bifold/verifier 1.0.0

package/src/__tests__/verifier/__snapshots__/proof.test.ts.snap

@@ -0,0 +1,135 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Helpers Get proof identifiers 1`] = `
+Object {
+  "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+  "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+}
+`;
+
+exports[`Helpers Group shared proof data by credential 1`] = `
+Map {
+  "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest" => Object {
+    "data": CredentialSharedProofData {
+      "resolvedPredicates": Array [
+        Object {
+          "identifiers": Object {
+            "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+            "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+          },
+          "name": "age",
+          "predicateType": ">=",
+          "predicateValue": 1,
+        },
+      ],
+      "sharedAttributeGroups": Array [
+        Object {
+          "attributes": Array [
+            Object {
+              "name": "first_name",
+              "value": "Aries",
+            },
+            Object {
+              "name": "second_name",
+              "value": "Bifold",
+            },
+          ],
+          "identifiers": Object {
+            "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+            "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+          },
+        },
+      ],
+      "sharedAttributes": Array [
+        Object {
+          "identifiers": Object {
+            "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+            "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+          },
+          "name": "date",
+          "value": "1/1/1",
+        },
+      ],
+    },
+    "identifiers": Object {
+      "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+      "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+    },
+  },
+  "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712168:latest" => Object {
+    "data": CredentialSharedProofData {
+      "resolvedPredicates": Array [],
+      "sharedAttributeGroups": Array [],
+      "sharedAttributes": Array [
+        Object {
+          "identifiers": Object {
+            "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712168:latest",
+            "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Passport:1.0.0",
+          },
+          "name": "passport_no",
+          "value": "123123",
+        },
+      ],
+    },
+    "identifiers": Object {
+      "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712168:latest",
+      "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Passport:1.0.0",
+    },
+  },
+}
+`;
+
+exports[`Helpers Parse indy proof 1`] = `
+ParsedAnonCredsProof {
+  "resolvedPredicates": Array [
+    Object {
+      "identifiers": Object {
+        "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+        "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+      },
+      "name": "age",
+      "predicateType": ">=",
+      "predicateValue": 1,
+    },
+  ],
+  "sharedAttributeGroups": Array [
+    Object {
+      "attributes": Array [
+        Object {
+          "name": "first_name",
+          "value": "Aries",
+        },
+        Object {
+          "name": "second_name",
+          "value": "Bifold",
+        },
+      ],
+      "identifiers": Object {
+        "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+        "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+      },
+    },
+  ],
+  "sharedAttributes": Array [
+    Object {
+      "identifiers": Object {
+        "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest",
+        "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0",
+      },
+      "name": "date",
+      "value": "1/1/1",
+    },
+    Object {
+      "identifiers": Object {
+        "cred_def_id": "7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712168:latest",
+        "schema_id": "7KuDTpQh3GJ7Gp6kErpWvM:2:Passport:1.0.0",
+      },
+      "name": "passport_no",
+      "value": "123123",
+    },
+  ],
+  "unresolvedAttributeGroups": Array [],
+  "unresolvedAttributes": Array [],
+  "unresolvedPredicates": Array [],
+}
+`;

package/src/__tests__/verifier/proof-request.test.ts

@@ -0,0 +1,34 @@
+import { getProofRequestTemplates } from '../../request-templates'
+import { buildProofRequestDataForTemplate, hasPredicates } from '../../utils/proof-request'
+
+import SpyInstance = jest.SpyInstance
+
+describe('Helpers', () => {
+  let spy: SpyInstance
+
+  beforeAll(() => {
+    spy = jest.spyOn(Date, 'now').mockImplementation(() => 1677766511505)
+  })
+  const templates = getProofRequestTemplates(false)
+
+  test('Build anoncreds proof request from template containing two requested attributes', async () => {
+    const template = templates[0]
+    const proofRequest = buildProofRequestDataForTemplate(template)
+    expect(proofRequest).toMatchSnapshot()
+  })
+
+  test('Build anoncreds proof request from template containing two requested attributes and predicate', async () => {
+    const template = templates[1]
+    const proofRequest = buildProofRequestDataForTemplate(template)
+    expect(proofRequest).toMatchSnapshot()
+  })
+
+  test('Check if proof has predicates', async () => {
+    expect(hasPredicates(templates[0])).toBeFalsy()
+    expect(hasPredicates(templates[1])).toBeTruthy()
+  })
+
+  afterAll(() => {
+    spy.mockRestore()
+  })
+})

package/src/__tests__/verifier/proof.test.ts

@@ -0,0 +1,99 @@
+import { AnonCredsProof } from '@credo-ts/anoncreds'
+import { getProofIdentifiers, groupSharedProofDataByCredential, parseAnonCredsProof } from '../../utils/proof'
+const proof_request = {
+  name: 'proof-request',
+  version: '1.0',
+  nonce: '1298236324864',
+  requested_attributes: {
+    attribute_1: {
+      names: ['first_name', 'second_name'],
+    },
+    attribute_2: {
+      name: 'date',
+    },
+    attribute_3: {
+      name: 'passport_no',
+    },
+  },
+  requested_predicates: {
+    predicate_1: {
+      name: 'age',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      p_type: '>=' as any,
+      p_value: 1,
+    },
+  },
+}
+
+const proof: AnonCredsProof = {
+  proof: {
+    proofs: [],
+    aggregated_proof: {
+      c_list: [],
+    },
+  },
+  requested_proof: {
+    revealed_attrs: {
+      attribute_2: {
+        sub_proof_index: 0,
+        raw: '1/1/1',
+        encoded: '',
+      },
+      attribute_3: {
+        sub_proof_index: 1,
+        raw: '123123',
+        encoded: '',
+      },
+    },
+    revealed_attr_groups: {
+      attribute_1: {
+        sub_proof_index: 0,
+        values: {
+          first_name: {
+            raw: 'Aries',
+            encoded: '',
+          },
+          second_name: {
+            raw: 'Bifold',
+            encoded: '',
+          },
+        },
+      },
+    },
+    self_attested_attrs: {},
+    unrevealed_attrs: {},
+    predicates: {
+      predicate_1: {
+        sub_proof_index: 0,
+      },
+    },
+  },
+  identifiers: [
+    {
+      schema_id: '7KuDTpQh3GJ7Gp6kErpWvM:2:Faber College:1.0.0',
+      cred_def_id: '7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712167:latest',
+    },
+    {
+      schema_id: '7KuDTpQh3GJ7Gp6kErpWvM:2:Passport:1.0.0',
+      cred_def_id: '7KuDTpQh3GJ7Gp6kErpWvM:3:CL:712168:latest',
+    },
+  ],
+}
+
+describe('Helpers', () => {
+  test('Parse indy proof', async () => {
+    const proofRequest = parseAnonCredsProof(proof_request, proof)
+    expect(proofRequest).toMatchSnapshot()
+  })
+
+  test('Group shared proof data by credential', async () => {
+    const data = parseAnonCredsProof(proof_request, proof)
+    const groupedData = groupSharedProofDataByCredential(data)
+    expect(groupedData).toMatchSnapshot()
+  })
+
+  test('Get proof identifiers', async () => {
+    const identifiers = getProofIdentifiers(proof, 0)
+    expect(identifiers).toMatchSnapshot()
+  })
+})

package/src/constants.ts

@@ -0,0 +1,2 @@
+export const protocolVersion = 'v2'
+export const domain = 'didcomm://invite'

package/src/hooks/proofs.ts

@@ -0,0 +1,20 @@
+import { ProofExchangeRecord } from '@credo-ts/core'
+import { useProofs } from '@credo-ts/react-hooks'
+import { useMemo } from 'react'
+
+import { ProofCustomMetadata, ProofMetadata } from '../types/metadata'
+
+export const useProofsByTemplateId = (templateId: string): ProofExchangeRecord[] => {
+  const { records: proofs } = useProofs()
+
+  return useMemo(
+    () =>
+      proofs.filter((proof: ProofExchangeRecord) => {
+        const metadata = proof?.metadata.get(ProofMetadata.customMetadata) as ProofCustomMetadata
+        if (metadata?.proof_request_template_id === templateId) {
+          return proof
+        }
+      }),
+    [proofs, templateId]
+  )
+}

package/src/index.ts

@@ -0,0 +1,45 @@
+export { ProofRequestType } from './types/proof-reqeust-template'
+export type {
+  ProofRequestTemplate,
+  DifProofRequestTemplatePayload,
+  DifProofRequestTemplatePayloadData,
+  AnonCredsProofRequestTemplatePayload,
+  AnonCredsProofRequestTemplatePayloadData,
+  AnonCredsRequestedAttribute,
+  AnonCredsRequestedPredicate,
+} from './types/proof-reqeust-template'
+export type {
+  GroupedSharedProofData,
+  GroupedSharedProofDataItem,
+  CredentialSharedProofData,
+  ParsedAnonCredsProof,
+  UnresolvedPredicate,
+  ResolvedPredicate,
+  SharedAttributesGroup,
+  SharedGroupedAttribute,
+  SharedAttribute,
+  MissingAttribute,
+} from './types/proof'
+export type { ProofCustomMetadata } from './types/metadata'
+export { ProofMetadata } from './types/metadata'
+export { useProofsByTemplateId } from './hooks/proofs'
+export {
+  getProofIdentifiers,
+  parseAnonCredsProof,
+  groupSharedProofDataByCredential,
+  getProofData,
+  isPresentationReceived,
+  isPresentationFailed,
+  markProofAsViewed,
+  linkProofWithTemplate,
+} from './utils/proof'
+export type { CreateProofRequestInvitationResult, SendProofRequestResult } from './utils/proof-request'
+export {
+  findProofRequestMessage,
+  buildProofRequestDataForTemplate,
+  createConnectionlessProofRequestInvitation,
+  sendProofRequest,
+  hasPredicates,
+  isParameterizable,
+} from './utils/proof-request'
+export { getProofRequestTemplates } from './request-templates'

package/src/request-templates.ts

@@ -0,0 +1,62 @@
+import { ProofRequestTemplate, ProofRequestType } from './types/proof-reqeust-template'
+
+export const getProofRequestTemplates = (useDevRestrictions: boolean) => {
+  const studentRestrictions = [{ cred_def_id: 'XUxBrVSALWHLeycAUhrNr9:3:CL:26293:student_card' }]
+  const studentDevRestrictions = [{ schema_name: 'student_card' }]
+  const restrictions = useDevRestrictions ? studentDevRestrictions : studentRestrictions
+  const defaultProofRequestTemplates: Array<ProofRequestTemplate> = [
+    {
+      id: 'Aries:5:StudentFullName:0.0.1:indy',
+      name: 'Student full name',
+      description: 'Verify the full name of a student',
+      version: '0.0.1',
+      payload: {
+        type: ProofRequestType.AnonCreds,
+        data: [
+          {
+            schema: 'XUxBrVSALWHLeycAUhrNr9:3:CL:26293:Student Card',
+            requestedAttributes: [
+              {
+                name: 'student_first_name',
+                restrictions,
+              },
+              {
+                name: 'student_last_name',
+                restrictions,
+              },
+            ],
+          },
+        ],
+      },
+    },
+    {
+      id: 'Aries:5:StudentFullNameAndExpirationDate:0.0.1:indy',
+      name: 'Student full name and expiration date',
+      description: 'Verify that full name of a student and that he/she has a not expired student card.',
+      version: '0.0.1',
+      payload: {
+        type: ProofRequestType.AnonCreds,
+        data: [
+          {
+            schema: 'XUxBrVSALWHLeycAUhrNr9:3:CL:26293:Student Card',
+            requestedAttributes: [
+              {
+                names: ['student_first_name', 'student_last_name'],
+                restrictions,
+              },
+            ],
+            requestedPredicates: [
+              {
+                name: 'expiry_date',
+                predicateType: '>=',
+                predicateValue: 20240101,
+                restrictions,
+              },
+            ],
+          },
+        ],
+      },
+    },
+  ]
+  return defaultProofRequestTemplates
+}

package/src/types/agent.ts

@@ -0,0 +1,53 @@
+import {
+  AnonCredsCredentialFormatService,
+  AnonCredsModule,
+  AnonCredsProofFormatService,
+  DataIntegrityCredentialFormatService,
+  LegacyIndyCredentialFormatService,
+  LegacyIndyProofFormatService,
+  V1CredentialProtocol,
+  V1ProofProtocol,
+} from '@credo-ts/anoncreds'
+import {
+  Agent,
+  ConnectionsModule,
+  CredentialsModule,
+  DifPresentationExchangeProofFormatService,
+  MediationRecipientModule,
+  ProofsModule,
+  V2CredentialProtocol,
+  V2ProofProtocol,
+} from '@credo-ts/core'
+
+function getAgentModules() {
+  return null as unknown as {
+    //askar: AskarModule
+    //anoncredsRs: AnonCredsRsModule
+    anoncreds: AnonCredsModule
+    //indyVdr: IndyVdrModule
+    connections: ConnectionsModule
+    credentials: CredentialsModule<
+      (
+        | V1CredentialProtocol
+        | V2CredentialProtocol<
+            (
+              | LegacyIndyCredentialFormatService
+              | AnonCredsCredentialFormatService
+              | DataIntegrityCredentialFormatService
+            )[]
+          >
+      )[]
+    >
+    proofs: ProofsModule<
+      (
+        | V1ProofProtocol
+        | V2ProofProtocol<
+            (LegacyIndyProofFormatService | AnonCredsProofFormatService | DifPresentationExchangeProofFormatService)[]
+          >
+      )[]
+    >
+    mediationRecipient: MediationRecipientModule
+  }
+}
+
+export type BifoldAgent = Agent<ReturnType<typeof getAgentModules>>

package/src/types/metadata.ts

@@ -0,0 +1,9 @@
+export enum ProofMetadata {
+  customMetadata = 'customMetadata',
+}
+
+export interface ProofCustomMetadata {
+  details_seen?: boolean
+  proof_request_template_id?: string
+  delete_conn_after_seen?: boolean
+}

package/src/types/proof-reqeust-template.ts

@@ -0,0 +1,59 @@
+import {
+  AnonCredsNonRevokedInterval,
+  AnonCredsPredicateType,
+  AnonCredsProofRequestRestriction,
+} from '@credo-ts/anoncreds'
+
+export interface AnonCredsRequestedPredicate {
+  label?: string
+  name: string
+  predicateType: AnonCredsPredicateType
+  predicateValue: number
+  restrictions?: AnonCredsProofRequestRestriction[]
+  devRestrictions?: AnonCredsProofRequestRestriction[]
+  nonRevoked?: AnonCredsNonRevokedInterval
+  parameterizable?: boolean
+}
+
+export interface AnonCredsRequestedAttribute {
+  label?: string
+  name?: string
+  names?: Array<string>
+  restrictions?: AnonCredsProofRequestRestriction[]
+  devRestrictions?: AnonCredsProofRequestRestriction[]
+  revealed?: boolean
+  nonRevoked?: AnonCredsNonRevokedInterval
+}
+
+export interface AnonCredsProofRequestTemplatePayloadData {
+  schema: string
+  requestedAttributes?: Array<AnonCredsRequestedAttribute>
+  requestedPredicates?: Array<AnonCredsRequestedPredicate>
+}
+
+export enum ProofRequestType {
+  AnonCreds = 'anoncreds',
+  DIF = 'dif',
+}
+
+export interface AnonCredsProofRequestTemplatePayload {
+  type: ProofRequestType.AnonCreds
+  data: Array<AnonCredsProofRequestTemplatePayloadData>
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface DifProofRequestTemplatePayloadData {}
+
+export interface DifProofRequestTemplatePayload {
+  type: ProofRequestType.DIF
+  data: Array<DifProofRequestTemplatePayloadData>
+}
+
+export interface ProofRequestTemplate {
+  id: string
+  name: string
+  description: string
+  version: string
+  devOnly?: boolean
+  payload: AnonCredsProofRequestTemplatePayload | DifProofRequestTemplatePayload
+}

package/src/types/proof.ts

@@ -0,0 +1,68 @@
+import { AnonCredsProof } from '@credo-ts/anoncreds'
+type AnonCredsProofIdentifier = AnonCredsProof['identifiers'][number]
+
+export interface MissingAttribute {
+  name: string
+}
+
+export interface SharedAttribute {
+  name: string
+  value: string
+  identifiers: AnonCredsProofIdentifier
+}
+
+export interface SharedGroupedAttribute {
+  name: string
+  value: string
+}
+
+export interface SharedAttributesGroup {
+  attributes: Array<SharedGroupedAttribute>
+  identifiers: AnonCredsProofIdentifier
+}
+
+export interface ResolvedPredicate {
+  name: string
+  predicateType: string
+  predicateValue: number
+  identifiers: AnonCredsProofIdentifier
+}
+
+export interface UnresolvedPredicate {
+  name: string
+  predicateType: string
+  predicateValue: number
+}
+
+export class ParsedAnonCredsProof {
+  public sharedAttributes: Array<SharedAttribute>
+  public sharedAttributeGroups: Array<SharedAttributesGroup>
+  public resolvedPredicates: Array<ResolvedPredicate>
+  public unresolvedAttributes: Array<MissingAttribute>
+  public unresolvedAttributeGroups: Array<Array<MissingAttribute>>
+  public unresolvedPredicates: Array<UnresolvedPredicate>
+
+  public constructor() {
+    this.sharedAttributes = []
+    this.sharedAttributeGroups = []
+    this.resolvedPredicates = []
+    this.unresolvedAttributes = []
+    this.unresolvedAttributeGroups = []
+    this.unresolvedPredicates = []
+  }
+}
+
+export class CredentialSharedProofData {
+  public sharedAttributes: Array<SharedAttribute>
+  public sharedAttributeGroups: Array<SharedAttributesGroup>
+  public resolvedPredicates: Array<ResolvedPredicate>
+
+  public constructor() {
+    this.sharedAttributes = []
+    this.sharedAttributeGroups = []
+    this.resolvedPredicates = []
+  }
+}
+
+export type GroupedSharedProofDataItem = { data: CredentialSharedProofData; identifiers: AnonCredsProofIdentifier }
+export type GroupedSharedProofData = Map<string, GroupedSharedProofDataItem>