@oraichain/security-questions NPM

tKey Security Questions Module

The oKey Security Questions Module helps you add or remove the and password as a share for oKey. This module is the part of the oKey SDK.

Installation

npm install --save @oraichain/security-questions

Initialization

Import the `SecurityQuestionsModule` class from `@oraichain/security-questions`

import SecurityQuestionsModule from "@oraichain/security-questions";

Assign the `SecurityQuestionsModule` class to a variable

const securityQuestionsModule = new SecurityQuestionsModule(params);

Parameters

params

saveAnswers?: boolean

Returns

The SecurityQuestionsModule class returns an object with the following properties:

class SecurityQuestionsModule implements IModule {
  moduleName: string;
  tbSDK: ITKeyApi;
  saveAnswers: boolean;
  constructor(saveAnswers?: boolean);
  static refreshSecurityQuestionsMiddleware(generalStore: unknown, oldShareStores: ShareStoreMap, newShareStores: ShareStoreMap): unknown;
  setModuleReferences(tbSDK: ITKeyApi): void;
  initialize(): Promise<void>;
  generateNewShareWithSecurityQuestions(answerString: string, questions: string): Promise<GenerateNewShareResult>;
  getSecurityQuestions(): string;
  inputShareFromSecurityQuestions(answerString: string): Promise<void>;
  changeSecurityQuestionAndAnswer(newAnswerString: string, newQuestions: string): Promise<void>;
  saveAnswerOnTkeyStore(answerString: string): Promise<void>;
  getAnswer(): Promise<string>;
}

Usage

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

Generate new share with security questions

`generateNewShareWithSecurityQuestions(answerString: string, questions: string)`

answerString: Answer corresponding to a security question
questions: The secutity question

Return

Promise<GenerateNewShareResult>: The GenerateNewShareResult object

GenerateNewShareResult

declare type GenerateNewShareResult = {
  newShareStores: ShareStoreMap;
  newShareIndex: BN;
};
export declare type ShareStoreMap = {
  [shareIndex: string]: ShareStore;
};
declare class ShareStore implements ISerializable {
  share: Share;
  polynomialID: PolynomialID;
  constructor(share: Share, polynomialID: PolynomialID);
  static fromJSON(value: StringifiedType): ShareStore;
  toJSON(): StringifiedType;
}