16.0.0 • Published 4 months ago

@tkey/share-serialization v16.0.0

Weekly downloads
92
License
MIT
Repository
github
Last release
4 months ago

tKey Share Serialization Module

npm version minzip

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

Import the ShareSerializationModule class from @tkey/share-serialization

import ShareSerializationModule from "@tkey/share-serialization";

Assign the ShareSerializationModule class to a variable

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.
16.0.0

4 months ago

15.2.1-alpha.0

8 months ago

15.1.0

9 months ago

15.1.0-alpha.0

11 months ago

15.0.2

11 months ago

15.0.0

11 months ago

14.0.0

12 months ago

13.0.0-alpha.6

1 year ago

13.0.0-alpha.4

1 year ago

12.1.2

1 year ago

12.1.1

1 year ago

13.0.1-alpha.0

1 year ago

13.0.0-alpha.1

1 year ago

13.0.0-alpha.0

1 year ago

12.1.0

1 year ago

10.0.0

2 years ago

12.0.0

2 years ago

11.0.2

2 years ago

11.0.3

2 years ago

11.0.0

2 years ago

11.0.1

2 years ago

10.1.0

2 years ago

8.1.0-alpha.0

2 years ago

9.0.1

2 years ago

9.0.0

2 years ago

7.4.0

2 years ago

7.3.0

2 years ago

8.0.5-alpha.0

2 years ago

8.0.7-alpha.0

2 years ago

8.0.6-alpha.0

2 years ago

8.0.0-alpha.0

2 years ago

7.2.0

3 years ago

7.1.0

3 years ago

6.1.0

3 years ago

6.2.0

3 years ago

7.0.0

3 years ago

6.0.0

3 years ago

5.1.4

3 years ago

5.1.3

3 years ago

5.1.2

3 years ago

5.1.1

3 years ago

5.1.0

3 years ago

5.0.0

4 years ago

4.4.0-alpha.0

4 years ago

4.4.0-y.0

4 years ago

4.4.0-alpha.4

4 years ago

4.4.0-alpha.3

4 years ago

4.4.0-alpha.2

4 years ago

4.4.0-alpha.1

4 years ago

4.4.0

4 years ago

4.3.0

4 years ago

4.2.1

4 years ago

4.2.0

4 years ago

4.1.1

4 years ago

4.1.0

4 years ago

4.0.1

4 years ago

4.0.2

4 years ago

3.14.1

4 years ago

3.14.2

4 years ago

4.0.0

4 years ago

3.14.0

4 years ago

3.13.0

4 years ago

3.12.1

4 years ago

3.12.0

4 years ago

3.11.1

4 years ago

3.11.0

4 years ago

3.10.0

4 years ago

3.9.1

4 years ago

3.9.0

4 years ago

3.8.0

4 years ago

3.7.0

4 years ago

3.6.5

4 years ago

3.6.2

5 years ago

3.6.3

5 years ago

3.6.1

5 years ago

3.6.0

5 years ago

3.5.0

5 years ago

3.4.0

5 years ago

3.2.2

5 years ago

3.2.1

5 years ago

3.2.0

5 years ago

3.1.1

5 years ago

3.1.0

5 years ago

3.0.1

5 years ago

3.0.0

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago