Class Cryptosuite

Implements 3.1 Instantiate Cryptosuite

The Instantiate Cryptosuite algorithm is used to configure a cryptographic suite to be used by the Add Proof and Verify Proof functions in Verifiable Credential Data Integrity 1.0. The algorithm takes an options object (map options) as input and returns a cryptosuite instance (struct cryptosuite).

Initialize cryptosuite to an empty struct.
If options.type does not equal DataIntegrityProof, return cryptosuite.
If options.cryptosuite is bip340-rdfc-2025: 3.1) Set cryptosuite.createProof to the algorithm in Section 3.2.1 Create Proof (bip340-rdfc-2025). 3.2) Set cryptosuite.verifyProof to the algorithm in Section 3.2.2 Verify Proof (bip340-rdfc-2025).
If options.cryptosuite is bip340-jcs-2025: 4.2) Set cryptosuite.createProof to the algorithm in Section 3.3.1 Create Proof (bip340-jcs-2025). 4.3) Set cryptosuite.verifyProof to the algorithm in Section 3.3.2 Verify Proof (bip340-jcs-2025).
Return cryptosuite.

Cryptosuite

Implements

ICryptosuite

Index

Constructors

constructor

new Cryptosuite(params: CryptosuiteParams): Cryptosuite
Constructs an instance of Cryptosuite.
Parameters
- params: CryptosuiteParams
  See CryptosuiteParams for required parameters to create a cryptosuite.
  - cryptosuite: "bip340-jcs-2025" | "bip340-rdfc-2025"
  - multikey: SchnorrMultikey
  - Optionaltype?: "DataIntegrityProof"
Returns Cryptosuite
- Defined in cryptosuite/index.ts:84

Properties

algorithm

algorithm: "rdfc" | "jcs"

The algorithm used for canonicalization

cryptosuite

cryptosuite: "bip340-jcs-2025" | "bip340-rdfc-2025"

The name of the cryptosuite

multikey

multikey: SchnorrMultikey

The multikey used to sign and verify proofs

type

type: "DataIntegrityProof" = 'DataIntegrityProof'

The type of the proof

Methods

createProof

createProof(params: CreateProofParams): Promise<Proof>
Create a proof for an insecure document.
Parameters
- params: CreateProofParams
  See CreateProofParams for details.
  - document: DidUpdatePayload
  - options: ProofOptions
Returns Promise<Proof>
The proof for the document.
Implementation of ICryptosuite.createProof
- Defined in cryptosuite/index.ts:112

generateHash

generateHash(params: GenerateHashParams): Bytes
Generate a hash of the canonical proof configuration and document.
Parameters
- params: GenerateHashParams
  See GenerateHashParams for details.
  - canonicalConfig: string
  - canonicalDocument: string
Returns Bytes
The hash string of the proof configuration and document.
Implementation of ICryptosuite.generateHash
- Defined in cryptosuite/index.ts:223

proofConfiguration

proofConfiguration(options: ProofOptions): Promise<string>
Configure the proof by canonicalzing it.
Parameters
- options: ProofOptions
  The options to use when transforming the proof.
Returns Promise<string>
The canonicalized proof configuration.

Throws
if the proof configuration cannot be canonicalized.
Implementation of ICryptosuite.proofConfiguration
- Defined in cryptosuite/index.ts:243

proofSerialization

proofSerialization(params: ProofSerializationParams): Bytes
Serialize the proof into a byte array.
Parameters
- params: ProofSerializationParams
  See ProofSerializationParams for details.
  - hash: Bytes
  - options: ProofOptions
Returns Bytes
The serialized proof.

Throws
if the multikey does not match the verification method.
Implementation of ICryptosuite.proofSerialization
- Defined in cryptosuite/index.ts:274

proofVerification

proofVerification(params: ProofVerificationParams): boolean
Verify the proof by comparing the hash of the proof configuration and document to the proof bytes.
Parameters
- params: ProofVerificationParams
  See ProofVerificationParams for details.
  - hash: Bytes
  - options: ProofOptions
  - signature: Bytes
Returns boolean
True if the proof is verified, false otherwise.

Throws
if the multikey does not match the verification method.
Implementation of ICryptosuite.proofVerification
- Defined in cryptosuite/index.ts:296

toDataIntegrityProof

toDataIntegrityProof(): DataIntegrityProof
Constructs an instance of DataIntegrityProof from the current Cryptosuite instance.

Returns DataIntegrityProof
A new DataIntegrityProof instance.
- Defined in cryptosuite/index.ts:97

transformDocument

transformDocument(params: TransformDocumentParams): Promise<string>
Transform a document (secure didUpdateInvocation or insecure didUpdatePayload) into canonical form.
Parameters
- params: TransformDocumentParams
  See TransformDocumentParams for details.
  - document: DidUpdatePayload | DidUpdateInvocation
  - options: ProofOptions
Returns Promise<string>
The canonicalized document.

Throws
if the document cannot be transformed.
Implementation of ICryptosuite.transformDocument
- Defined in cryptosuite/index.ts:189

verifyProof

verifyProof(document: DidUpdateInvocation): Promise<VerificationResult>
Verify a proof for a secure document. Implements ICryptosuite Method verifyProof.
Parameters
- document: DidUpdateInvocation
  The secure document to verify.
Returns Promise<VerificationResult>
The result of the verification.
Implementation of ICryptosuite.verifyProof
- Defined in cryptosuite/index.ts:155

Class Cryptosuite

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

cryptosuite: "bip340-jcs-2025" | "bip340-rdfc-2025"

multikey: SchnorrMultikey

Optionaltype?: "DataIntegrityProof"

Returns Cryptosuite

Properties

algorithm

cryptosuite

multikey

type

Methods

createProof

Parameters

document: DidUpdatePayload

options: ProofOptions

Returns Promise<Proof>

generateHash

Parameters

canonicalConfig: string

canonicalDocument: string

Returns Bytes

proofConfiguration

Parameters

Returns Promise<string>

Throws

proofSerialization

Parameters

hash: Bytes

options: ProofOptions

Returns Bytes

Throws

proofVerification

Parameters

hash: Bytes

options: ProofOptions

signature: Bytes

Returns boolean

Throws

toDataIntegrityProof

Returns DataIntegrityProof

transformDocument

Parameters

document: DidUpdatePayload | DidUpdateInvocation

options: ProofOptions

Returns Promise<string>

Throws

verifyProof

Parameters

Returns Promise<VerificationResult>

Settings

On This Page

`Optional`type?: "DataIntegrityProof"