updateDID API Reference

This document provides a concise API reference for the updateDID function within the Hedera DID SDK for JavaScript.

Function Signature

The updateDID function allows you to update an existing DID document by providing the DID and an object specifying the desired modifications.

function updateDID(
  options: UpdateDIDOptions,
  providers: Providers
): Promise<UpdateDIDResult>;

Parameters

The function accepts the following parameters:

providers: (Required) An object encapsulating configuration parameters for interacting with the Hedera network.
options: (Required) An object containing the DID and updatedDidDocument.

providers Parameter

The table below details the structure of the providers parameter.

Name Type Description

Name	Type	Description
providers	`Providers`	An object containing a Hedera Client, a cryptographic Signer, and a transaction Publisher (refer to Providers Type for details).

providers

Providers

An object containing a Hedera Client, a cryptographic Signer, and a transaction Publisher (refer to Providers Type for details).

options Parameter

The table below details the structure of the options parameter.

Name Type Description

Name	Type	Description
did	`string`	The DID string of the Decentralized Identifier to update.
updatedDidDocument	`JsonLdDIDDocument`	The full updated DID document to be published as the next DID state.
privateKey?	`string` \| PrivateKey`	A private key (in DER format) or a `PrivateKey` object used to generate a Signer for signing the DID update message.
waitForDIDVisibility?	`boolean`	Whether to wait for the DID to be visible on the network. The DID registration transaction may be confirmed before the DID is actually accessible and usable on the network. This option ensures that the function waits until the DID is fully propagated and discoverable. If set to `false`, the function will return as soon as the registration transaction is confirmed, which may be faster but could lead to errors if you immediately try to use the DID. Defaults to `true`.
visibilityTimeoutMs?	`number`	The maximum time (in milliseconds) to wait for the DID to be visible on the network. This option is only relevant if `waitForDIDVisibility` is set to `true`. If the DID is not visible within this timeout period, the function will throw an error. Defaults to 120000 milliseconds (2 minutes).
topicReader?	`TopicReader`	An instance of a TopicReader responsible for reading messages from the Hedera network topic.

did

string

The DID string of the Decentralized Identifier to update.

updatedDidDocument

JsonLdDIDDocument

The full updated DID document to be published as the next DID state.

privateKey?

string | PrivateKey`

A private key (in DER format) or a PrivateKey object used to generate a Signer for signing the DID update message.

waitForDIDVisibility?

boolean

Whether to wait for the DID to be visible on the network. The DID registration transaction may be confirmed before the DID is actually accessible and usable on the network. This option ensures that the function waits until the DID is fully propagated and discoverable. If set to false, the function will return as soon as the registration transaction is confirmed, which may be faster but could lead to errors if you immediately try to use the DID.

Defaults to true.

visibilityTimeoutMs?

number

The maximum time (in milliseconds) to wait for the DID to be visible on the network. This option is only relevant if waitForDIDVisibility is set to true. If the DID is not visible within this timeout period, the function will throw an error. Defaults to 120000 milliseconds (2 minutes).

topicReader?

TopicReader

An instance of a TopicReader responsible for reading messages from the Hedera network topic.

Data Types

This section elaborates on the data types employed within the providers parameter.

Providers Type

To utilize this type, at least one of the following must be defined: client or publisher. If both are provided, publisher takes precedence.

The table below provides a detailed description of the Providers type.

Name Type Description

Name	Type	Description
clientOptions?	`ClientOptions`	Configuration options for instantiating a Hedera Client. See a full running example in the source code.
client?	`Client`	An instance of a Hedera Client. See a full running example in the source code.
signer?	`Signer`	An instance of a Signer. If not provided, a private key must be specified in the `options` parameter to sign the DID creation message; otherwise, an exception will be thrown.
publisher?	`Publisher`	An instance of a Publisher responsible for submitting the DID creation transaction to the Hedera network.

clientOptions?

ClientOptions

Configuration options for instantiating a Hedera Client. See a full running example in the source code.

client?

Client

An instance of a Hedera Client. See a full running example in the source code.

signer?

Signer

An instance of a Signer. If not provided, a private key must be specified in the options parameter to sign the DID creation message; otherwise, an exception will be thrown.

publisher?

Publisher

An instance of a Publisher responsible for submitting the DID creation transaction to the Hedera network.

Return Value

Upon successful execution, the function returns a Promise that resolves to a UpdateDIDResult object.

Name Type Description

Name	Type	Description
did	`string`	The updated DID string of the Decentralized Identifier.
didDocument	`DIDDocument`	The updated DID Document associated with the Decentralized Identifier.

did

string

The updated DID string of the Decentralized Identifier.

didDocument

DIDDocument

The updated DID Document associated with the Decentralized Identifier.

Errors

The following table enumerates the exceptions that may arise during the execution of the updateDID function.

Exception code Description

Exception code	Description
`invalidArgument`	Providers must contain client options or client or publisher.
`invalidArgument`	Hashgraph SDK Client must be configured with a network.
`invalidArgument`	Hashgraph SDK Client must be configured with an operator account.
`invalidArgument`	Signer or private key is required to perform the operation.
`invalidArgument`	Signer or private key is required to perform the operation.
`invalidDid`	The DID must be a valid Hedera DID.
`notFound`	The DID document was not found.
`invalidProof`	The proof is invalid. Provided proof does not match the DID signer.
`internalError`	Message awaiter timeout reached. Messages not found.

invalidArgument

Providers must contain client options or client or publisher.

invalidArgument

Hashgraph SDK Client must be configured with a network.

invalidArgument

Hashgraph SDK Client must be configured with an operator account.

invalidArgument

Signer or private key is required to perform the operation.

invalidArgument

Signer or private key is required to perform the operation.

invalidDid

The DID must be a valid Hedera DID.

notFound

The DID document was not found.

invalidProof

The proof is invalid. Provided proof does not match the DID signer.

internalError

Message awaiter timeout reached. Messages not found.

Function Implementation

The Hashgraph DID SDK provides updateDID within @swiss-digital-assets-institute/registrar.