Class SecretDoc<T>

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_docId: string

A unique stringified document ID

_id?: string

A unique document ID (Mongo DB ObjectID)

anchors: {
    message?: string;
    txHash?: string;
}[]

Anchors are on-chain transactions used to prove certain things about the secret. For example, you can anchor the secret to a transaction hash to prove that the secret existed at a certain time.

Type declaration

  • Optional message?: string
  • Optional txHash?: string
createdBy: string

The address of the user who created the secret.

dataIntegrityProof: {
    publicKey?: string;
    signature: string;
    signer: string;
}

This is the signature and accompanying details of the secretMessages. The siganture maintains the integrity of the secretMessages.

This should match the expected scheme. For example, if the scheme is BBS+, the signature should be a BBS+ signature and signer should be a BBS+ public key.

Type declaration

  • Optional publicKey?: string
  • signature: string
  • signer: string
description: string

Metadata for the secret for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.

holders: string[]

Holders are the addresses that have been given the secret.

image: string

Metadata for the secret for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.

messageFormat: "plaintext" | "json"

The message format of the secretMessages.

name: string

Metadata for the secret for display purposes. Note this should not contain anything sensitive. It may be displayed to verifiers.

proofOfIssuance: {
    message: string;
    publicKey?: string;
    signature: string;
    signer: string;
}

Proof of issuance is used for BBS+ signatures (scheme = bbs) only. BBS+ signatures are signed with a BBS+ key pair, but you would often want the issuer to be a native address. The prooofOfIssuance establishes a link saying that "I am the issuer of this secret signed with BBS+ key pair ___".

Fields can be left blank for standard signatures.

Type declaration

  • message: string
  • Optional publicKey?: string
  • signature: string
  • signer: string
scheme: "bbs" | "standard"

The scheme of the secret. BBS+ signatures are supported and can be used where selective disclosure is a requirement. Otherwise, you can simply use your native blockchain's signature scheme.

secretId: string

The secret ID. This is the ID that is given to the user to query the secret. Anyone with the ID can query it, so keep this safe and secure.

secretMessages: string[]

Thesse are the secrets that are signed. For BBS+ signatures, there can be >1 secretMessages, and the signer can selectively disclose the secrets. For standard signatures, there is only 1 secretMessage.

type: string

The type of the secret (e.g. credential).

updateHistory: UpdateHistory<T>[]

Methods

  • Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

    If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

    Type Parameters

    Parameters

    • other: undefined | null | CustomType<U>
    • Optional normalizeNumberTypes: boolean

    Returns boolean