⚡ BizzSwap ⚡

A place where you hold and manage only the tokens you believe in!

Getting started

Installation

yarn add bizzswap

Usage

Once installed, you can use the contracts from the package by importing them:

pragma solidity ^0.8.0;

import 'bizzswap/contracts/interfaces/IBizzSwap.sol';

contract MyDonation {
	address public bizzswapContract;

	constructor(address _bizzswapContract) {
		bizzswapContract = _bizzswapContract;
	}

	function donate(
		IBizzSwap.SwapParameters memory _params,
		bool _isEthDesired,
		address _recipient,
		address _inputTokenAddress,
		address _outputTokenAddress,
		uint256 _exactAmountOut,
		uint256 _maximumAmountIn
	) public {
		IBizzSwap(bizzswapContract).pay(
			_params,
			_isEthDesired,
			_recipient,
			_inputTokenAddress,
			_outputTokenAddress,
			_exactAmountOut,
			_maximumAmountIn
		);
	}
}

Local development

Prerequisites

Be sure to have installed the following

Git

Node.js

Yarn

Installation

1. Clone the repo

git clone https://github.com/MVPWorkshop/BizzSwap.git
cd BizzSwap

2. Install packages

yarn install

3. Make an .env file and Enter necessary data listed in .env.example file

PRIVATE_KEY='<key>'
ALCHEMY_KEY='<key>'
ETHERSCAN_API_KEY='<key>'
ARBISCAN_API_KEY='<key>'
POLYGONSCAN_API_KEY='<key>'

4. Compile contracts

yarn compile

5. Run tests

yarn test

6. Run test coverage

yarn coverage

Deployment addresses are available at Deploys.md