demmojo / SuperFarm-Sample

A sample repository for a SuperFarm developer interview project.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SuperFarm Sample

Thank you for your interest in working with our team! This repository is used as a project to evaluate potential SuperFarm developers. It contains a single smart contract. Please fork this repository and open a pull request completing our requested tasks. All work must be performed using Solidity, JavaScript, or ReasonML. Needless to say, all work submitted must be your own. Do not plagiarize from any other submissions. We anticipate this sample to be a one or two day task. Reach out to us for a preliminary interview and we'll gladly pay you for your time spent completing this sample.

Goal

The primary goal of this work sample is to have you take the provided smart contract, evaluate it using SuperFarm's preferred environment, implement any improvements you believe are necessary, and produce a demonstration front-end interface to interact with the smart contract. Another very important goal of this work sample is to test your ability to effectively communicate technical details about your work via documentation and a final demonstration of your solution.

Reading

Please take some time to familiarize yourself with the provided smart contract. Once you have done so, find the section labeled TODO and fill in the missing NatSpec comments. Then, provide a brief written explanation or summary of what the provided smart contract does and how it may be used.

Testing

SuperFarm uses Hardhat as its Ethereum development environment of choice. Our preferred library for interacting with smart contracts is Ethers. Please download and configure Hardhat. Then, using Ethers and Mocha, write appropriate test cases for evaluating the provided smart contract. Feel free to use any existing OpenZeppelin contracts, custom mock contracts, or helper utility functions that you need. We are looking for a robust set of unit tests.

Improving

Once you've evaluated the provided smart contract, please implement any fixes or improvements you can think of. Try not to alter the fundamental contract too radically; we are trying to evaluate you on your ability to work iteratively with the sample that has been given to you. Make sure to write unit tests to validate that the contract still behaves correctly given any edits that you make.

If you choose to make no edits to the smart contract, please provide a written explanation of why you believe the existing smart contract requires no improvements.

Deploying

Please deploy the provided smart contract to a test network of your choice using a deployment script in Hardhat. Use this Hardhat plugin to verify the contract code on the test network. In your final pull request include the smart contract address, test network, and an Etherscan link to the deployed contract.

Interfacing

SuperFarm has chosen to use Vue3 for building all of its frontend interfaces. Please create a Vue3 application to interface with your deployed smart contract using Ethers. You may assume that the user visiting your application has installed and unlocked their wallet via MetaMask. In your final pull request, include specific instructions with all details necessary for running and testing your application. Bonus points if you also host your application live somewhere.

Wrapping Up

In your pull request, please include any supplementary documentation, diagrams, or media which might better demonstrate or explain your final product. Once you have opened your pull request, notify our team and we will arrange a time to have you walk us through your solution.

About

A sample repository for a SuperFarm developer interview project.

License:GNU General Public License v3.0


Languages

Language:Solidity 100.0%