tKey Share Serialization Module
The Share Serialization Module helps you add or remove the and password as a share for tkey. This module is the part of the tKey SDK.
Installation
npm install --save @tkey/share-serialization
Initialization
ShareSerializationModule
class from @tkey/share-serialization
Import the import ShareSerializationModule from "@tkey/share-serialization";
ShareSerializationModule
class to a variable
Assign the const shareSerializationModule = new ShareSerializationModule();
Returns
The ShareSerializationModule
class returns an object with the following properties:
declare class ShareSerializationModule implements IModule {
moduleName: string;
tbSDK: ITKeyApi;
constructor();
static serializeMnemonic(share: BN): string;
static deserializeMnemonic(share: string): BN;
setModuleReferences(tbSDK: ITKeyApi): void;
initialize(): Promise<void>;
serialize(share: BN, type: string): Promise<unknown>;
deserialize(serializedShare: unknown, type: string): Promise<BN>;
}
Usage
With the ShareSerializationModule
, you've access to the following functions:
Serialize a share
serialize(share: BN, type: string)
-
share
: The share to serialize. -
type
: The type of share to serialize.
Deserialize a share
deserialize(serializedShare: unknown, type: string)
Return
-
Promise<BN>
: The deserialized share.