@sphereon/ssi-sdk.vc-status-list 0.33.1-next.73 → 0.34.1-feature.SSISDK.17.bitstring.sl.10

package/src/impl/BitstringStatusListImplementation.ts

@@ -0,0 +1,301 @@
+import type { IAgentContext, ICredentialPlugin, ProofFormat as VeramoProofFormat } from '@veramo/core'
+import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
+import {
+  CredentialMapper,
+  type CredentialProofFormat,
+  DocumentFormat,
+  type IIssuer,
+  type StatusListCredential,
+  StatusListType,
+} from '@sphereon/ssi-types'
+
+import type { IStatusList } from './IStatusList'
+import {
+  BitstringStatus,
+  CheckStatusIndexArgs,
+  CreateStatusListArgs,
+  StatusListResult,
+  ToStatusListDetailsArgs,
+  UpdateStatusListFromEncodedListArgs,
+  UpdateStatusListIndexArgs,
+} from '../types'
+
+import { assertValidProofType, ensureDate, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
+import { BitstringStatusListCredential } from '../types/BitstringStatusList'
+import { BitstreamStatusList, BitstringStatusPurpose, createStatusListCredential } from '@4sure-tech/vc-bitstring-status-lists'
+
+export const DEFAULT_LIST_LENGTH = 131072 // W3C spec minimum
+export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
+export const DEFAULT_STATUS_PURPOSE: BitstringStatusPurpose = 'revocation'
+
+export class BitstringStatusListImplementation implements IStatusList {
+  async createNewStatusList(
+    args: CreateStatusListArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitstringStatusList) {
+      throw new Error('BitstringStatusList options are required for type BitstringStatusList')
+    }
+
+    const length = args?.length ?? DEFAULT_LIST_LENGTH
+    const proofFormat: CredentialProofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
+    assertValidProofType(StatusListType.BitstringStatusList, proofFormat)
+    const veramoProofFormat: VeramoProofFormat = proofFormat as VeramoProofFormat
+
+    const { issuer, id } = args
+    const correlationId = getAssertedValue('correlationId', args.correlationId)
+    const { statusPurpose, bitsPerStatus, validFrom, validUntil, ttl } = args.bitstringStatusList
+    const statusListCredential = await this.createVerifiableCredential(
+      {
+        ...args,
+        proofFormat: veramoProofFormat,
+        statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+        validFrom: ensureDate(validFrom),
+        validUntil: ensureDate(validUntil),
+        ttl,
+      },
+      context,
+    )
+
+    return {
+      encodedList: statusListCredential.credentialSubject.encodedList,
+      statusListCredential: statusListCredential,
+      bitstringStatusList: {
+        statusPurpose: statusPurpose ?? DEFAULT_STATUS_PURPOSE,
+        ...(statusListCredential.validFrom && { validFrom: new Date(statusListCredential.validFrom) }),
+        ...(statusListCredential.validUntil && { validUntil: new Date(statusListCredential.validUntil) }),
+        ttl,
+        bitsPerStatus,
+      },
+      length,
+      type: StatusListType.BitstringStatusList,
+      proofFormat,
+      id,
+      correlationId,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async updateStatusListIndex(
+    args: UpdateStatusListIndexArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListIndex)')
+    }
+
+    const credential = args.statusListCredential
+    const uniform = CredentialMapper.toUniformCredential(credential)
+    const { issuer, credentialSubject } = uniform
+    const id = getAssertedValue('id', uniform.id)
+    const origEncodedList = getAssertedProperty('encodedList', credentialSubject)
+
+    const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    const statusList: BitstreamStatusList = await BitstreamStatusList.decode({ encodedList: origEncodedList, statusSize: args.bitsPerStatus })
+    statusList.setStatus(index, args.value)
+
+    const proofFormat = CredentialMapper.detectDocumentType(credential) === DocumentFormat.JWT ? 'jwt' : 'lds'
+
+    const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
+
+    const statusPurpose = getAssertedProperty('statusPurpose', credSubject)
+
+    const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
+    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
+    const ttl = credSubject.ttl
+
+    const updatedCredential = await this.createVerifiableCredential(
+      {
+        ...args,
+        id,
+        issuer,
+        statusList,
+        proofFormat: proofFormat,
+        statusPurpose,
+        ttl,
+        validFrom,
+        validUntil,
+      },
+      context,
+    )
+
+    return {
+      statusListCredential: updatedCredential,
+      encodedList: updatedCredential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        ...(updatedCredential.validFrom && { validFrom: new Date(updatedCredential.validFrom) }),
+        ...(updatedCredential.validUntil && { validUntil: new Date(updatedCredential.validUntil) }),
+        bitsPerStatus: args.bitsPerStatus,
+        ttl,
+      },
+      length: statusList.getLength(),
+      type: StatusListType.BitstringStatusList,
+      proofFormat: proofFormat,
+      id,
+      issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async updateStatusListFromEncodedList(
+    args: UpdateStatusListFromEncodedListArgs,
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<StatusListResult> {
+    if (!args.bitstringStatusList) {
+      throw new Error('bitstringStatusList options required for type BitstringStatusList')
+    }
+
+    if (args.bitstringStatusList.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (updateStatusListFromEncodedList)')
+    }
+
+    const { statusPurpose, bitsPerStatus, ttl, validFrom, validUntil } = args.bitstringStatusList
+
+    const proofFormat: CredentialProofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
+    assertValidProofType(StatusListType.BitstringStatusList, proofFormat)
+    const veramoProofFormat: VeramoProofFormat = proofFormat as VeramoProofFormat
+
+    const { issuer, id } = getAssertedValues(args)
+    const statusList: BitstreamStatusList = await BitstreamStatusList.decode({ encodedList: args.encodedList, statusSize: bitsPerStatus })
+    const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    statusList.setStatus(index, args.value)
+
+    const credential = await this.createVerifiableCredential(
+      {
+        id,
+        issuer,
+        statusList,
+        proofFormat: veramoProofFormat,
+        keyRef: args.keyRef,
+        statusPurpose,
+        validFrom: ensureDate(validFrom),
+        validUntil: ensureDate(validUntil),
+        ttl,
+      },
+      context,
+    )
+
+    return {
+      type: StatusListType.BitstringStatusList,
+      statusListCredential: credential,
+      encodedList: credential.credentialSubject.encodedList,
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        ...(credential.validFrom && { validFrom: new Date(credential.validFrom) }),
+        ...(credential.validUntil && { validUntil: new Date(credential.validUntil) }),
+        ttl,
+      },
+      length: statusList.getLength(),
+      proofFormat: args.proofFormat ?? 'lds',
+      id: id,
+      issuer: issuer,
+      statuslistContentType: this.buildContentType(proofFormat),
+    }
+  }
+
+  async checkStatusIndex(args: CheckStatusIndexArgs): Promise<BitstringStatus> {
+    if (!args.bitsPerStatus || args.bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (checkStatusIndex)')
+    }
+
+    const uniform = CredentialMapper.toUniformCredential(args.statusListCredential)
+    const { credentialSubject } = uniform
+    const encodedList = getAssertedProperty('encodedList', credentialSubject)
+
+    const statusSize = args.bitsPerStatus
+    const statusList = await BitstreamStatusList.decode({ encodedList, statusSize })
+
+    const numIndex = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
+    if (statusList.getLength() <= numIndex) {
+      throw new Error(`Status list index out of bounds, has ${statusList.getLength()} entries, requested ${numIndex}`)
+    }
+    return statusList.getStatus(numIndex)
+  }
+
+  async toStatusListDetails(args: ToStatusListDetailsArgs): Promise<StatusListResult> {
+    const { statusListPayload, bitsPerStatus } = args
+    if (!bitsPerStatus || bitsPerStatus < 1) {
+      return Promise.reject('bitsPerStatus must be set for bitstring status lists and must be 1 or higher. (toStatusListDetails)')
+    }
+
+    const uniform = CredentialMapper.toUniformCredential(statusListPayload)
+    const { issuer, credentialSubject } = uniform
+    const id = getAssertedValue('id', uniform.id)
+    const encodedList = getAssertedProperty('encodedList', credentialSubject)
+    const proofFormat: CredentialProofFormat = CredentialMapper.detectDocumentType(statusListPayload) === DocumentFormat.JWT ? 'jwt' : 'lds'
+    const credSubject = Array.isArray(credentialSubject) ? credentialSubject[0] : credentialSubject
+    const statusPurpose = getAssertedProperty('statusPurpose', credSubject)
+    const validFrom = uniform.validFrom ? new Date(uniform.validFrom) : undefined
+    const validUntil = uniform.validUntil ? new Date(uniform.validUntil) : undefined
+    const ttl = credSubject.ttl
+    const statuslistLength: number = BitstreamStatusList.getStatusListLength(encodedList, bitsPerStatus)
+
+    return {
+      id,
+      encodedList,
+      issuer,
+      type: StatusListType.BitstringStatusList,
+      proofFormat,
+      length: statuslistLength,
+      statusListCredential: statusListPayload,
+      statuslistContentType: this.buildContentType(proofFormat),
+      bitstringStatusList: {
+        statusPurpose,
+        bitsPerStatus,
+        validFrom,
+        validUntil,
+        ttl,
+      },
+      ...(args.correlationId && { correlationId: args.correlationId }),
+      ...(args.driverType && { driverType: args.driverType }),
+    }
+  }
+
+  private async createVerifiableCredential(
+    args: {
+      id: string
+      issuer: string | IIssuer
+      statusList?: BitstreamStatusList
+      proofFormat: VeramoProofFormat
+      statusPurpose: BitstringStatusPurpose
+      validFrom?: Date
+      validUntil?: Date
+      ttl?: number
+      keyRef?: string
+    },
+    context: IAgentContext<ICredentialPlugin & IIdentifierResolution>,
+  ): Promise<BitstringStatusListCredential> {
+    const identifier = await context.agent.identifierManagedGet({
+      identifier: typeof args.issuer === 'string' ? args.issuer : args.issuer.id,
+      vmRelationship: 'assertionMethod',
+      offlineWhenNoDIDRegistered: true,
+    })
+
+    const unsignedCredential = await createStatusListCredential(args)
+
+    const verifiableCredential = await context.agent.createVerifiableCredential({
+      credential: unsignedCredential,
+      keyRef: args.keyRef ?? identifier.kmsKeyRef,
+      proofFormat: args.proofFormat,
+      fetchRemoteContexts: true,
+    })
+
+    return CredentialMapper.toWrappedVerifiableCredential(verifiableCredential as StatusListCredential).original as BitstringStatusListCredential
+  }
+
+  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
+    switch (proofFormat) {
+      case 'jwt':
+        return `application/statuslist+jwt`
+      case 'cbor':
+        return `application/statuslist+cwt`
+      case 'lds':
+        return 'application/statuslist+ld+json'
+      default:
+        throw Error(`Unsupported content type '${proofFormat}' for status lists`)
+    }
+  }
+}

package/src/impl/IStatusList.ts

@@ -1,6 +1,7 @@
 import type { IAgentContext, ICredentialPlugin } from '@veramo/core'
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
-import type {
+import {
+  BitstringStatus,
   CheckStatusIndexArgs,
   CreateStatusListArgs,
   Status2021,
@@ -33,7 +34,7 @@ export interface IStatusList {
   /**
    * Checks the status at a given index in the status list
    */
-  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth>
+  checkStatusIndex(args: CheckStatusIndexArgs): Promise<number | Status2021 | StatusOAuth | BitstringStatus>
 
   /**
    * Collects the status list details

package/src/impl/OAuthStatusList.ts

@@ -1,5 +1,5 @@
 import type { IAgentContext, ICredentialPlugin, IKeyManager } from '@veramo/core'
-import { type CompactJWT, type CWT, type CredentialProofFormat, StatusListType } from '@sphereon/ssi-types'
+import { type CompactJWT, type CredentialProofFormat, type CWT, StatusListType } from '@sphereon/ssi-types'
 import type {
   CheckStatusIndexArgs,
   CreateStatusListArgs,
@@ -10,7 +10,7 @@ import type {
   UpdateStatusListFromEncodedListArgs,
   UpdateStatusListIndexArgs,
 } from '../types'
-import { determineProofFormat, getAssertedValue, getAssertedValues } from '../utils'
+import { determineProofFormat, ensureDate, getAssertedValue, getAssertedValues } from '../utils'
 import type { IStatusList } from './IStatusList'
 import { StatusList } from '@sd-jwt/jwt-status-list'
 import type { IJwtService } from '@sphereon/ssi-sdk-ext.jwt-service'
@@ -20,7 +20,7 @@ import { createSignedCbor, decodeStatusListCWT } from './encoding/cbor'
 
 type IRequiredContext = IAgentContext<ICredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>
 
-export const DEFAULT_BITS_PER_STATUS = 1 // 1 bit is sufficient for 0x00 - "VALID"  0x01 - "INVALID" saving space in the process
+export const DEFAULT_BITS_PER_STATUS = 1 // 1 bit is sufficient for 0x00 - "VALID" 0x01 - "INVALID" saving space in the process
 export const DEFAULT_LIST_LENGTH = 250000
 export const DEFAULT_PROOF_FORMAT = 'jwt' as CredentialProofFormat
 
@@ -32,7 +32,8 @@ export class OAuthStatusListImplementation implements IStatusList {
 
     const proofFormat = args?.proofFormat ?? DEFAULT_PROOF_FORMAT
     const { issuer, id, oauthStatusList, keyRef } = args
-    const { bitsPerStatus, expiresAt } = oauthStatusList
+    const { bitsPerStatus } = oauthStatusList
+    const expiresAt = ensureDate(oauthStatusList.expiresAt)
     const length = args.length ?? DEFAULT_LIST_LENGTH
     const issuerString = typeof issuer === 'string' ? issuer : issuer.id
     const correlationId = getAssertedValue('correlationId', args.correlationId)
@@ -56,7 +57,8 @@ export class OAuthStatusListImplementation implements IStatusList {
   }
 
   async updateStatusListIndex(args: UpdateStatusListIndexArgs, context: IRequiredContext): Promise<StatusListResult> {
-    const { statusListCredential, value, expiresAt, keyRef } = args
+    const { statusListCredential, value, keyRef } = args
+    const expiresAt = ensureDate(args.expiresAt)
     if (typeof statusListCredential !== 'string') {
       return Promise.reject('statusListCredential in neither JWT nor CWT')
     }
@@ -70,6 +72,10 @@ export class OAuthStatusListImplementation implements IStatusList {
       throw new Error('Status list index out of bounds')
     }
 
+    if (typeof value !== 'number') {
+      throw new Error('Status list values should be of type number')
+    }
+
     statusList.setStatus(index, value)
     const { statusListCredential: signedCredential, encodedList } = await this.createSignedStatusList(
       proofFormat,
@@ -102,15 +108,15 @@ export class OAuthStatusListImplementation implements IStatusList {
       throw new Error('OAuthStatusList options are required for type OAuthStatusList')
     }
     const { proofFormat, oauthStatusList, keyRef } = args
-    const { bitsPerStatus, expiresAt } = oauthStatusList
+    const { bitsPerStatus } = oauthStatusList
+    const expiresAt = ensureDate(oauthStatusList.expiresAt)
 
     const { issuer, id } = getAssertedValues(args)
     const issuerString = typeof issuer === 'string' ? issuer : issuer.id
 
     const listToUpdate = StatusList.decompressStatusList(args.encodedList, bitsPerStatus ?? DEFAULT_BITS_PER_STATUS)
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    // FIXME: See above.
-    listToUpdate.setStatus(index, args.value ? 1 : 0)
+    listToUpdate.setStatus(index, args.value)
 
     const { statusListCredential, encodedList } = await this.createSignedStatusList(
       proofFormat ?? DEFAULT_PROOF_FORMAT,
@@ -138,7 +144,7 @@ export class OAuthStatusListImplementation implements IStatusList {
     }
   }
 
-  private buildContentType(proofFormat: 'jwt' | 'lds' | 'EthereumEip712Signature2021' | 'cbor' | undefined) {
+  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
     return `application/statuslist+${proofFormat === 'cbor' ? 'cwt' : 'jwt'}`
   }
 
@@ -153,7 +159,7 @@ export class OAuthStatusListImplementation implements IStatusList {
 
     const index = typeof statusListIndex === 'number' ? statusListIndex : parseInt(statusListIndex)
     if (index < 0 || index >= statusList.statusList.length) {
-      throw new Error('Status list index out of bounds')
+      throw new Error(`Status list index out of bounds, has ${statusList.statusList.length} items, requested ${index}`)
     }
 
     return statusList.getStatus(index)
@@ -184,7 +190,7 @@ export class OAuthStatusListImplementation implements IStatusList {
   }
 
   private async createSignedStatusList(
-    proofFormat: 'jwt' | 'lds' | 'EthereumEip712Signature2021' | 'cbor',
+    proofFormat: CredentialProofFormat,
     context: IAgentContext<ICredentialPlugin & IJwtService & IIdentifierResolution & IKeyManager>,
     statusList: StatusList,
     issuerString: string,

package/src/impl/StatusList2021.ts

@@ -24,7 +24,7 @@ import { Status2021 } from '../types'
 import { assertValidProofType, getAssertedProperty, getAssertedValue, getAssertedValues } from '../utils'
 
 export const DEFAULT_LIST_LENGTH = 250000
-export const DEFAULT_PROOF_FORMAT = 'lds' as VeramoProofFormat
+export const DEFAULT_PROOF_FORMAT = 'lds' as CredentialProofFormat
 
 export class StatusList2021Implementation implements IStatusList {
   async createNewStatusList(
@@ -126,7 +126,7 @@ export class StatusList2021Implementation implements IStatusList {
     const { issuer, id } = getAssertedValues(args)
     const statusList = await StatusList.decode({ encodedList: args.encodedList })
     const index = typeof args.statusListIndex === 'number' ? args.statusListIndex : parseInt(args.statusListIndex)
-    statusList.setStatus(index, args.value)
+    statusList.setStatus(index, args.value !== 0)
 
     const newEncodedList = await statusList.encode()
     const credential = await this.createVerifiableCredential(
@@ -234,7 +234,7 @@ export class StatusList2021Implementation implements IStatusList {
     return CredentialMapper.toWrappedVerifiableCredential(verifiableCredential as StatusListCredential).original as StatusListCredential
   }
 
-  private buildContentType(proofFormat: 'jwt' | 'lds' | 'EthereumEip712Signature2021' | 'cbor' | undefined) {
+  private buildContentType(proofFormat: CredentialProofFormat | undefined) {
     switch (proofFormat) {
       case 'jwt':
         return `application/statuslist+jwt`

package/src/impl/StatusListFactory.ts

@@ -2,6 +2,7 @@ import type { IStatusList } from './IStatusList'
 import { StatusList2021Implementation } from './StatusList2021'
 import { OAuthStatusListImplementation } from './OAuthStatusList'
 import { StatusListType } from '@sphereon/ssi-types'
+import { BitstringStatusListImplementation } from './BitstringStatusListImplementation'
 
 export class StatusListFactory {
   private static instance: StatusListFactory
@@ -11,6 +12,7 @@ export class StatusListFactory {
     this.implementations = new Map()
     this.implementations.set(StatusListType.StatusList2021, new StatusList2021Implementation())
     this.implementations.set(StatusListType.OAuthStatusList, new OAuthStatusListImplementation())
+    this.implementations.set(StatusListType.BitstringStatusList, new BitstringStatusListImplementation())
   }
 
   public static getInstance(): StatusListFactory {

package/src/types/BitstringStatusList.ts

@@ -0,0 +1,4 @@
+import { StatusListCredential } from '@sphereon/ssi-types'
+import { BitstringStatusListCredentialUnsigned } from '../../../../../vc-bitstring-status-lists'
+
+export type BitstringStatusListCredential = BitstringStatusListCredentialUnsigned & StatusListCredential

package/src/types/index.ts

@@ -1,11 +1,11 @@
 import type { IIdentifierResolution } from '@sphereon/ssi-sdk-ext.identifier-resolution'
 import {
+  type CredentialProofFormat,
   type ICredential,
   type ICredentialStatus,
   type IIssuer,
   type IVerifiableCredential,
   type OrPromise,
-  type CredentialProofFormat,
   type StatusListCredential,
   StatusListCredentialIdMode,
   StatusListDriverType,
@@ -26,6 +26,7 @@ import { DataSource } from 'typeorm'
 import type { BitsPerStatus } from '@sd-jwt/jwt-status-list'
 import type { SdJwtVcPayload } from '@sd-jwt/sd-jwt-vc'
 import type { StatusListOpts } from '@sphereon/oid4vci-common'
+import { BitstringStatusPurpose } from '@4sure-tech/vc-bitstring-status-lists'
 
 export enum StatusOAuth {
   Valid = 0,
@@ -38,6 +39,8 @@ export enum Status2021 {
   Invalid = 1,
 }
 
+export type BitstringStatus = number
+
 export type StatusList2021Args = {
   indexingDirection: StatusListIndexingDirection
   statusPurpose?: StatusPurpose2021
@@ -49,6 +52,14 @@ export type OAuthStatusListArgs = {
   expiresAt?: Date
 }
 
+export type BitstringStatusListArgs = {
+  statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
+  ttl?: number
+  validFrom?: Date
+  validUntil?: Date
+}
+
 export type BaseCreateNewStatusListArgs = {
   type: StatusListType
   id: string
@@ -59,6 +70,7 @@ export type BaseCreateNewStatusListArgs = {
   keyRef?: string
   statusList2021?: StatusList2021Args
   oauthStatusList?: OAuthStatusListArgs
+  bitstringStatusList?: BitstringStatusListArgs
   driverType?: StatusListDriverType
 }
 
@@ -71,10 +83,18 @@ export type UpdateOAuthStatusListArgs = {
   expiresAt?: Date
 }
 
+export type UpdateBitstringStatusListArgs = {
+  statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
+}
+
 export interface UpdateStatusListFromEncodedListArgs {
   type?: StatusListType
   statusListIndex: number | string
-  value: boolean
+  value: number
   proofFormat?: CredentialProofFormat
   keyRef?: string
   correlationId?: string
@@ -83,13 +103,14 @@ export interface UpdateStatusListFromEncodedListArgs {
   id: string
   statusList2021?: UpdateStatusList2021Args
   oauthStatusList?: UpdateOAuthStatusListArgs
+  bitstringStatusList?: UpdateBitstringStatusListArgs
 }
 
 export interface UpdateStatusListFromStatusListCredentialArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   keyRef?: string
   statusListIndex: number | string
-  value: number | Status2021 | StatusOAuth
+  value: number | Status2021 | StatusOAuth | BitstringStatus
 }
 
 export interface StatusListResult {
@@ -103,6 +124,7 @@ export interface StatusListResult {
   issuer: string | IIssuer
   statusList2021?: StatusList2021Details
   oauthStatusList?: OAuthStatusDetails
+  bitstringStatusList?: BitstringStatusDetails
 
   // These cannot be deduced from the VC, so they are present when callers pass in these values as params
   correlationId?: string
@@ -120,6 +142,14 @@ interface OAuthStatusDetails {
   expiresAt?: Date
 }
 
+interface BitstringStatusDetails {
+  statusPurpose: BitstringStatusPurpose
+  bitsPerStatus: number
+  validFrom?: Date
+  validUntil?: Date
+  ttl?: number
+}
+
 export interface StatusList2021EntryCredentialStatus extends ICredentialStatus {
   type: 'StatusList2021Entry'
   statusPurpose: StatusPurpose2021
@@ -135,6 +165,16 @@ export interface StatusListOAuthEntryCredentialStatus extends ICredentialStatus
   expiresAt?: Date
 }
 
+export interface BitstringStatusListEntryCredentialStatus extends ICredentialStatus {
+  type: 'BitstringStatusListEntry'
+  statusPurpose: BitstringStatusPurpose | BitstringStatusPurpose[]
+  statusListIndex: string
+  statusListCredential: string
+  bitsPerStatus?: number
+  statusMessage?: Array<BitstringStatus>
+  statusReference?: string | string[]
+}
+
 export interface StatusList2021ToVerifiableCredentialArgs {
   issuer: string | IIssuer
   id: string
@@ -154,12 +194,14 @@ export interface CreateStatusListArgs {
   length?: number
   statusList2021?: StatusList2021Args
   oauthStatusList?: OAuthStatusListArgs
+  bitstringStatusList?: BitstringStatusListArgs
 }
 
 export interface UpdateStatusListIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: number | string
-  value: number | Status2021 | StatusOAuth
+  value: number | Status2021 | StatusOAuth | BitstringStatus
+  bitsPerStatus?: number
   keyRef?: string
   expiresAt?: Date
 }
@@ -167,12 +209,14 @@ export interface UpdateStatusListIndexArgs {
 export interface CheckStatusIndexArgs {
   statusListCredential: StatusListCredential // | CompactJWT
   statusListIndex: string | number
+  bitsPerStatus?: number
 }
 
 export interface ToStatusListDetailsArgs {
   statusListPayload: StatusListCredential
   correlationId?: string
   driverType?: StatusListDriverType
+  bitsPerStatus?: number
 }
 
 /**

package/src/utils.ts

@@ -11,7 +11,7 @@ import { jwtDecode } from 'jwt-decode'
 
 export function getAssertedStatusListType(type?: StatusListType) {
   const assertedType = type ?? StatusListType.StatusList2021
-  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList].includes(assertedType)) {
+  if (![StatusListType.StatusList2021, StatusListType.OAuthStatusList, StatusListType.BitstringStatusList].includes(assertedType)) {
     throw Error(`StatusList type ${assertedType} is not supported (yet)`)
   }
   return assertedType
@@ -39,8 +39,9 @@ export function getAssertedProperty<T extends object>(propertyName: string, obj:
 }
 
 const ValidProofTypeMap = new Map<StatusListType, CredentialProofFormat[]>([
-  [StatusListType.StatusList2021, ['jwt', 'lds', 'EthereumEip712Signature2021']],
+  [StatusListType.StatusList2021, ['jwt', 'lds']],
   [StatusListType.OAuthStatusList, ['jwt', 'cbor']],
+  [StatusListType.BitstringStatusList, ['lds']],
 ])
 
 export function assertValidProofType(type: StatusListType, proofFormat: CredentialProofFormat) {
@@ -93,3 +94,35 @@ export function determineProofFormat(credential: StatusListCredential): Credenti
       throw Error('Cannot determine credential payload type')
   }
 }
+
+/**
+ * Ensures a value is converted to a Date object if it's a valid date string,
+ * otherwise returns the original value or undefined
+ *
+ * @param value - The value to convert to Date (can be Date, string, or undefined)
+ * @returns Date object, undefined, or the original value if conversion fails
+ */
+export function ensureDate(value: Date | string | undefined): Date | undefined {
+  if (value === undefined || value === null) {
+    return undefined
+  }
+
+  if (value instanceof Date) {
+    return value
+  }
+
+  if (typeof value === 'string') {
+    if (value.trim() === '') {
+      return undefined
+    }
+
+    const date = new Date(value)
+    // Check if the date is valid
+    if (isNaN(date.getTime())) {
+      return undefined
+    }
+    return date
+  }
+
+  return undefined
+}