Class ExternalKeyPair

Abstract interface to all kinds of key-related functions

Hierarchy (View Summary)

KeyInterface
- ExternalKeyPair

Index

Constructors

Properties

driverHandlesHashing derivePrivateKeyFromSeed? fromSeed? isInstance

Accessors

hasPrivateKey keyType publicKey supportsEncryption

Methods

_checkPrivateKey decrypt encrypt sign verify

Constructors

constructor

new ExternalKeyPair(
    functions: ExternalKeyPairFunctions,
    publicKey: string | ArrayBuffer,
    keyType: AccountKeyAlgorithm,
    driverHandlesHashing?: boolean,
): ExternalKeyPair
Parameters
- functions: ExternalKeyPairFunctions
- publicKey: string | ArrayBuffer
- keyType: AccountKeyAlgorithm
- driverHandlesHashing: boolean = false
Returns ExternalKeyPair
Overrides KeyInterface.constructor

Properties

`Readonly`driverHandlesHashing

driverHandlesHashing: boolean

`Static` `Optional`derivePrivateKeyFromSeed

derivePrivateKeyFromSeed?: seedDerivationFunction

Create a private key generated from a seed value and an index

`Static` `Optional`fromSeed

fromSeed?: fromSeedFunctionType

Create a new instance with a private key generated from a seed value and index

`Static`isInstance

isInstance: (obj: any, strict?: boolean) => obj is ExternalKeyPair = ...

Accessors

hasPrivateKey

get hasPrivateKey(): boolean
Determine if this key pair has a private key associated

Returns boolean
Overrides KeyInterface.hasPrivateKey

keyType

get keyType(): AccountKeyAlgorithm
Get the type of key in use (ECDSA or ED25519) for this key pair

Returns AccountKeyAlgorithm
Overrides KeyInterface.keyType

publicKey

get publicKey(): | ECDSASECP256K1PublicKey
| ECDSASECP256R1PublicKey
| ED25519PublicKey
Get the public key for this key pair

Returns ECDSASECP256K1PublicKey | ECDSASECP256R1PublicKey | ED25519PublicKey
Overrides KeyInterface.publicKey

supportsEncryption

get supportsEncryption(): boolean
Determine if the key supports encryption/decryption

Returns boolean
Overrides KeyInterface.supportsEncryption

Methods

_checkPrivateKey

_checkPrivateKey(_ignore_checkKey: ArrayBuffer): undefined
Testing interface to validate that a private key is equal to some value (undefined if undecidable)
Parameters
- _ignore_checkKey: ArrayBuffer
Returns undefined
Overrides KeyInterface._checkPrivateKey

decrypt

decrypt(...parameters: [data: ArrayBuffer]): Promise<ArrayBuffer>
Decrypt some data
Parameters
- ...parameters: [data: ArrayBuffer]
Returns Promise<ArrayBuffer>
Overrides KeyInterface.decrypt

encrypt

encrypt(...parameters: [data: ArrayBuffer]): Promise<ArrayBuffer>
Encrypt some data
Parameters
- ...parameters: [data: ArrayBuffer]
Returns Promise<ArrayBuffer>
Overrides KeyInterface.encrypt

sign

sign(
    ...parameters: [data: ArrayBuffer, options?: signOptionsType],
): Promise<
    | BufferStorage
    | ECDSASECP256K1Signature
    | ECDSASECP256R1Signature
    | ED25519Signature,
>
Sign some data
Parameters
- ...parameters: [data: ArrayBuffer, options?: signOptionsType]
Returns Promise<
    | BufferStorage
    | ECDSASECP256K1Signature
    | ECDSASECP256R1Signature
    | ED25519Signature,
>
Overrides KeyInterface.sign

verify

verify(
    data: ArrayBuffer,
    signature:
        | ArrayBuffer
        | BufferStorage
        | ECDSASECP256K1Signature
        | ECDSASECP256R1Signature
        | ED25519Signature,
    options: undefined | signOptionsType,
): boolean
Verify a signature
Parameters
- data: ArrayBuffer
- signature:
      | ArrayBuffer
      | BufferStorage
      | ECDSASECP256K1Signature
      | ECDSASECP256R1Signature
      | ED25519Signature
- options: undefined | signOptionsType
Returns boolean
Overrides KeyInterface.verify