@alpaca-finance/alpaca-contract

Leveraged yield farming on Binance Smart Chain

Usage no npm install needed!

<script type="module">
  import alpacaFinanceAlpacaContract from 'https://cdn.skypack.dev/@alpaca-finance/alpaca-contract';
</script>

README

Alpaca Contract

Leveraged yield farming on Binance Smart Chain

Local Development

The following assumes the use of node@>=14.

Install Dependencies

  1. Copy .env.example file and change its name to .env in the project folder
  2. Run yarn to install all dependencies

Compile Contracts

yarn compile

Note: There will be a new folder called typechain generated in your project workspace. You will need to navigate to typechain/index.ts and delete duplicated lines inside this file in order to proceed.

Run Tests

yarn test

Licensing

The primary license for Alpaca Protocol is the MIT License, see MIT LICENSE.

Exceptions

  • Single Asset LYF: contracts/6/protocol/workers/CakeMaxiWorker.sol and all files in contracts/6/protocol/strategies/pancakeswapV2-restricted-single-asset are licensed under Business Source License 1.1 (BUSL-1.1) (as indicated in their SPDX headers), see BUSL-1.1
  • All files in tests remain unlicensed.