Type alias DidDereferencingResult

Type declaration

• contentMetadata: DidDocumentMetadata

  If the dereferencing is successful, this MUST be a metadata structure, but the structure MAY be empty. This structure contains metadata about the contentStream. If the contentStream is a DID document, this MUST be a didDocumentMetadata structure as described in DID Resolution. If the dereferencing is unsuccessful, this output MUST be an empty metadata structure.

• contentStream: DidResource | null

  If the dereferencing function was called and successful, this MUST contain a resource corresponding to the DID URL. The contentStream MAY be a resource such as:

  • a DID document that is serializable in one of the conformant representations
  • a Verification Method
  • a service.
  • any other resource format that can be identified via a Media Type and obtained through the resolution process.

  If the dereferencing is unsuccessful, this value MUST be empty.

• dereferencingMetadata: DidDereferencingMetadata

  A metadata structure consisting of values relating to the results of the DID URL dereferencing process. This structure is REQUIRED, and in the case of an error in the dereferencing process, this MUST NOT be empty. Properties defined by this specification are in 7.2.2 DID URL Dereferencing Metadata. If the dereferencing is not successful, this structure MUST contain an error property describing the error.