@oraichain/seed-phrase v2.0.2-beta.0
oKey Seed Phrase Module
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.
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
11 months ago
11 months ago
12 months ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago