[Milestone #1-2] Add Design Docs & Interfaces of Smart Contract

[SeiyaKobayashi]

🎨 Overview

Added design documents to visually describe the overall structure of this application. Designed and implemented the interfaces of our verifier (i.e. smart contract) for Milestone#2 (implementation of verifier).

🌈 Details

Added the following.

• Design documents
  • in the form of .png file, referenced in README of root directory
• Interfaces of verifier
  • registerModel(): function that receives and stores model info in smart contract
  • getModels(): function that fetched the list of models
  • getModelInfo(): function that fetched info of requested model
  • commit(): function that receives commitments and generates a random challenge
  • reveal(): function that confirms the matched nodes by verifying Merkle proofs
  • verify(): function that verifies ZKPs and stores the results in smart contract
• Additional setups
  • yarn workspaces & yarn commands
  • hardhat for smart contract development
  • solhint prettier for Solidity files
  • husky/pre-commit
  • READMEs

📚 References

• hardhat
• solhint
• prettier-plugin-solidity
• natspec
• husky

[SeiyaKobayashi]

What about adding the info to the diagram that which part is smart contract or off-chain.

Updated in 55f63a1a5ae2d5d1c32864b99a6dd2065113e8c7!