https://github.com/mattpereira/merkle-tree-gift-list

Alchemy University week 2 project
https://github.com/mattpereira/merkle-tree-gift-list

Last synced: about 18 hours ago
JSON representation

Alchemy University week 2 project

• Host: GitHub
• URL: https://github.com/mattpereira/merkle-tree-gift-list
• Owner: MattPereira
• Created: 2023-07-21T17:36:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-21T17:50:22.000Z (over 1 year ago)
• Last Synced: 2023-07-21T23:09:39.308Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Gift List

The nice list contains many names stored as strings. A merkle tree is created from the nice list and a root is computed and stored on the server. The client sends a request containing a name and a merkle proof to the server. The server uses the name and proof along with the merkle root to determine if the name is part of the list represented by the merkle root.

If the name is in the list, the server sends a gift 🤖, but if the name is not in the list, the server sends a lump of coal 🪨.

## Getting Started

To get started with the repository, clone it and then run `npm install` in the top-level directory to install the depedencies.

There are three folders in this repository:

## Client

You can run the client from the top-level directory with `node client/index`. This file is a script which will send an HTTP request to the server.

Think of the client as the _prover_ here. It needs to prove to the server that some `name` is in the `MERKLE_ROOT` on the server.

## Server

You can run the server from the top-level directory with `node server/index`. This file is an express server which will be hosted on port 1225 and respond to the client's request.

Think of the server as the _verifier_ here. It needs to verify that the `name` passed by the client is in the `MERKLE_ROOT`. If it is, then we can send the gift!

## Utils

There are a few files in utils:

- The `niceList.json` which contains all the names of the people who deserve a gift this year (this is randomly generated, feel free to add yourself and others to this list!)

- The `example.js` script shows how we can generate a root, generate a proof and verify that some value is in the root using the proof. Try it out from the top-level folder with `node/example.js`

- The `MerkleTree.js` should look familiar from the Merkle Tree module! This one has been modified so you should not have to deal with any crypto type conversion. You can import this in your client/server

- The `verifyProof.js` should also look familiar. This was the last stage in the module. You can use this function to prove a name is in the merkle root, as show in the example.