libsodium-wrappers-sumo 0.8.0 → 0.8.1
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.
package/README.md
CHANGED
|
@@ -8,8 +8,9 @@ compiled to WebAssembly and pure JavaScript using
|
|
|
8
8
|
automatically generated wrappers to make it easy to use in web
|
|
9
9
|
applications.
|
|
10
10
|
|
|
11
|
-
The
|
|
12
|
-
WebAssembly versions)
|
|
11
|
+
The standard version weighs about 290 KB and the sumo version about 375 KB
|
|
12
|
+
(minified, gzipped, includes pure JS + WebAssembly versions). Both can run in
|
|
13
|
+
a web browser as well as server-side.
|
|
13
14
|
|
|
14
15
|
### Compatibility
|
|
15
16
|
|
|
@@ -215,7 +216,7 @@ Functions returning more than one output buffer are returning them as
|
|
|
215
216
|
an object. For example, the `sodium.crypto_box_keypair()` function
|
|
216
217
|
returns the following object:
|
|
217
218
|
```javascript
|
|
218
|
-
{
|
|
219
|
+
{ publicKey: (Uint8Array), privateKey: (Uint8Array), keyType: 'x25519' }
|
|
219
220
|
```
|
|
220
221
|
|
|
221
222
|
### Standard vs Sumo version
|
|
@@ -250,6 +251,12 @@ Running `make` will install the dev dependencies, clone libsodium,
|
|
|
250
251
|
build it, test it, build the wrapper, and create the modules and
|
|
251
252
|
minified distribution files.
|
|
252
253
|
|
|
254
|
+
### Benchmarks
|
|
255
|
+
|
|
256
|
+
Run `make benchmark` to measure the performance of the cryptographic functions.
|
|
257
|
+
You can also run specific benchmarks with `bun benchmark/index.ts --only <name>`
|
|
258
|
+
(use `--list` to see available benchmarks).
|
|
259
|
+
|
|
253
260
|
## Related projects
|
|
254
261
|
|
|
255
262
|
* [react-native-libsodium](https://github.com/serenity-kit/react-native-libsodium): React Native bindings to Libsodium matching the libsodium-wrappers package API
|