Interface: DataIntegrityProofObject ​
Defined in: data-integrity-proof/interface.ts:131
A Data Integrity Proof added to a BTCR2 Unsigned Update.
See Verifiable Credential Data Integrity section 2.1 Proofs or BIP340 Cryptosuite section 2.2.1 DataIntegrityProof for more information.
Extends ​
Properties ​
@context ​
@context:
string[]
Defined in: data-integrity-proof/interface.ts:69
JSON-LD context URIs for interpreting this payload, including contexts for ZCAP (capabilities), Data Integrity proofs, and JSON-LD patch ops.
Inherited from ​
capability? ​
optionalcapability:string
Defined in: data-integrity-proof/interface.ts:94
The root capability being invoked, e.g. urn:zcap:root:<urlencoded-did>
Inherited from ​
DataIntegrityConfig.capability
capabilityAction? ​
optionalcapabilityAction:string
Defined in: data-integrity-proof/interface.ts:100
The action performed under the capability—set to "Write" in the spec for DID document updates.
Inherited from ​
DataIntegrityConfig.capabilityAction
challenge? ​
optionalchallenge:string
Defined in: data-integrity-proof/interface.ts:120
Should be included if a domain is included, used once for a particular domain and window of time.
Inherited from ​
created? ​
optionalcreated:string
Defined in: data-integrity-proof/interface.ts:105
The date and time the proof was created
Inherited from ​
cryptosuite ​
cryptosuite:
string
Defined in: data-integrity-proof/interface.ts:89
The cryptographic suite used, e.g. "bip-340-jcs-2025".
Inherited from ​
DataIntegrityConfig.cryptosuite
domain? ​
optionaldomain:string|string[]
Defined in: data-integrity-proof/interface.ts:115
Conveys one or more security domains in which the proof is meant to be used.
Inherited from ​
expires? ​
optionalexpires:string
Defined in: data-integrity-proof/interface.ts:110
The date and time the proof expires
Inherited from ​
proofPurpose ​
proofPurpose:
string
Defined in: data-integrity-proof/interface.ts:79
The purpose of the proof, which the spec sets to "capabilityInvocation".
Inherited from ​
DataIntegrityConfig.proofPurpose
proofValue ​
proofValue:
string
Defined in: data-integrity-proof/interface.ts:137
The cryptographic signature value. The exact property name may be defined by the cryptosuite (for instance, proofValue for a raw signature) and contains the actual signature bytes in an encoded form.
type ​
type:
"DataIntegrityProof"
Defined in: data-integrity-proof/interface.ts:74
The proof type, e.g. "DataIntegrityProof".
Inherited from ​
verificationMethod ​
verificationMethod:
string
Defined in: data-integrity-proof/interface.ts:84
The means and information needed to verify the proof.