Feat: w3c field request & full cred subject disclosure #329

volodymyr-basiuk · 2025-07-24T13:17:37Z

No description provided.

Copilot

Pull Request Overview

This PR adds support for W3C Verifiable Credential v1 fields (credentialStatus, expirationDate, issuanceDate) in zero-knowledge proof queries and verifiable presentations. The changes enable selective disclosure of these fields alongside credential subject data.

Key Changes:

Extended ProofQuery interface to support credentialStatus, expirationDate, and issuanceDate fields
Modified presentation generation to include credentialStatus information in verifiable presentations
Updated proof generation and verification logic to handle W3C v1 credential fields

Reviewed Changes

Copilot reviewed 17 out of 18 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
tests/proofs/sig.test.ts	Updated test expectations to verify verifiable presentations are now always generated (changing from `undefined` to `not.to.be.undefined`), added credentialStatus to test credentials
tests/proofs/sig-onchain.test.ts	Updated test expectation for verifiable presentation generation
tests/proofs/mtp.test.ts	Updated test expectations for verifiable presentation generation
tests/proofs/mtp-onchain.test.ts	Updated test expectation for verifiable presentation generation
tests/proofs/common.test.ts	Fixed field names to include `credentialSubject.` prefix for consistency
tests/mocks/schema.ts	Added BasicPerson schema definitions for new test cases
tests/handlers/auth.test.ts	Added comprehensive test cases for W3C v1 field queries including credential status and selective disclosure
src/verifiable/proof.ts	Extended ProofQuery interface with optional W3C v1 fields
src/verifiable/presentation.ts	Refactored presentation creation to support credential status and dynamic field resolution
src/verifiable/constants.ts	Added CREDENTIAL_STATUS_PATH constant
src/storage/filters/jsonQuery.ts	Added filter support for credentialStatus, expirationDate, and issuanceDate queries
src/proof/verifiers/query.ts	Updated field value extraction path for verifiable presentations
src/proof/verifiers/pub-signals-verifier.ts	Modified to use new parseProofQueryMetadata function with VP support
src/proof/proof-service.ts	Added preprocessing for full object SD and handling of credential status in queries
src/proof/common.ts	Added extensive utility functions for parsing W3C v1 fields and property queries
src/iden3comm/types/protocol/auth.ts	Extended type definitions for W3C v1 proof query fields and verifiable presentation structure
package.json	Version bump from 1.37.1 to 1.38.0
package-lock.json	Version bump in lockfile to match package.json

Comments suppressed due to low confidence (1)

src/verifiable/presentation.ts:56

Potential runtime error: The function doesn't handle cases where intermediate properties in the path might be undefined or null. When traversing nested properties (line 53), accessing properties on undefined or null values will throw a runtime error. Consider adding null/undefined checks or using optional chaining with proper error handling.

export const findValue = (fieldName: string, credential: W3CCredential): JsonDocumentObject => {
  const [first, ...rest] = fieldName.split('.');
  let v: unknown = credential[first as keyof W3CCredential];

  for (const part of rest) {
    v = (v as JsonDocumentObject)[part];
  }
  return v as JsonDocumentObject;
};

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-07T18:49:13Z

src/proof/proof-service.ts

+      let credentialType = proofReq.query['type'] as string;
+      // todo: check if we can move this to the parseQueryMetadata function
+      if (propertyMetadata.fieldName.startsWith('credentialStatus.')) {
+        credentialType = preparedCredential.credential.credentialStatus.type;


Potential null pointer exception: preparedCredential.credential.credentialStatus may be undefined. Add a null check before accessing .type property to prevent runtime errors. Consider: credentialType = preparedCredential.credential.credentialStatus?.type ?? credentialType; or throw a descriptive error if credentialStatus is required.

Suggested change

credentialType = preparedCredential.credential.credentialStatus.type;

credentialType = preparedCredential.credential.credentialStatus?.type ?? credentialType;

Copilot · 2025-11-07T18:49:14Z

src/proof/proof-service.ts

+    if (credentialSubject && Object.keys(credentialSubject).length === 0) {
+      request.query.credentialSubject = flattenToQueryShape(cred.credentialSubject);
+    }
+    if (credentialStatus && Object.keys(credentialStatus).length === 0) {


Potential null pointer exception: cred.credentialStatus may be undefined when calling flattenToQueryShape. Add a null check before accessing credentialStatus to prevent runtime errors when credentials don't have a credentialStatus field. Consider: if (credentialStatus && Object.keys(credentialStatus).length === 0 && cred.credentialStatus) { ... }

Suggested change

if (credentialStatus && Object.keys(credentialStatus).length === 0) {

if (credentialStatus && Object.keys(credentialStatus).length === 0 && cred.credentialStatus) {

Copilot · 2025-11-07T18:49:14Z

src/proof/common.ts

+  const [fieldParentObj] = propertyQuery.fieldName.split('.');
+  switch (fieldParentObj) {
+    case 'credentialStatus':
+      propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialStatus.', '');


Potential bug with .replace(): Using replace('credentialStatus.', '') only removes the first occurrence. If the field name is nested like 'credentialStatus.credentialStatus.field', this will incorrectly produce 'credentialStatus.field'. Consider using a more robust approach like removing only the prefix: propertyQuery.fieldName.substring('credentialStatus.'.length) or ensuring the replacement only happens at the start of the string.

Suggested change

propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialStatus.', '');

if (propertyQuery.fieldName.startsWith('credentialStatus.')) {

propertyQuery.fieldName = propertyQuery.fieldName.substring('credentialStatus.'.length);

}

Copilot · 2025-11-07T18:49:15Z

src/verifiable/presentation.ts

+      '@context': credential['@context'],
      type: vcTypes,
      credentialSubject: {
+        // id: credential.credentialSubject.id,


The commented-out line should either be removed or uncommented with proper justification. Leaving commented code in production reduces code readability and maintainability. If this ID field is intentionally excluded from the presentation, consider adding a comment explaining why.

Suggested change

// id: credential.credentialSubject.id,

// The 'id' field is intentionally excluded from credentialSubject to comply with privacy requirements.

Copilot · 2025-11-07T18:49:15Z

tests/handlers/auth.test.ts

+    const expectedCredSubject = basicPersonCred.credentialSubject;
+    delete expectedCredSubject.id;


Mutating test data (delete expectedCredSubject.id) is an anti-pattern that can cause issues if the same object is reused elsewhere in tests. Consider creating a new object without the id field instead: const expectedCredSubject = { ...basicPersonCred.credentialSubject }; delete expectedCredSubject.id; or use object destructuring: const { id, ...expectedCredSubject } = basicPersonCred.credentialSubject;

Suggested change

const expectedCredSubject = basicPersonCred.credentialSubject;

delete expectedCredSubject.id;

const { id, ...expectedCredSubject } = basicPersonCred.credentialSubject;

Copilot · 2025-11-07T18:49:16Z

src/proof/common.ts

+    const flattened = flattenToQueryShape(
+      (vp.verifiableCredential as Record<string, any>)[documentName],


Potential runtime error: When accessing (vp.verifiableCredential as Record<string, any>)[documentName], there's no check that the property exists. If verifiableCredential doesn't have a credentialStatus field when documentName is 'credentialStatus', this will pass undefined to flattenToQueryShape, which may cause unexpected behavior. Add a check: const docValue = (vp.verifiableCredential as Record<string, any>)[documentName]; if (!docValue) { throw new Error(...) }

Suggested change

const flattened = flattenToQueryShape(

(vp.verifiableCredential as Record<string, any>)[documentName],

const docValue = (vp.verifiableCredential as Record<string, any>)[documentName];

if (!docValue) {

throw new Error(`VerifiableCredential is missing the required property '${documentName}' for full disclosure`);

}

const flattened = flattenToQueryShape(

docValue,

Copilot · 2025-11-07T18:49:16Z

src/proof/proof-service.ts

+      // todo: check if we can move this to the parseQueryMetadata function
+      if (propertyMetadata.fieldName.startsWith('credentialStatus.')) {


TODO comment left in production code: "todo: check if we can move this to the parseQueryMetadata function". Consider either implementing this refactoring now or creating a tracked issue for it. Leaving TODO comments without follow-up reduces code maintainability.

Copilot · 2025-11-07T18:49:16Z

src/proof/common.ts

+      break;
+    case 'credentialSubject':
+    case '':
+      propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialSubject.', '');


Potential bug with .replace(): Using replace('credentialSubject.', '') only removes the first occurrence. If the field name is nested like 'credentialSubject.credentialSubject.field', this will incorrectly produce 'credentialSubject.field'. Consider using a more robust approach like removing only the prefix: propertyQuery.fieldName.substring('credentialSubject.'.length) or ensuring the replacement only happens at the start of the string.

Suggested change

propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialSubject.', '');

if (propertyQuery.fieldName.startsWith('credentialSubject.')) {

propertyQuery.fieldName = propertyQuery.fieldName.substring('credentialSubject.'.length);

}

Copilot · 2025-11-07T18:49:17Z

src/proof/verifiers/pub-signals-verifier.ts

-import { calculateCoreSchemaHash, ProofQuery, ProofType } from '../../verifiable';
+import {
+  calculateCoreSchemaHash,
+  CredentialStatusType,


Unused import CredentialStatusType.

Suggested change

CredentialStatusType,

volodymyr-basiuk added 14 commits July 23, 2025 19:02

w3c field request (expirationDate proof generation)

65d934b

fix query

036d25a

update vp for w3c field

8807e11

sd in test

ca5ad10

format

cc0a66f

add isW3C option

c2ccf16

undo

60f5e91

buildFieldPath fix

1641e6c

format

19ae3a1

Merge branch 'main' into feat/w3c-field-request

9407eba

fix verification

418d08f

fix build

e35090d

fix hardcoded

cdc692e

remove redundant checks

0801965

volodymyr-basiuk requested a review from vmidyllic July 24, 2025 15:10

volodymyr-basiuk added 15 commits July 25, 2025 14:12

move parsing to one function

c31dd25

prettier

d4b04e7

fix StateProof import in common.ts

bd62d94

use type instead of enum

dfdb64d

add issuanceDate

742e95d

flattenNestedObject

0bcdf81

fix query

58ec2a4

refactor

650c8f1

parseJsonDocumentObject reuse

5e60a04

add proposal for revocationNonce query request

1f0fcbc

fix type in vp

590be12

add test schema

549e3fc

fix merklization

000bc7e

'credentialStatus.revocationNonce'

cd2fa80

rm hardcoded

9959cb7

volodymyr-basiuk and others added 14 commits July 30, 2025 12:41

fix query

ed9b1c9

preprocess

3113620

SD of credentialSubject

9ace6eb

fix

1eee921

always createVerifiablePresentation

129b09b

flattened*

5274089

vp always exists

8be60e4

add context to vp in unit tests

1861e31

update IDEN3_PROOFS_DEFINITION_DOCUMENT

5a628ab

check $eq in revNonce

92ae68d

fix VP and add more tests

9282aa1

VP credentialStatus fix unit test

c6800ce

Merge branch 'main' into feat/w3c-field-request

b57e4db

Merge branch 'main' into feat/w3c-field-request

9991475

volodymyr-basiuk marked this pull request as ready for review November 5, 2025 14:28

volodymyr-basiuk changed the title ~~[WIP] Feat/w3c field request~~ Feat/w3c field request Nov 7, 2025

volodymyr-basiuk added 6 commits November 7, 2025 17:07

remove 'kind' field/simplify

cee32a8

fix unit

50c1ac0

remove credentialSubject.id from vp

88fd107

fix verification

7fcf4b3

fix unit for parseQueryMetadata

3c768ed

fix more than 10 queries

5a9dda0

volodymyr-basiuk requested review from Kolezhniuk and Copilot November 7, 2025 18:43

volodymyr-basiuk changed the title ~~Feat/w3c field request~~ Feat: w3c field request & full cred subject disclosure Nov 7, 2025

Copilot AI reviewed Nov 7, 2025

View reviewed changes

volodymyr-basiuk added 4 commits November 7, 2025 20:59

resolve some

cfdc0cc

fix unit

2d02cea

fix mergeObjects if credSubject is missed (cred existance)

c437d0f

Merge branch 'main' into feat/w3c-field-request

ffcd0a3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Feat: w3c field request & full cred subject disclosure #329

Feat: w3c field request & full cred subject disclosure #329

Uh oh!

volodymyr-basiuk commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Copilot AI Nov 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	credentialType = preparedCredential.credential.credentialStatus.type;
	credentialType = preparedCredential.credential.credentialStatus?.type ?? credentialType;

	if (credentialStatus && Object.keys(credentialStatus).length === 0) {
	if (credentialStatus && Object.keys(credentialStatus).length === 0 && cred.credentialStatus) {

-      propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialStatus.', '');
+      if (propertyQuery.fieldName.startsWith('credentialStatus.')) {
+        propertyQuery.fieldName = propertyQuery.fieldName.substring('credentialStatus.'.length);
+      }

	// id: credential.credentialSubject.id,
	// The 'id' field is intentionally excluded from credentialSubject to comply with privacy requirements.

		const expectedCredSubject = basicPersonCred.credentialSubject;
		delete expectedCredSubject.id;

	const expectedCredSubject = basicPersonCred.credentialSubject;
	delete expectedCredSubject.id;
	const { id, ...expectedCredSubject } = basicPersonCred.credentialSubject;

		const flattened = flattenToQueryShape(
		(vp.verifiableCredential as Record<string, any>)[documentName],

-    const flattened = flattenToQueryShape(
-      (vp.verifiableCredential as Record<string, any>)[documentName],
+    const docValue = (vp.verifiableCredential as Record<string, any>)[documentName];
+    if (!docValue) {
+      throw new Error(`VerifiableCredential is missing the required property '${documentName}' for full disclosure`);
+    }
+    const flattened = flattenToQueryShape(
+      docValue,

		// todo: check if we can move this to the parseQueryMetadata function
		if (propertyMetadata.fieldName.startsWith('credentialStatus.')) {

-      propertyQuery.fieldName = propertyQuery.fieldName.replace('credentialSubject.', '');
+      if (propertyQuery.fieldName.startsWith('credentialSubject.')) {
+        propertyQuery.fieldName = propertyQuery.fieldName.substring('credentialSubject.'.length);
+      }

Feat: w3c field request & full cred subject disclosure #329

Are you sure you want to change the base?

Feat: w3c field request & full cred subject disclosure #329

Uh oh!

Conversation

volodymyr-basiuk commented Jul 24, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 7, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants