nissoh/puppet-finance

A public draft for Puppet Finance

🔮 Puppet Finance Smart Contracts

This is the main Puppet Finance public smart contract repository.

🔧 Set up local development environment

Requirements

• Docker Desktop

Local Setup Steps

# clone repo
git clone https://github.com/GMX-Blueberry-Club/puppet-contracts.git

# cd into cloned repo
cd puppet-contracts

# create a .env file
touch .env

# add your Arbitrum RPC URL to the .env file
echo "ARBITRUM_RPC_URL=<YOUR_ARBITRUM_RPC_URL_LINK>" >> .env

# build the docker image
docker build -t puppet .

# run the image with a volume to the current working directory and enter the container
docker run -it -v "/${PWD}:/puppet-contracts" puppet bash

# build the project
forge build

Running Tests

To run tests, run the following commands

# run tests
forge test

# run slither
slither .

📜 Contract Addresses

Deployed Addresses

📖 Documentation

Documentation

💗 Contributing

Contributions are always welcome!

Come say hey in our Discord server