The @zcloak/verify module outlines some functions for the swift and convenient verification of Verifiable Credentials and Presentations.

Integration steps

1. Installation: yarn add @zcloak/verify
2. Import the necessary classes and functions.

import { vcVerify, vpVerify } from '@zcloak/verify';

Key Classes and Functions

Verifying Credential Type

The method:

ctypeVerify(params)

export function ctypeVerify(
ctype: CType, document?: DidDocument | DidResolver): Promise<boolean> {
  //......
}

• Description: Verifies the validity of a CType. It verifies the signature of the CType by checking if the signature is valid for the publisher. The function returns true if the verification is successful and false otherwise.
• Params:
  • ctype - The CType object to be verified.
  • document(optional) - The optional DidDocument or DidResolver to resolve the publisher's DID.
• Return: boolean - Returns true if the verification is successful, indicating that the signature of the CType is valid. Returns false otherwise.

Verifying DID

The method:

didVerify(params)

export async function didVerify(
  message: HexString | Uint8Array,
  signature: HexString | Uint8Array,
  signatureType: SignatureType,
  didUrl: DidUrl,
  resolverOrDidDocument?: DidDocument | DidResolver
): Promise<boolean> {
  //......
}

• Description: Verifies the signature on a given message using a DID (Decentralized Identifier) and the corresponding public key associated with the DID. It supports multiple signature types, such as secp256k1 and Ed25519. The function allows for resolving the DID using a resolver or directly providing a DID document. It returns true if the signature is valid and false otherwise.