@gammaswap/v1-periphery

V1-Periphery

Description

This is the repository for the periphery smart contracts of the GammaSwap V1 protocol.

This repository contains concrete implementations of periphery contracts to interact with deployed GammaPools.

Contracts in this repository do not contain core GammaSwap logic. Instead, they enhance the functionality of existing core logic by implementing safety checks when calling certain GammaPool functions and increase composability by extending the ERC721 implementation towards GammaPool loans.

The GammaPool contracts in the v1-core repo do not need the contracts in this repository in order to work, but this repository does depend on the contracts in v1-core.

Users are encouraged to interact with the GammaPools via the contracts in this repository to ensure a safe user experience.

Steps to Run GammaSwap Tests Locally

1. Run yarn to install GammaSwap dependencies
2. Run yarn test to run hardhat tests
3. Run yarn fuzz to run foundry tests (Need foundry binaries installed locally)

To deploy contracts to local live network use v1-deployment repository

Note

To install foundry locally go to getfoundry.sh

Solidity Versions

Code is tested with solidity version 0.8.21 but paris evm version because arbitrum does not support shanghai evm

Concrete contracts support only solidity version 0.8.21.

Abstract contracts support solidity version 0.8.4 and up.

Interfaces support solidity version 0.8.0 and up.

Publishing NPM Packages

To publish an npm package follow the following steps

1. Bump the package.json version to the next level (either major, minor, or patch version)
2. commit to the main branch adding 'publish package' in the comment section of the commit (e.g. when merging a pull request)

Rules for updating package.json version

1. If change does not break interface, then it's a patch version update
2. If change breaks interface, then it's a minor version update
3. If change is for a new product release to public, it's a major version update