2.0.0 • Published 3 months ago

@shutter-network/shutter-crypto v2.0.0

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

shutter-crypto

This is a NPM package which provides the core crypto primitives necessary to interact with the Shutter Network.

Installation

npm install @shutter-network/shutter-crypto

Usage

The module provides the following public functions:

async shutterCrypto.init(wasmUrlOrPath)

Load and initialize the Go wasm library. This Promise needs to be consumed before any other function in the library is called.

On Node the wasmUrlOrPath parameter is optional. If not given it will be determined automatically.

In a Web context the path to the shutter-crypto.wasm file needs to be given (since it appears no standard cross framework way of automatically determining a path is available).

async shutterCrypto.encrypt(message, eonPublicKey, epochId, sigma)

...

async shutterCrypto.decrypt(encryptedMessage, decryptionKey)

...

async shutterCrypto.verifyDecryptionKey(decryptionKey, eonPublicKey, epochId)

...

Releases

1.0.1 - 2023-08-02

Only contains a fix in the README.

1.0.0 - 2023-08-02

Stable release.

Changes:

  • Fix node v18 incompatibility
  • Add README

0.1.0-beta.3 - 2022-07-18

First usable version

This includes significant size reduction of the generated wasm file.