DID BTCR2 JS

Appearance

Interface: Proof ​

Defined in: packages/common/src/interfaces.ts:121

Proof is the Data Integrity proof (ZCAP-LD style) added to a did:btcr2 DID Update Payload.

Verifiable Credential Data Integrity 2.1 Proofs.

DID BTCR2 4.3.2 Invoke DID Update Payload.

Extends ​

Properties ​

capability? ​

optional capability: 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).

Inherited from ​

ProofOptions.capability

capabilityAction? ​

optional capabilityAction: 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.

Inherited from ​

ProofOptions.capabilityAction

challenge? ​

optional challenge: string

Defined in: packages/common/src/interfaces.ts:181

Inherited from ​

ProofOptions.challenge

created? ​

optional created: 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.

Inherited from ​

ProofOptions.created

cryptosuite ​

cryptosuite: string

Defined in: packages/common/src/interfaces.ts:149

The cryptographic suite used, e.g. "schnorr-secp256k1-jcs-2025".

Inherited from ​

ProofOptions.cryptosuite

domain? ​

optional domain: string

Defined in: packages/common/src/interfaces.ts:180

Inherited from ​

ProofOptions.domain

proofPurpose ​

proofPurpose: string

Defined in: packages/common/src/interfaces.ts:160

The purpose of the proof, which the spec sets to "capabilityInvocation".

Inherited from ​

ProofOptions.proofPurpose

proofValue ​

proofValue: string

Defined in: packages/common/src/interfaces.ts:127

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: string

Defined in: packages/common/src/interfaces.ts:144

The proof type—per the spec’s example, "DataIntegrityProof".

Inherited from ​

ProofOptions.type

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.

Inherited from ​

ProofOptions.verificationMethod