Skip to main content

Security Questions Module - tKey JS SDK

@tkey/security-questions​

The Security Questions Module helps you add or remove the and password as a share for tkey.

Installation​

npm install --save @tkey/security-questions

Initialization​

Parameters​

params

  • saveAnswers?: boolean
import { SecurityQuestionsModule } from "@tkey/security-questions";
const securityQuestionsModule = new SecurityQuestionsModule();

Usage​

With the SecurityQuestionsModule, you have access to the multiple functions as mentioned in the type reference, however, the most important ones are:

Generate New Share with Question and Answer​

generateNewShareWithSecurityQuestions(answerString: string, questions: string): Promise<GenerateNewShareResult>;

  • answerString: Answer corresponding to a security question
  • questions: The security question, must be greater than 10 characters

Example​

await(
  tKeyInstance.modules.securityQuestions as SecurityQuestionsModule,
).generateNewShareWithSecurityQuestions(password, "whats your password?");

Input Existing Security Questions Share into tKey Instance​

inputShareFromSecurityQuestions(answerString: string): Promise<void>;

Example​

  • answerString: Answer corresponding to a security question
await(
  tKeyInstance.modules.securityQuestions as SecurityQuestionsModule,
).inputShareFromSecurityQuestions(password);

Change Security Question and Answer​

changeSecurityQuestionAndAnswer(newAnswerString: string, newQuestions: string): Promise<void>;

  • newAnswerString: Answer corresponding to the new security question
  • newQuestions: The new security question

Example​

await(
  tKeyInstance.modules.securityQuestions as SecurityQuestionsModule,
).changeSecurityQuestionAndAnswer(password, "whats your password?");

Type Reference​

SecurityQuestionsModule​

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>;
}

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;
}