submitDeactivateDIDRequest API Reference

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

Function Signature

This function resume the deactivation flow of a Decentralized Identifier (DID) and publish update on the Hedera network using the Client Managed Secret Mode.

The submitDeactivateDIDRequest function is invoked with options and providers.` The providers parameter encapsulates configuration parameters for interacting with the Hedera network, while the options parameter takes current state of the DID deactivation process and the signature of the signing request.

function submitDeactivateDIDRequest(
  options: SubmitDeactivateDIDRequestOptions,
  providers: PublisherProviders,
): Promise<DeactivateDIDResult>;

Parameters

The function accepts the following parameters:

providers: (Required) An object encapsulating configuration parameters for interacting with the Hedera network.
options: (Required) An object specifying configuration options for the DID deactivate request along with the current state of the DID deactivation process and the signature of the signing request.

providers Parameter

The table below details the structure of the providers parameter.

Name Type Description

Name	Type	Description
providers	`PublisherProviders`	An object containing a Hedera Client or a transaction Publisher (refer to PublisherProviders Type for details).

providers

PublisherProviders

An object containing a Hedera Client or a transaction Publisher (refer to PublisherProviders Type for details).

options Parameter

The table below details the structure of the options parameter.

Name Type Description

Name	Type	Description
options	`CommonRegistrarOptions`	An object specifying configuration options for DID deactivation request (refer to SubmitDeactivateDIDRequestOptions Type for details).

options

CommonRegistrarOptions

An object specifying configuration options for DID deactivation request (refer to SubmitDeactivateDIDRequestOptions Type for details).

Return Value

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

The table below describes the structure of the DeactivateDIDResult type.

Name Type Description

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

did

string

The DID string of the deactivated Decentralized Identifier.

didDocument

DIDDocument

The updated DID Document associated with the deactivated DID.

Data Types

This section elaborates on the data types employed within the providers and options parameters.

PublisherProviders 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 PublisherProviders 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.
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.

publisher?

Publisher

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

SubmitDeactivateDIDRequestOptions Type

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

Name Type Description

Name	Type	Description
state	`RunnerState<DIDDeactivateMessage>`	The `state` parameter is a RunnerState object that encapsulates the current state of the DID deactivation process. It is generated by the `generateDeactivateDIDRequest` function.
signature	`Uint8Array`	The `signature` parameter is a Uint8Array containing the signature of the signing request. The signing request is generated by the `generateDeactivateDIDRequest` function.
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.

state

RunnerState<DIDDeactivateMessage>

The state parameter is a RunnerState object that encapsulates the current state of the DID deactivation process. It is generated by the generateDeactivateDIDRequest function.

signature

Uint8Array

The signature parameter is a Uint8Array containing the signature of the signing request. The signing request is generated by the generateDeactivateDIDRequest function.

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.

Errors

The following table enumerates the exceptions that may arise during the execution of the submitDeactivateDIDRequest 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`	Signature and verifier are required for the signature step.
`invalidSignature`	The signature is invalid. Provided signer does not match the DID signer.
`internalError`	Message awaiter timeout reached. Messages not found.
`internalError`	Failed to deactivate the DID.

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

Signature and verifier are required for the signature step.

invalidSignature

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

internalError

Message awaiter timeout reached. Messages not found.

internalError

Failed to deactivate the DID.

Function Implementation

The Hashgraph DID SDK provides a submitDeactivateDIDRequest function within its registrar package. For further details, refer to the @hashgraph-did-sdk-js/registrar package documentation.