generateCreateDIDRequest API Reference

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

Function Signature

This function generates a request to create a new Decentralized Identifier (DID) on the Hedera network using the Client Managed Secret Mode.

The generateCreateDIDRequest function is invoked with providers and options parameters. The providers parameter encapsulates configuration parameters for interacting with the Hedera network, while the options parameter enables customization of the DID creation procedure and passing required public key.

function generateCreateDIDRequest(
  options: GenerateCreateDIDRequestOptions,
  providers: PublisherProviders,
): Promise<CreateDIDRequest>;

Parameters

The function accepts the following parameters:

providers: (Required) An object encapsulating configuration parameters for interacting with the Hedera network.
options: (Required) DID creation request options.

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
didDocumentFields	`GenerateCreateDIDRequestOptions`	Initial DID document fields used to construct the create operation payload.
topicId?	`string`	Existing topic id to use. If omitted, a new topic is created.
verificationMethod?	`string`	Verification method id used for signing-request generation. If omitted, defaults to `#did-root-key`.
topicReader?	`TopicReader`	Optional topic reader used by the flow.

didDocumentFields

GenerateCreateDIDRequestOptions

Initial DID document fields used to construct the create operation payload.

topicId?

string

Existing topic id to use. If omitted, a new topic is created.

verificationMethod?

string

Verification method id used for signing-request generation. If omitted, defaults to #did-root-key.

topicReader?

TopicReader

Optional topic reader used by the flow.

Return Value

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

The table below describes the structure of the CreateDIDRequest type.

Name Type Description

Name	Type	Description
state	`OperationState`	Serialized state used by `submitCreateDIDRequest`.
signingRequest	`ProofSigningRequest<string[]>`	Proof signing request to be signed client-side.

state

OperationState

Serialized state used by submitCreateDIDRequest.

signingRequest

ProofSigningRequest<string[]>

Proof signing request to be signed client-side.

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.

Errors

The following table enumerates the exceptions that may arise during the execution of the generateCreateDIDRequest 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.
`invalidDid`	Controller is not a valid Hedera DID.
`internalError`	DID already exists on the network.
`internalError`	Failed to create topic.

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.

invalidDid

Controller is not a valid Hedera DID.

internalError

DID already exists on the network.

internalError

Failed to create topic.

Function Implementation

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