threshold-elgamal 0.1.5 → 0.1.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Threshold ElGamal
2
2
 
3
- This project is a collection of functions implementing the ElGamal encryption algorithm in TypeScript. Its core includes ElGamal functions for key generation, encryption, and decryption. It is extended with support for threshold encryption.
3
+ This project is a collection of functions implementing the ElGamal encryption algorithm in TypeScript on top of native JavaScript BigInteger. Its core includes ElGamal functions for key generation, encryption, and decryption. It is extended with support for threshold encryption.
4
4
 
5
5
  **WIP: Early version. Thresholds when set below the number of scheme participants don't behave as expected.**
6
6
  However, it works correctly with `threshold == participantsCount`, which is its main use case for myself for now.
@@ -13,6 +13,20 @@ It was written as clearly as possible, modularized, and with long, explicit vari
13
13
 
14
14
  The JavaScript/TypeScript ecosystem seems to be lacking in modern, functional ElGamal libraries that work out of the box with reasonable default (this library isn't at that point yet). All PRs are welcome.
15
15
 
16
+ ## Libraries/tools used
17
+
18
+ - TypeScript
19
+ - Vitest
20
+ - ESLint + Prettier
21
+ - Typedoc
22
+
23
+ ## Production dependencies
24
+
25
+ - [bigint-mod-arith](https://www.npmjs.com/package/bigint-mod-arith)
26
+ - [random-bigint](https://www.npmjs.com/package/random-bigint)
27
+
28
+ It has no other production dependencies apart from these two. They could be inlined easily, if needed.
29
+
16
30
  ## TODO
17
31
 
18
32
  - Hashing messages
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "threshold-elgamal",
3
- "version": "0.1.5",
3
+ "version": "0.1.6",
4
4
  "author": "Piotr Piech <piotr@piech.dev>",
5
5
  "license": "MIT",
6
6
  "description": "threshold-elgamal",