@the-hashgraph-group-ag/cryptosuites-core

@the-hashgraph-group-ag/cryptosuites-core / ProofCreator

Abstract Class: ProofCreator<ProofAlgorithms>

Defined in: packages/core/src/interfaces/proof-creator.ts:10

Abstract class for a proof creator.

Type Parameters

ProofAlgorithms

ProofAlgorithms extends string[]

The algorithms supported by the proof creator.

Constructors

Constructor

new ProofCreator<ProofAlgorithms>(): ProofCreator<ProofAlgorithms>

Returns

ProofCreator<ProofAlgorithms>

Methods

attachSignature()

abstract attachSignature<Input>(inputDocument, proofConfig, proofBytes): link:../type-aliases/SecuredDataDocument.md<Input> | Promise<link:../type-aliases/SecuredDataDocument.md<Input>>

Defined in: packages/core/src/interfaces/proof-creator.ts:38

Attaches a signature to the input document.

Type Parameters

======= Input

Input extends InputDocument

Parameters

======= inputDocument

Input

The input document to attach the signature to.

======= proofConfig

ProofConfig

The proof configuration.

======= proofBytes

Uint8Array

The bytes of the signature.

Returns

link:../type-aliases/SecuredDataDocument.md<Input> | Promise<link:../type-aliases/SecuredDataDocument.md<Input>>

The input document with the attached signature.

canSign()

abstract canSign(proofType): boolean

Defined in: packages/core/src/interfaces/proof-creator.ts:16

Checks if the proof creator can sign with the given proof type.

Parameters

======= proofType

string

The proof type to check.

Returns

boolean

True if the proof creator can sign the given proof type, false otherwise.

constructProof()

abstract constructProof(proofConfig, proofBytes): Proof | Promise<link:../interfaces/Proof.md>

Defined in: packages/core/src/interfaces/proof-creator.ts:50

Constructs a proof from a signing request and a signature.

Parameters

======= proofConfig

ProofConfig

The proof configuration.

======= proofBytes

Uint8Array

The bytes of the signature.

Returns

Proof | Promise<link:../interfaces/Proof.md>

The proof.

createSigningRequest()

abstract createSigningRequest<Input>(inputDocument, proofOptions): link:../interfaces/ProofSigningRequest.md<ProofAlgorithms> | Promise<link:../interfaces/ProofSigningRequest.md<ProofAlgorithms>>

Defined in: packages/core/src/interfaces/proof-creator.ts:24

Creates a signing request for the input document to create a proof.

Type Parameters

======= Input

Input extends InputDocument

Parameters

======= inputDocument

Input

The input document to create a proof for.

======= proofOptions

ProofOptions

The options for the proof.

Returns

link:../interfaces/ProofSigningRequest.md<ProofAlgorithms> | Promise<link:../interfaces/ProofSigningRequest.md<ProofAlgorithms>>

A signing request for the input document.