Class: DataIntegrityProof ​
Defined in: data-integrity-proof/index.ts:13
Implements section 2.2.1 DataIntegrityProof of the Data Integrity BIP-340 Cryptosuite spec DataIntegrityProof
Implements ​
Constructors ​
Constructor ​
new DataIntegrityProof(
cryptosuite):DataIntegrityProof
Defined in: data-integrity-proof/index.ts:22
Creates an instance of DataIntegrityProof.
Parameters ​
cryptosuite ​
The cryptosuite to use for proof generation and verification.
Returns ​
DataIntegrityProof
Properties ​
cryptosuite ​
cryptosuite:
Cryptosuite
Defined in: data-integrity-proof/index.ts:15
Implementation of ​
IDataIntegrityProof.cryptosuite
Methods ​
addProof() ​
addProof(
params):Promise<DidUpdateInvocation>
Defined in: data-integrity-proof/index.ts:33
Add a proof to a document.
Parameters ​
params ​
Parameters for adding a proof to a document.
Returns ​
Promise<DidUpdateInvocation>
A document with a proof added.
Implementation of ​
verifyProof() ​
verifyProof(
params):Promise<VerificationResult>
Defined in: data-integrity-proof/index.ts:74
Verify a proof.
Parameters ​
params ​
Parameters for verifying a proof.
document ​
string
The document to verify.
expectedChallenge? ​
string
The expected challenge of the proof.
expectedDomain? ​
string[]
The expected domain of the proof.
expectedPurpose ​
string
The expected purpose of the proof.
mediaType? ​
string
The media type of the document.
Returns ​
Promise<VerificationResult>
The result of verifying the proof.