A Rust-based API for generating and verifying Merkle trees used in Sablier.
For more details about Sablier, check out our website and our documentation at docs.sablier.com.
Sablier Airdrops rely on pre-configured Merkle trees. This data structure contains the list of recipients as well as their individual claim details. Utilities are required to create, manage and validate such Merkle trees.
To make these functionalities available to the Sablier client interfaces as well as 3rd party integrators we've created
a Rust backend service called merkle-api. Through a REST API, it provides access to creating, storing and reading from
Airstream related Merkle trees.
To properly integrate the Sablier Merkle API into your own product or perform local tests, please consult the docs at docs.sablier.com.
The API provides endpoints that support actions like: creating a campaign, checking eligibility for a particular address etc. For more details, see the endpoints docs.
You can see an example of the Rust CSV Generator here:
https://gist.github.com/gavriliumircea/2a9797f207a2a2f3832ddaa376337e8c
All the rules for formatting such CSV are explained here.
Feel free to dive in! Open an issue, start a discussion or submit a PR.
You will need the following software on your machine:
You will need the following VSCode extensions:
We recommend forking this repository and running the Merkle backend using either your own infrastructure or a Vercel project hosted under an account you own. This guarantees you'll have more control over the uptime of the service, as well as access to add any custom features or optimizations you may need.
Sablier Merkle API is licensed under GPL v3 or later.