\n\n# Hyperverse EVM Builderkit\n\nThis is an initial scaffold project to assit with building a smart module for the Hyperverse\n\n## How the project is setup\n\n1. `Contracts` - This is the first layer. Think of this as your database model and repository for how to fetch and store data\n2. `Source` - Contains your javascript interface to your contracts. \n3. `Stories` - This is your UI inteterface to your smart module that allows for documentating and testing the functionality of your smart module\n\n\n## Contracts\nModules are primarily written in `solidity`. They utilize the `hardat` framework to assit in the compilation and deploying of your contracts\n\n## Source\nThe javascript source connects to the smart module using `ethers` by default. The format of a Hyperverse smart module is broken down into further sub sections\n\n1. `Library` - Lib folder contains the detailed functions that read & write to the blockchain. \n2. `useHook` - React hook that exposes your library to the react ecosystem. You'll want to rename this export to better help identify your module\n3. `Provider` - Hyperverse modules use the React Context to expose state to child components\n4. `Environment` - Simple component that will identify which blockchain and network your module is being used under. This allows EVM modules to easily work with any supported EVM module\n\n\n# Documentation\nFor more information and learn about Hyperverse checkout the resources below\n\n- [Hyperverse Documentation](https://docs.hyperverse.dev/)\n- [Decentology YouTube Channel](https://www.youtube.com/c/Decentology)\n","readmeFilename":"readme.md"}