Interface CreateSecretPayload

interface CreateSecretPayload {
    dataIntegrityProof: {
        publicKey?: string;
        signature: string;
        signer: string;
    };
    description: string;
    image: string;
    messageFormat: "plaintext" | "json";
    name: string;
    proofOfIssuance: {
        message: string;
        publicKey?: string;
        signature: string;
        signer: string;
    };
    scheme: "bbs" | "standard";
    secretMessages: string[];
    type: string;
}

Properties

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.

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.

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