Class KeyInterface`Abstract`

Abstract interface to all kinds of key-related functions

Hierarchy (View Summary)

KeyInterface

Index

Constructors

constructor

new KeyInterface(): KeyInterface
Returns KeyInterface

Properties

`Abstract` `Readonly`hasPrivateKey

hasPrivateKey: boolean

Determine if this key pair has a private key associated

`Abstract` `Readonly`keyType

keyType: AccountKeyAlgorithm

Get the type of key in use (ECDSA or ED25519) for this key pair

`Abstract` `Readonly`publicKey

publicKey: ECDSASECP256K1PublicKey | ECDSASECP256R1PublicKey | ED25519PublicKey

Get the public key for this key pair

`Abstract` `Readonly`supportsEncryption

supportsEncryption: boolean

Determine if the key supports encryption/decryption

`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

Methods

`Abstract`_checkPrivateKey

_checkPrivateKey(checkKey: ArrayBuffer): undefined | boolean
Testing interface to validate that a private key is equal to some value (undefined if undecidable)
Parameters
- checkKey: ArrayBuffer
Returns undefined | boolean

`Abstract`decrypt

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

`Abstract`encrypt

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

`Abstract`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,
>

`Abstract`verify

verify(
    ...parameters: [
        data: ArrayBuffer,
        signature: | ArrayBuffer
        | BufferStorage
        | ECDSASECP256K1Signature
        | ECDSASECP256R1Signature
        | ED25519Signature,
        options?: signOptionsType,
    ],
): boolean
Verify a signature
Parameters
- ...parameters: [
      data: ArrayBuffer,
      signature: | ArrayBuffer
      | BufferStorage
      | ECDSASECP256K1Signature
      | ECDSASECP256R1Signature
      | ED25519Signature,
      options?: signOptionsType,
  ]
Returns boolean

Class KeyInterface`Abstract`

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns KeyInterface

Properties

`Abstract` `Readonly`hasPrivateKey

`Abstract` `Readonly`keyType

`Abstract` `Readonly`publicKey

`Abstract` `Readonly`supportsEncryption

`Static` `Optional`derivePrivateKeyFromSeed

`Static` `Optional`fromSeed

Methods

`Abstract`_checkPrivateKey

Parameters

Returns undefined | boolean

`Abstract`decrypt

Parameters

Returns Promise<ArrayBuffer>

`Abstract`encrypt

Parameters

Returns Promise<ArrayBuffer>

`Abstract`sign

Parameters

Returns Promise<
    | BufferStorage
    | ECDSASECP256K1Signature
    | ECDSASECP256R1Signature
    | ED25519Signature,
>

`Abstract`verify

Parameters

Returns boolean

Settings

On This Page

Class KeyInterfaceAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns KeyInterface

Properties

Abstract ReadonlyhasPrivateKey

Abstract ReadonlykeyType

Abstract ReadonlypublicKey

Abstract ReadonlysupportsEncryption

Static OptionalderivePrivateKeyFromSeed

Static OptionalfromSeed

Methods

Abstract_checkPrivateKey

Parameters

Returns undefined | boolean

Abstractdecrypt

Parameters

Returns Promise<ArrayBuffer>

Abstractencrypt

Parameters

Returns Promise<ArrayBuffer>

Abstractsign

Parameters

Returns Promise< | BufferStorage | ECDSASECP256K1Signature | ECDSASECP256R1Signature | ED25519Signature,>

Abstractverify

Parameters

Returns boolean

Settings

On This Page

Class KeyInterface`Abstract`

`Abstract` `Readonly`hasPrivateKey

`Abstract` `Readonly`keyType

`Abstract` `Readonly`publicKey

`Abstract` `Readonly`supportsEncryption

`Static` `Optional`derivePrivateKeyFromSeed

`Static` `Optional`fromSeed

`Abstract`_checkPrivateKey

`Abstract`decrypt

`Abstract`encrypt

`Abstract`sign

Returns Promise<
| BufferStorage
| ECDSASECP256K1Signature
| ECDSASECP256R1Signature
| ED25519Signature,
>

`Abstract`verify