DID BTCR2 JS

Appearance

Interface: DidUpdateInvocation ​

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

An extension of DID Update Payload containing a Data Integrity proof that authorizes the update. Once signed, the spec calls this an 'invoked DID Update Payload' or 'didUpdateInvocation'.

DID BTCR2 4.3.2 Invoke DID Update Payload and 9.4 Root did:btcr2 Update Capabilities.

Extends ​

Properties ​

@context ​

@context: string[]

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

JSON-LD context URIs for interpreting this payload, including contexts for ZCAP (capabilities), Data Integrity proofs, and JSON-LD patch ops.

Inherited from ​

DidUpdatePayload.@context

patch ​

patch: JsonPatch

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

A JSON Patch (or JSON-LD Patch) object defining the mutations to apply to the DID Document. Applying this patch to the current DID Document yields the new DID Document (which must remain valid per DID Core spec).

Inherited from ​

DidUpdatePayload.patch

proof ​

proof: Proof

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

A proof object (Data Integrity proof) that authorizes this update. It is a JSON-LD proof indicating a capability invocation on the DID's root capability, typically signed with the DID's verification key (using Schnorr secp256k1 in did:btcr2).

Overrides ​

DidUpdatePayload.proof

sourceHash ​

sourceHash: string

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

The multihash of the current (source) DID Document, encoded as a multibase base58-btc string. This is a SHA-256 hash of the canonicalized source DID Document, used to ensure the patch is applied to the correct document state.

Inherited from ​

DidUpdatePayload.sourceHash

targetHash ​

targetHash: string

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

The multihash of the updated (target) DID Document, encoded as multibase base58-btc. This is the SHA-256 hash of the canonicalized DID Document after applying the patch, used to verify the update result.

Inherited from ​

DidUpdatePayload.targetHash

targetVersionId ​

targetVersionId: number

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

The version number of the DID Document after this update. It is equal to the previous document version + 1.

Inherited from ​

DidUpdatePayload.targetVersionId