Class IdentifierKeyPair

Abstract interface to all kinds of key-related functions

Hierarchy (View Summary)

KeyInterface
- IdentifierKeyPair

Index

Constructors

Properties

supportsEncryption isInstance

Accessors

hasPrivateKey keyType publicKey

Methods

_checkPrivateKey decrypt encrypt sign verify derivePrivateKeyFromSeed derivePublicKeyFromPrivateKey fromSeed

Constructors

constructor

new IdentifierKeyPair(
key: string | ArrayBuffer | IdentifierKey,
identifierType: NETWORK | TOKEN | STORAGE | MULTISIG,
): IdentifierKeyPair
Parameters
- key: string | ArrayBuffer | IdentifierKey
- identifierType: NETWORK | TOKEN | STORAGE | MULTISIG
Returns IdentifierKeyPair
Overrides KeyInterface.constructor

Properties

`Readonly`supportsEncryption

supportsEncryption: false

Determine if the key supports encryption/decryption

`Static`isInstance

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

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(): IdentifierKey
Get the public key for this key pair

Returns IdentifierKey
Overrides KeyInterface.publicKey

Methods

_checkPrivateKey

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

decrypt

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

encrypt

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

sign

sign(_ignored_data: ArrayBuffer): Promise<BufferStorage>
Sign some data
Parameters
- _ignored_data: ArrayBuffer
Returns Promise<BufferStorage>
Overrides KeyInterface.sign

verify

verify(
_ignored_data: ArrayBuffer,
_ignored_signature: ArrayBuffer | ED25519Signature,
): boolean
Verify a signature
Parameters
- _ignored_data: ArrayBuffer
- _ignored_signature: ArrayBuffer | ED25519Signature
Returns boolean
Overrides KeyInterface.verify

`Static`derivePrivateKeyFromSeed

derivePrivateKeyFromSeed(
seed: string | ArrayBuffer,
index: number,
): IdentifierKey
Create a private key generated from a seed value and an index
Parameters
- seed: string | ArrayBuffer
- index: number
Returns IdentifierKey
Overrides KeyInterface.derivePrivateKeyFromSeed

`Static`derivePublicKeyFromPrivateKey

derivePublicKeyFromPrivateKey(key: IdentifierKey): IdentifierKey
Parameters
- key: IdentifierKey
Returns IdentifierKey

`Static`fromSeed

fromSeed(
    seed: string | ArrayBuffer,
    index: number,
    type?: NETWORK | TOKEN | STORAGE | MULTISIG,
): IdentifierKeyPair
Create a new instance with a private key generated from a seed value and index
Parameters
- seed: string | ArrayBuffer
- index: number
- Optionaltype: NETWORK | TOKEN | STORAGE | MULTISIG
Returns IdentifierKeyPair
Overrides KeyInterface.fromSeed