TypeScript
interface VerificationOptions {
  revocationRegistryAddress?: ethers.AddressLike;
  provider?: ethers.Provider;
  didRegistryAddress?: ethers.AddressLike;
  mandatoryPointers?: string\[];
}

Parameters

  • revocationRegistryAddress (ethers.AddressLike, optional): The blockchain address of the smart contract that handles the revocation of credentials. This needs to be provided when dealing with credential revocation.

  • provider (ethers.Provider, optional): The blockchain provider for sending the blockhain transactions.

  • didRegistryAddress (ethers.AddressLike, optional): The address of the smart contract that manages decentralized identifiers (DIDs) on the blockchain. The contract contains the name of issuer organisation and ethereum address of issuer organisation

  • mandatoryPointers (string[], optional): A list of JSON Pointers that specify required fields within a JSON document. These pointers are used to locate specific data within the JSON structure of a Verifiable Credential and that are always included into the Verifiable Presentation. Currently, arrays within the specification of mandatoryPointers are not supported, focusing solely on straightforward JSON object navigation.

    Examples: [“/issuer”, “/credentialSubject/id”, “/type”],

    The syntaxis is based on the w3c draft specification of BBS cryptosuite Data Integrity BBS Cryptosuites v1.0 which itself is based on RFC 6901

  • debug (boolean, optional): A flag that, when set to true, enables additional logging for debugging purposes during the execution of operations.