tKey Private Key Module

The tKey Private Key Module helps you add or remove the and password as a share for tkey. This module is the part of the tKey SDK.

Installation

npm install --save @thresholdkey/private-keys

Initialization

Import the PrivateKeyModule class from @thresholdkey/private-keys

import PrivateKeyModule from "@thresholdkey/private-keys";

Assign the PrivateKeyModule class to a variable

const privateKeyModule = new PrivateKeyModule();

Returns

The PrivateKeyModule class returns an object with the following properties:

declare class PrivateKeyModule implements IModule {
  moduleName: string;
  tbSDK: ITKeyApi;
  privateKeyFormats: IPrivateKeyFormat[];
  constructor(formats: IPrivateKeyFormat[]);
  setModuleReferences(tbSDK: ITKeyApi): void;
  initialize(): Promise<void>;
  setPrivateKey(privateKeyType: string, privateKey?: BN): Promise<void>;
  getPrivateKeys(): Promise<IPrivateKeyStore[]>;
  getAccounts(): Promise<BN[]>;
}

Usage

With the PrivateKeyModule, you've access to the following functions:

Set Private Key

setPrivateKey(privateKeyType: string, privateKey?: BN)

• privateKeyType: The type of private key to set.
• privateKey: The private key to set.

Get Private Keys

getPrivateKeys()

Return

• Promise<IPrivateKeyStore[]>- The private keys stored.