https://github.com/rust-nostr/negentropy

Rust implementation of the negentropy set-reconcilliation protocol.
https://github.com/rust-nostr/negentropy

Last synced: 2 days ago
JSON representation

Rust implementation of the negentropy set-reconcilliation protocol.

• Host: GitHub
• URL: https://github.com/rust-nostr/negentropy
• Owner: rust-nostr
• License: mit
• Created: 2023-09-10T16:28:18.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-20T12:29:42.000Z (about 2 months ago)
• Last Synced: 2024-11-11T03:54:15.467Z (2 days ago)
• Language: Rust
• Size: 193 KB
• Stars: 16
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Negentropy

## Description

Implementation of the [negentropy](https://github.com/hoytech/negentropy) set-reconciliation protocol.

## Project structure

The project is split up into many crates:

* [**negentropy**](./negentropy/): Rust implementation of the negentropy set-reconciliation protocol

* [**negentropy-ffi**](./negentropy-ffi/): UniFFI bindings (Swift, Kotlin and Python) of the [negentropy](./negentropy/) crate

## Flame Graph and perf

Install [flamegraph](https://github.com/flamegraph-rs/flamegraph) and then run `make graph`. 

You'll find a new file in the project root called `flamegraph.svg`: open it in a browser.

In the terminal you should see something like:

```bash

Client init took 0 ms

Relay items: 1000000

Relay reconcile took 25 ms

Client reconcile took 39 ms

[ perf record: Woken up 10 times to write data ]

[ perf record: Captured and wrote 2.406 MB perf.data (150 samples) ]

```

## Benchmarks (unstable)

To run the benchmarks use: `make bench`

## License

This project is distributed under the MIT software license - see the [LICENSE](LICENSE) file for details

## Donations

⚡ Tips: 

⚡ Lightning Address: [email protected]