https://github.com/nymtech/sphinx
A Sphinx implementation in Rust
https://github.com/nymtech/sphinx
Last synced: 16 days ago
JSON representation
A Sphinx implementation in Rust
- Host: GitHub
- URL: https://github.com/nymtech/sphinx
- Owner: nymtech
- License: apache-2.0
- Created: 2019-11-01T10:24:40.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-28T09:45:28.000Z (about 1 month ago)
- Last Synced: 2025-04-06T05:04:23.124Z (24 days ago)
- Language: Rust
- Size: 772 KB
- Stars: 276
- Watchers: 12
- Forks: 24
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - nymtech/sphinx - A Sphinx implementation in Rust (Rust)
README
## Sphinx
A [Sphinx](https://cypherpunks.ca/~iang/pubs/Sphinx_Oakland09.pdf) packet implementation in Rust.
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/nymtech/sphinx/actions?query=branch%3Adevelop)
### Prerequisites
* rust (stable) : https://www.rust-lang.org/
* docker (for code coverage reports): https://www.docker.com/
### Testing
`cargo test` will run the unit and integration tests.
### Versioning
Whilst this crate hasn't been strictly following the semver versioning conventions, the following changes have been
made:
#### v0.1.0
initial release
#### v0.1.1
updates crypto dependencies, including dalek libraries
#### v0.2.0
fixes uses of undefined scalar multiplications and transitions to using pure x25519 instead
#### v0.3.0
allows using the library with either the v0.2.0 or v0.1.1 crypto (for backwards compatibility reasons). it also changes
the public API to expose version information which has further been reinterpreted to no longer map to the semver version
of this library
#### v0.3.1
added additional public methods on the `Version`
#### v0.3.2
added version method to allow constructing SURBs with legacy headers
#### v0.4.0
removed processing and creation of packets with undefined operations
#### v0.5.0
- temporarily restored processing and creation of packets with undefined operations as additional breaking changes had
to be added to v0.3.2 release
- removed `RoutingKeys` in favour of `ExpandedSharedSecret` and added `ReplyTag`
- type adjustments
#### v0.6.0
- new way of deriving `PayloadKey` that uses seed obtained from the `ExpandedSharedSecret` to reduce sizes of `SURB`s
- API changes
### Benchmarks
To run benchmarks, use:
```
cargo bench
```
Rust benchmarks run the operation multiple times to give a consistent output and report back in the number of
nanoseconds (billionths of a second) per iteration. `1000000000 / result` gives you the number of operations per second.
For later reference, on Dave's i7 Dell XPS-13 (2018) laptop (our test reference machine :)) output is as follows.
```
test tests::bench_new ... bench: 386.348 us/iter
test tests::bench_process ... bench: 157.322 us/iter
```
* `1000000 / 386.348` = ~2588 packet creations per second
* `1000000 / 157.322` = ~6356 packet unwrappings per second