StaticannounceImplements 4.3.3 Announce DID Update.
The Announce DID Update algorithm retrieves beaconServices from the sourceDocument and calls the Broadcast DID Update algorithm corresponding to the type of the Beacon. It takes in a btc1Identifier, sourceDocument, an array of beaconIds, and a didUpdateInvocation. It returns an array of signalsMetadata, containing the necessary data to validate the Beacon Signal against the didUpdateInvocation.
Required params for calling the announcePayload method
The didUpdatePayload object to be signed
The did-btc1 did document to derive the root capability from
The signalsMetadata object containing data to validate the Beacon Signal
StaticconstructImplements 4.3.1 Construct DID Update Payload.
The Construct DID Update Payload algorithm applies the documentPatch to the sourceDocument and verifies the resulting targetDocument is a conformant DID document. It takes in a btc1Identifier, sourceDocument, sourceVersionId, and documentPatch objects. It returns an unsigned DID Update Payload.
See ConstructPayloadParams for more details.
The did-btc1 identifier to derive the root capability from.
The JSON patch to be applied to the source document.
The source document to be updated.
The versionId of the source document.
The constructed DidUpdatePayload object.
InvalidDid if sourceDocument.id does not match identifier.
Staticinvoke4.3.2 Invoke DID Update Payload.
The Invoke DID Update Payload algorithm takes in a btc1Identifier, an unsigned didUpdatePayload, and a verificationMethod. It retrieves the privateKeyBytes for the verificationMethod and adds a capability invocation in the form of a Data Integrity proof following the Authorization Capabilities (ZCAP-LD) and VC Data Integrity specifications. It returns the invoked DID Update Payload.
Required params for calling the invokePayload method
The updatePayload object to be signed
The did-btc1 identifier to derive the root capability from
The verificationMethod object to be used for signing
Did update payload secured with a proof => DidUpdateInvocation
Implements 4.3 Update.
An update to a did:btc1 document is an invoked capability using the ZCAP-LD data format, signed by a verificationMethod that has the authority to make the update as specified in the previous DID document. Capability invocations for updates MUST be authorized using Data Integrity following the bip340-jcs-2025 cryptosuite with a proofPurpose of capabilityInvocation.
Btc1Update