https://github.com/eupn/minisketch-rs

Rust bindings to @sipa's minisketch library
https://github.com/eupn/minisketch-rs

bindgen crypto math rust-bindings rust-ffi

Last synced: 12 months ago
JSON representation

Rust bindings to @sipa's minisketch library

• Host: GitHub
• URL: https://github.com/eupn/minisketch-rs
• Owner: eupn
• Created: 2019-05-30T17:24:02.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-07-20T21:15:56.000Z (almost 5 years ago)
• Last Synced: 2025-06-11T14:07:23.215Z (about 1 year ago)
• Topics: bindgen, crypto, math, rust-bindings, rust-ffi
• Language: Rust
• Size: 47.9 KB
• Stars: 22
• Watchers: 2
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# minisketch-rs

[![Crates.io](https://img.shields.io/crates/v/minisketch-rs.svg)](https://crates.io/crates/minisketch-rs)

[![Crates.io](https://img.shields.io/crates/d/minisketch-rs.svg)](https://crates.io/crates/minisketch-rs)

[![Docs.rs](https://docs.rs/minisketch-rs/badge.svg)](https://docs.rs/minisketch-rs/)

[![Build Status](https://travis-ci.com/eupn/minisketch-rs.svg?branch=master)](https://travis-ci.com/eupn/minisketch-rs)

`minisketch-rs` is a wrapper around [minisketch](https://github.com/sipa/minisketch),

a C library by [Pieter Wuille](https://github.com/sipa) for efficient set reconciliation.

> minisketch is proposed as a part of an [Erlay](https://arxiv.org/abs/1905.10518) technique for bandwidth-efficient TX propagation in Bitcoin.

This library exposes type-safe Rust bindings to all `minisketch` functions by providing `Minisketch` structure.

## Usage

Add dependency in Cargo.toml:

```toml

[dependencies]

minisketch-rs = "0.1"

```

Generate sketches from your sets of data, serialize those sketches and send them around. Reconcile sets between peers by merging sketches.

## Examples

See the [examples](examples).