2.0.2-beta.0 • Published 10 months ago

@oraichain/seed-phrase v2.0.2-beta.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

oKey Seed Phrase Module

npm version minzip

The oKey Seed Phrase 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/seed-phrase

Initialization

Import the SeedPhraseModule class from @oraichain/seed-phrase

import SeedPhraseModule from "@oraichain/seed-phrase";

Assign the SeedPhraseModule class to a variable

const seedPhraseModule = new SeedPhraseModule();

Returns

The SeedPhraseModule class returns an object with the following properties:

declare class SeedPhraseModule implements IModule {
  moduleName: string;
  tbSDK: ITKeyApi;
  seedPhraseFormats: ISeedPhraseFormat[];
  constructor(formats: ISeedPhraseFormat[]);
  setModuleReferences(tbSDK: ITKeyApi): void;
  initialize(): Promise<void>;
  setSeedPhrase(seedPhraseType: string, seedPhrase?: string): Promise<void>;
  setSeedPhraseStoreItem(partialStore: ISeedPhraseStore): Promise<void>;
  CRITICAL_changeSeedPhrase(oldSeedPhrase: string, newSeedPhrase: string): Promise<void>;
  getSeedPhrases(): Promise<ISeedPhraseStore[]>;
  getSeedPhrasesWithAccounts(): Promise<ISeedPhraseStoreWithKeys[]>;
  getAccounts(): Promise<BN[]>;
}

Usage

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

Set Seed Phrase

setSeedPhrase(seedPhraseType: string, seedPhrase?: string)

  • seedPhraseType: The type of seed phrase to set.
  • seedPhrase: The seed phrase to set.

Set Seed Phrase Store Item

setSeedPhraseStoreItem(partialStore: ISeedPhraseStore)

  • partialStore: The partial store to set.

Get Seed Phrase

getSeedPhrases()

Return

  • Promise<ISeedPhraseStore[]>: A list of seed phrases.

Get Seed Phrase With Accounts

getSeedPhrasesWithAccounts()

Return

  • Promise<ISeedPhraseStoreWithKeys[]>: A list of seed phrases with accounts.
2.2.1

10 months ago

2.2.0

10 months ago

2.1.4

10 months ago

2.1.3

10 months ago

2.1.6

10 months ago

2.1.5

10 months ago

2.1.2

11 months ago

2.1.1

11 months ago

2.1.0

12 months ago

2.0.5

1 year ago

2.0.4

1 year ago

2.0.2-beta.0

2 years ago

2.0.1

2 years ago

2.0.1-beta.2

2 years ago

2.0.0

2 years ago

1.3.1-beta.0

2 years ago

1.3.0

2 years ago

1.2.19-beta.0

2 years ago

1.2.18

2 years ago

1.2.18-beta.2

2 years ago

1.2.18-beta.1

2 years ago

1.2.18-beta.0

2 years ago

1.2.17

2 years ago

1.2.17-beta.4

2 years ago

1.2.17-beta.3

2 years ago

1.2.17-beta.0

2 years ago

1.2.16

2 years ago

1.2.15

2 years ago

1.2.14

2 years ago

1.2.13

2 years ago

1.2.12

2 years ago

1.2.11

2 years ago

1.2.10

2 years ago

1.2.9

2 years ago

1.2.8

2 years ago

1.2.7

2 years ago

1.2.6

2 years ago

1.2.5

2 years ago

1.2.4

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.0

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago