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

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

Abstract Class: Signer<Cryptosuite, Algorithms>

Defined in: packages/core/src/interfaces/signer.ts:10

An abstract class that represents a signer. It is used to sign input documents with a given cryptosuites.

Type Parameters

Cryptosuite

Cryptosuite extends link:ProofCreator.md<Algorithms>

Algorithms

Algorithms extends string[]

Constructors

Constructor

new Signer<Cryptosuite, Algorithms>(): Signer<Cryptosuite, Algorithms>

Returns

Signer<Cryptosuite, Algorithms>

Methods

canSign()

abstract canSign(proofType): boolean

Defined in: packages/core/src/interfaces/signer.ts:19

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

Parameters

======= proofType

string

The proof type to check.

Returns

boolean

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

sign()

abstract sign<InputDocument, ProofOptions>(inputDocument, proofOptions): link:../type-aliases/SecuredDataDocument.md<InputDocument> | Promise<link:../type-aliases/SecuredDataDocument.md<InputDocument>>

Defined in: packages/core/src/interfaces/signer.ts:29

Signs an input document with a cryptosuite.

Type Parameters

======= InputDocument

InputDocument extends InputDocument

======= ProofOptions

ProofOptions extends ProofOptions

Parameters

======= inputDocument

InputDocument

The input document to sign.

======= proofOptions

ProofOptions

The proof options.

Returns

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

The secured data document.

signSigningRequest()

abstract signSigningRequest<SigningRequest>(signingRequest): Proof | Promise<link:../interfaces/Proof.md>

Defined in: packages/core/src/interfaces/signer.ts:45

Signs a signing request with a cryptosuite.

Type Parameters

======= SigningRequest

SigningRequest extends link:../interfaces/ProofSigningRequest.md<Algorithms>

Parameters

======= signingRequest

SigningRequest

The signing request to sign.

Returns

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

The proof.