Jędrzej Stuczyński
4890c528bc
* mixFetch * clippy * removed redundant Arc over 'WasmStorage' in the 'ClientStorage' --------- Co-authored-by: Fouad <fmtabbara@hotmail.co.uk>
46 lines
1.8 KiB
Markdown
46 lines
1.8 KiB
Markdown
# Nym Sphinx webassembly client
|
|
|
|
Produces layer-encrypted Sphinx packets for use with Nym mixnets.
|
|
|
|
[Sphinx](http://www0.cs.ucl.ac.uk/staff/G.Danezis/papers/sphinx-eprint.pdf) packets ensure the privacy of information in transit, even when the adversary is able to monitor the network in its entirety. When used with a mixnet, both content (what you said) and metadata (who you said it to, when you said it) are protected.
|
|
|
|
This helps browser-based and mobile applications get stronger privacy, in a way that wasn't previously possible.
|
|
|
|
This client is part of the [Nym](https://nymtech.net/docs) project. It's written in Rust and compiled to WebAssembly.
|
|
|
|
## Security Status
|
|
|
|
From a security point of view, this module is not yet complete. Key missing features include, but are not limited to: cover traffic, sending packets with delay according to Poisson distribution.
|
|
|
|
They should be implemented soon. You can build your applications, but don't rely on it for strong anonymity yet if your application needs cover traffic.
|
|
|
|
## Using it
|
|
|
|
See the [SDK directory](../../sdk/typescript/examples) for examples on how to use it and the NPM packages available.
|
|
|
|
## Developing
|
|
|
|
Make sure you have `wasm-pack` installed (`cargo install wasm-pack`) before you start.
|
|
|
|
Please use the [Makefile](Makefile) targets to build this crate and compile it to WASM:
|
|
|
|
```
|
|
make build
|
|
```
|
|
|
|
The outputs will be found [here](../../dist/wasm/client) where it will be accessible to the rest of the monorepo using workspaces.
|
|
|
|
### Packaging
|
|
|
|
> **TODO**
|
|
|
|
If you're a Nym platform developer who's made changes to the Rust files and wants to re-publish the package to NPM, here's how you do it:
|
|
|
|
1. bump version numbers as necessary for SemVer
|
|
2. go the `sdk/typescript` directory (off the project root)
|
|
3. run:
|
|
```
|
|
yarn
|
|
yarn build
|
|
yarn publish
|
|
``` |