@did-btc1/common
    Preparing search index...

    Interface ProofOptions

    Proof Options used when adding a Data Integrity proof (ZCAP-LD style) to a did:btc1 DID Update Payload.

    Verifiable Credential Data Integrity 2.1 Proofs.

    DID BTC1 4.3.2 Invoke DID Update Payload.

    interface ProofOptions {
        capability?: string;
        capabilityAction?: string;
        challenge?: string;
        created?: string;
        cryptosuite: string;
        domain?: string;
        proofPurpose: string;
        type: string;
        verificationMethod: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    capability? capabilityAction? challenge? created? cryptosuite domain? proofPurpose type verificationMethod

    Properties

    capability?: string

    The root capability being invoked. In did:btc1, this is typically urn:zcap:root:<urlencoded-did> (see Section 9.4.1).

    capabilityAction?: string

    The action performed under the capability—set to "Write" in the spec for DID document updates.

    challenge?: string
    created?: string

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

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

    domain?: string
    proofPurpose: string

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

    type: string

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

    verificationMethod: string

    DID URL of the key invoking the capability, i.e. the DID Document's verificationMethod.id used to sign this update.

    Settings

    Member Visibility

    On This Page

    Properties