oKey Web Storage Module
The oKey Web Storage Module helps you store and recall key shares in the from local and file storage. This module is the part of the oKey SDK.
Installation
npm install --save @oraichain/web-storage
Initialization
WebStorageModule
class from @oraichain/web-storage
Import the import WebStorageModule from "@oraichain/web-storage";
WebStorageModule
class to a variable
Assign the const webStorageModule = new WebStorageModule(params);
Parameters
params
-
canUseFileStorage?
:boolean
Returns
The WebStorageModule
class returns an object with the following properties:
class WebStorageModule implements IModule {
moduleName: string;
tbSDK: ITKeyApi;
canUseFileStorage: boolean;
constructor(canUseFileStorage?: boolean);
setFileStorageAccess(): Promise<void>;
setModuleReferences(tbSDK: ITKeyApi): void;
initialize(): Promise<void>;
storeDeviceShare(deviceShareStore: ShareStore, customDeviceInfo?: StringifiedType): Promise<void>;
storeDeviceShareOnFileStorage(shareIndex: BNString): Promise<void>;
getDeviceShare(): Promise<ShareStore>;
inputShareFromWebStorage(): Promise<void>;
}
Usage
With the WebStorageModule
, you've access to the following functions:
Store Device Share
storeDeviceShare(deviceShareStore: ShareStore, customDeviceInfo?: StringifiedType)
-
deviceShareStore
: TheShareStore
object to store. -
customDeviceInfo?
: Information about the device to store.
ShareStore
class ShareStore implements ISerializable {
share: Share;
polynomialID: PolynomialID;
constructor(share: Share, polynomialID: PolynomialID);
static fromJSON(value: StringifiedType): ShareStore;
toJSON(): StringifiedType;
}
interface ISerializable {
toJSON(): StringifiedType;
}
Storing a Share on File Storage
storeDeviceShareOnFileStorage(shareIndex)
-
shareIndex
: The index of the share to store.
Get a ShareStore from Storage
getDeviceShare()
Return
-
Promise<ShareStore>
: TheShareStore
object.