Skip to content

Latest commit

 

History

History
122 lines (88 loc) · 5.63 KB

README.md

File metadata and controls

122 lines (88 loc) · 5.63 KB
Raw

vrf8ball.link

Table of Contents

Description and demo video

A verifiably random Magic 8 Ball frontend web application, using a Goerli testnet smart contract as the server, powered by Chainlink VRF V2 and the VRF V2 subscription funding model.

Here is the demo video.

Using the live application

  • Visit the website vrf8ball.link and connect to the Goerli testnet!
    • Only Goerli and Hardhat (locally) are supported.
    • The final deployed contract can be seen here on Etherscan

Local Development

The frontend has a hard dependency on the contract being deployed. Because of this, frontend dev + testing requires a bit of setup.

Follow the instructions below to setup and deploy the contract locally, and then connect the frontend to it.

In the backend

  1. Setup the backend and run a local hardhat node.
cd backend
# Make sure everything is installed and working
yarn
yarn hardhat compile
yarn hardhat test

# Run a local hardhat node. This will auto-deploy the contract and log the address of the deployed contract.
yarn hardhat node
  1. Copy and save the output deployed contract address from running yarn hardhat node (it will display above the output for all the generated accounts).

Then, in the frontend...

  1. Navigate to the frontend and replace the constant LOCALHOST_CONTRACT_ADDRESS in the file fe-client/utils/config.ts with your copied contract address.
  2. Run the following:
yarn && yarn dev

  1. In your browser, visit http://localhost:3000/

  2. Setup (or connect to) the Hardhat network with your browser wallet of choice. Instructions for how to do that can be found here.

  3. Once connected to the Hardhat network, you should see the following as your initial state.

Initial State example

Features and Functionality

Frontend

  • A user can connect their wallet
  • Once connected, a user will either see the application (if connected to a supported network), or a message telling them the supported network to connect to.
  • The user can enter a question, submit it, and await an answer from the Magic 8 Ball.
    • Invalid inputs are validated client-side.
    • Canceling the request will revert the UI to its original state.
  • The UI will go into a loading state, awaiting the response.
  • Once the response is available, the UI will render the answer.
  • Returning to the page later on will show the last answer just above the question input.
  • The frontend restores the UI state if the user refreshes or leaves the page while awaiting an answer.
    • But, in the current implementation, this requires that the transaction has already been committed in order for it to work smoothly.

Backend

  • A user can have a single running VRF request (i.e. in-flight answer) at a time.
  • A user can only ask a question if they are not already awaiting a VRF response.
  • Multiple users can have in-flight responses simultaneously.
  • A user can request another answer from the Magic 8 Ball after they receive an answer.

License

  • The frontend project specifies the GNU GPL V3 license (see: fe-client/LICENSE
    • A non-trivial portion of the frontend application also re-uses (with modification, and attribution) this Codepen by Carli Botes.
      • The derivative code has been commented inline in accordance with the relevant Codepen license.
  • The backend project is compliant with the MIT license as it's a derivative work (see: backend/LICENSE))

Miscellaneous

This project would not have been possible without the following resources

Technologies, Stack

  • Backend
    • Chainlink VRF V2 (subscription funding model), powered by Chainlink
    • Ethereum network (i.e. Goerli testnet)
    • Hardhat
    • Typescript + Solidity
  • Frontend
  • Infra
    • Netlify (hosting)
    • Alchemy (RPC provider)