README.md

genSTARK Demo

This repository provides examples of using genSTARK library.

Environment

To make the best use of examples in this repository, you'll need the following:

1. Node.js - you'll need this to run the examples. Version 12.x would do.
2. VS Code - you'll need it to edit files. Version 1.41 or higher would do.
3. AirScript Syntax Highlighter for VS Code - this will make editing AirScript files much nicer.
4. TypeScript (this usually comes with VS Code) - you'll need this recompile TypeScript files.

Usage

To run the examples in this repo, do the following:

1. Make sure your environment is set up as described above.
2. Clone the project locally: git clone https://github.com/GuildOfWeavers/genSTARK.demo.git
3. Run npm install - this will download all dependencies

Examples

This repository contains the following examples:

1. MiMC - contains AirScript code for MiMC computation.
2. Poseidon - contains AirScript code for Poseidon hash function, including an example of using the function for Merkle tree verification.
3. Poseidon - contains AirScript code for Rescue hash function, including an example of using the function for Merkle tree verification.

License

MIT © 2020 Guild of Weavers