Class YlidePrivateKey

Description

This class is designate to store and interact with Ylide communication keypairs

See

Basics of key storage to understand common concepts used here

Hierarchy

SerializableInternal<YlidePrivateKey, this>
- YlidePrivateKey

Index

Constructors

Properties

_keypair address blockchainGroup keyIndex privateKey publicKey

Accessors

availabilityState

Methods

changeEncryptionPassword execute getDecryptedKey storeEncrypted storeNothing storeUnencrypted toBase64 toBytes toHex fromBase64 fromBytes fromHex

Constructors

constructor

new YlidePrivateKey(blockchainGroup: string, address: string, publicKey: PublicKey, privateKey: null | {
    isEncrypted: false;
    privateKey: Uint8Array;
} | {
    encryptedPrivateKey: Uint8Array;
    isEncrypted: true;
}): YlidePrivateKey
Parameters
- blockchainGroup: string
- address: string
- publicKey: PublicKey
- privateKey: null | {
      isEncrypted: false;
      privateKey: Uint8Array;
  } | {
      encryptedPrivateKey: Uint8Array;
      isEncrypted: true;
  }
Returns YlidePrivateKey
Overrides Serializable<YlidePrivateKey>().constructor
- Defined in src/keystore/YlidePrivateKey.ts:31

Properties

`Private` _keypair

_keypair: null | BoxKeyPair = null

`Readonly` address

address: string

`Readonly` blockchainGroup

blockchainGroup: string

`Private` `Readonly` keyIndex

keyIndex: 1 = 1

`Private` privateKey

privateKey: null | {
    isEncrypted: false;
    privateKey: Uint8Array;
} | {
    encryptedPrivateKey: Uint8Array;
    isEncrypted: true;
}

`Readonly` publicKey

publicKey: PublicKey

Accessors

availabilityState

get availabilityState(): PrivateKeyAvailabilityState
Returns PrivateKeyAvailabilityState
- Defined in src/keystore/YlidePrivateKey.ts:51

Methods

changeEncryptionPassword

changeEncryptionPassword(oldPassword: string, newPassword: string): Promise<void>
Method to switch from plaintext storage to encrypted storage of the key
Parameters
- oldPassword: string
- newPassword: string
Returns Promise<void>
- Defined in src/keystore/YlidePrivateKey.ts:187

execute

execute<T>(processor: ((keypair: YlideUnencryptedKeyPair) => Promise<T>), handlers?: YlidePrivateKeyHandlers): Promise<T>
Method for boxed execution of a function with provided decrypted communication key. Right after the execution key is removed from memory.
Type Parameters
- T = void
Parameters
- processor: ((keypair: YlideUnencryptedKeyPair) => Promise<T>)
  
  Async callback which uses decrypted key
  - - (keypair: YlideUnencryptedKeyPair): Promise<T>
    - Parameters
      
      keypair: YlideUnencryptedKeyPair
      
      Returns Promise<T>
- Optional handlers: YlidePrivateKeyHandlers
Returns Promise<T>
- Defined in src/keystore/YlidePrivateKey.ts:217

`Private` getDecryptedKey

getDecryptedKey(password: string): Promise<Uint8Array>
Method to decrypt internally stored private key

Returns
Raw private key
Parameters
- password: string
  
  Ylide password
Returns Promise<Uint8Array>
- Defined in src/keystore/YlidePrivateKey.ts:135

storeEncrypted

storeEncrypted(password: string): Promise<void>
Method to switch from plaintext storage to encrypted storage of the key
Parameters
- password: string
  
  Ylide password
Returns Promise<void>
- Defined in src/keystore/YlidePrivateKey.ts:167

storeNothing

storeNothing(): Promise<void>
Returns Promise<void>
- Defined in src/keystore/YlidePrivateKey.ts:206

storeUnencrypted

storeUnencrypted(password: string): Promise<void>
Method to switch from encrypted storage to plaintext storage of the key
Parameters
- password: string
  
  Ylide password
Returns Promise<void>
- Defined in src/keystore/YlidePrivateKey.ts:148

toBase64

toBase64(): string
Returns string
Inherited from Serializable<YlidePrivateKey>().toBase64
- Defined in src/serialize/Serializable.ts:13

toBytes

toBytes(): Uint8Array
Method to serialize YlidePrivateKeyPair to raw bytes

Returns
Raw Ylide key bytes

Returns Uint8Array
Overrides Serializable<YlidePrivateKey>().toBytes
- Defined in src/keystore/YlidePrivateKey.ts:109

toHex

toHex(): string
Returns string
Inherited from Serializable<YlidePrivateKey>().toHex
- Defined in src/serialize/Serializable.ts:9

`Static` fromBase64

fromBase64(base64: string): YlidePrivateKey
Parameters
- base64: string
Returns YlidePrivateKey
Inherited from Serializable<YlidePrivateKey>().fromBase64
- Defined in src/serialize/Serializable.ts:25

`Static` fromBytes

fromBytes(bytes: Uint8Array): YlidePrivateKey
Method to deserialize YlidePrivateKeyPair from raw bytes

Returns
Instance of YlidePrivateKeyPair
Parameters
- bytes: Uint8Array
  
  Raw Ylide key bytes
Returns YlidePrivateKey
Overrides Serializable<YlidePrivateKey>().fromBytes
- Defined in src/keystore/YlidePrivateKey.ts:67

`Static` fromHex

fromHex(hex: string): YlidePrivateKey
Parameters
- hex: string
Returns YlidePrivateKey
Inherited from Serializable<YlidePrivateKey>().fromHex
- Defined in src/serialize/Serializable.ts:21

Generated using TypeDoc