Interface DidIonCreateRequest

Represents the request model for managing DID documents within the ION network, according to the Sidetree protocol specification.

interface DidIonCreateRequest {
    delta: {
        patches: {
            action: string;
            document: default;
        }[];
        updateCommitment: string;
    };
    suffixData: {
        deltaHash: string;
        recoveryCommitment: string;
    };
    type: "create";
}

Properties

delta suffixData type

Properties

delta

delta: {
    patches: {
        action: string;
        document: default;
    }[];
    updateCommitment: string;
}

Details the changes to be applied to the DID document in this operation.

Type declaration

  • patches: {
        action: string;
        document: default;
    }[]

    An array of patch objects specifying the modifications to apply to the DID document.

  • updateCommitment: string

    A commitment value used for the next update operation, hashed for security.

suffixData

suffixData: {
    deltaHash: string;
    recoveryCommitment: string;
}

Contains properties related to the initial state of the DID document.

Type declaration

  • deltaHash: string

    A hash of the delta object, representing the initial changes to the DID document.

  • recoveryCommitment: string

    A commitment value used for future recovery operations, hashed for security.

type

type: "create"

The type of operation to perform, which is always 'create' for a Create Operation.

Settings

Member Visibility

Theme

On This Page

deltasuffixDatatype