@gearbox-protocol/dummy

Gearbox protocol

This repository contains dummy code and is a dummy npm package to test tooling on

What is Gearbox protocol?

Gearbox is a generalized leverage protocol: it allows you to take leverage in one place and then use it across various DeFi protocols and platforms in a composable way. The protocol has two sides to it: passive liquidity providers who earn higher APY by providing liquidity; active traders, farmers, or even other protocols who can borrow those assets to trade or farm with x4+ leverage.

Gearbox protocol is a Marketmake ETHGlobal hackathon finalist.

Bug bounty

This repository is subject to the Gearbox bug bounty program, per the terms defined here.

Documentation

General documentation of the Gearbox Protocol can be found here. Developer documentation with more tech-related infromation about the protocol, contract interfaces, integration guides and audits is available on the Gearbox dev protal.

Testing

Setup

Running Forge tests requires Foundry. See Foundry Book for installation details.

Unit tests

forge t

Mainnet integration tests

Start a Mainnet or Goerli fork with: yarn fork or yarn fork-goerli, respectively.
Open a new terminal window and run forge t --match-test _live_ --fork-url http://localhost:8545.

It is recommended to set $ETH_MAINNET_BLOCK or $ETH_GOERLI_BLOCK to run the tests on a fixed block. Mainnet tests can take significant time to run and can fail unexpectedly due to external provider errors. Re-running the tests on the same block (or without restarting the fork) will be sped up due to caching.

Licensing

The primary license for Gearbox contracts is the Business Source License 1.1 (BUSL-1.1), see LICENSE. The files licensed under the BUSL-1.1 have appropriate SPDX headers.

The files in contracts/adapters, contracts/interfaces are licensed under GPL-2.0-or-later.
The files in contracts/integrations are either licensed under GPL-2.0-or-later or unlicensed (as indicated in their SPDX headers).
The files in scripts, contracts/test,contracts/mocks are unlicensed.

Disclaimer

This application is provided "as is" and "with all faults." Me as developer makes no representations or warranties of any kind concerning the safety, suitability, lack of viruses, inaccuracies, typographical errors, or other harmful components of this software. There are inherent dangers in the use of any software, and you are solely responsible for determining whether this software product is compatible with your equipment and other software installed on your equipment. You are also solely responsible for the protection of your equipment and backup of your data, and THE PROVIDER will not be liable for any damages you may suffer in connection with using, modifying, or distributing this software product.

@gearbox-protocol/dummy