Interface: ProofOptions ​
Defined in: packages/common/src/interfaces.ts:140
Proof Options used when adding a Data Integrity proof (ZCAP-LD style) to a did:btcr2 DID Update Payload.
Verifiable Credential Data Integrity 2.1 Proofs.
DID BTCR2 4.3.2 Invoke DID Update Payload.
Extended by ​
Properties ​
capability? ​
optionalcapability:string
Defined in: packages/common/src/interfaces.ts:166
The root capability being invoked. In did:btcr2, this is typically urn:zcap:root:<urlencoded-did> (see Section 9.4.1).
capabilityAction? ​
optionalcapabilityAction:string
Defined in: packages/common/src/interfaces.ts:172
The action performed under the capability—set to "Write" in the spec for DID document updates.
challenge? ​
optionalchallenge:string
Defined in: packages/common/src/interfaces.ts:181
created? ​
optionalcreated:string
Defined in: packages/common/src/interfaces.ts:179
(Optional) Some cryptosuites or proofs may include a timestamp, domain, or challenge. Although not explicitly required in the doc's steps, they often appear in Data Integrity proofs and may be included as needed.
cryptosuite ​
cryptosuite:
string
Defined in: packages/common/src/interfaces.ts:149
The cryptographic suite used, e.g. "schnorr-secp256k1-jcs-2025".
domain? ​
optionaldomain:string
Defined in: packages/common/src/interfaces.ts:180
proofPurpose ​
proofPurpose:
string
Defined in: packages/common/src/interfaces.ts:160
The purpose of the proof, which the spec sets to "capabilityInvocation".
type ​
type:
string
Defined in: packages/common/src/interfaces.ts:144
The proof type—per the spec’s example, "DataIntegrityProof".
verificationMethod ​
verificationMethod:
string
Defined in: packages/common/src/interfaces.ts:155
DID URL of the key invoking the capability, i.e. the DID Document's verificationMethod.id used to sign this update.