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:
You can run the client from the top-level directory with node client --name "Deserve Agift". 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.
You can run the server from the top-level directory with node server. 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!
There are a few files in utils:
- The
niceList.jsonwhich 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.jsscript 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 withnode utils/example.js - The
MerkleTree.jsshould 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.jsshould 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.