https://github.com/gammaswap/v1-periphery

Periphery code to interact with GammaSwap smart contracts in v1-core
https://github.com/gammaswap/v1-periphery

defi ethereum impermanent-loss yield-farming

Last synced: about 1 month ago
JSON representation

Periphery code to interact with GammaSwap smart contracts in v1-core

• Host: GitHub
• URL: https://github.com/gammaswap/v1-periphery
• Owner: gammaswap
• License: gpl-3.0
• Created: 2022-07-26T00:17:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-11T22:04:51.000Z (7 months ago)
• Last Synced: 2024-08-08T20:33:07.415Z (5 months ago)
• Topics: defi, ethereum, impermanent-loss, yield-farming
• Language: Solidity
• Homepage:
• Size: 5.08 MB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

    

  



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](https://getfoundry.sh/)

## Solidity Versions

Code is tested with solidity version 0.8.21 but compiled and deployed with 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