The goal of this exercise is to develop a pet park smart contract. The basic structure of this contract has been laid out for you in src/PetPark.sol
. We can have 5 kinds of animals in our pet park
- Fish (AnimalType: 1)
- Cat (AnimalType: 2)
- Dog (AnimalType: 3)
- Rabbit (AnimalType: 4)
- Parrot (AnimalType: 5)
To install foundry refer to the document here.
This assignment is divided into two parts. In Part A
of the assignment you need to write the unimplemented PetPark
contract. In Part B
of the assignment we have a few incomplete tests you need to complete in test/PetPark.t.sol
.
Complete this contract with following specifications for each function
-
add
- Takes
Animal Type
andCount
. Gives shelter to animals in our park. - Only contract owner (address deploying the contract) should have access to this functionality.
- Emit event
Added
with parametersAnimal Type
andAnimal Count
.
- Takes
-
borrow
- Takes
Age
,Gender
andAnimal Type
. - Can borrow only one animal at a time. Use function
giveBackAnimal
to borrow another animal. - Men can borrow only
Dog
andFish
. - Women can borrow every kind, but women aged under 40 are not allowed to borrow a
Cat
. - Throw an error if an address has called this function before using other values for
Gender
andAge
. - Emit event
Borrowed
with parameterAnimal Type
.
- Takes
-
giveBackAnimal
- Throw an error if user hasn't borrowed before.
- Emit event
Returned
with parameterAnimal Type
.
Complete the following tests in test/PetPark.t.sol
-
testCannotAddAnimalWhenNonOwner
- Test that any non-owner account cannot add animals using the
add
function
- Test that any non-owner account cannot add animals using the
-
testCannotBorrowWhenAgeZero
- Test that the borrow function fails when called with an age equal to 0.
-
testBorrowCountDecrement
- Test that the count of animal decreases correctly when the
borrow
function is called.
- Test that the count of animal decreases correctly when the
-
Clone this repo. Use the flag
--recurse-submodules
to clone the repo along with the submodules. You can use the following command after replacing theCLONE_URL
with the clone url of your repogit clone --recurse-submodules https://github.com/DappCamp-Assignments/3bca683ad15abe4772338bcb2ca715585bc13c3572b27ce5f846a1cb513321ab.git
-
Install
forge-std
library using the below commandforge install foundry-rs/forge-std --no-commit
-
Create a new branch with your name. You can use the following command
git checkout -b satyajeet-sindhiyani
-
Make changes to the
src/PetPark.sol
file. The tests intest/PetPark.t.sol
should run successfully. -
Run Tests
forge test
-
Create a pull request from your forked repo to main branch of original repo to run the github workflow.
- The error strings (mentioned in revert statement) must be same as the ones mentioned in tests.
- Use modifiers, structs where appropriate.