Alluo - Exchnange

Liquidity optimise exchange for the Alluo Protocol.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Testing
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

This repo contains all the Alluo Exchange, a series of contract allowing users or the Alluo protocol to exchnage any Token to any Token with an optimisation for liquidity. The exchange is fully onchain, not relying on any oracle, or Back-end of any sorts.

The Exchange is made up of a few components: Adaptors, Routes and Major/Minor coints.

Each component is editable by the owner of the contract and can be configured for the most liquidity by said owner.

All the addresses of the contracts deployed to all the networks that are part of the Alluo Protocol are available here: Protocol Library

(back to top)

Built With

Here are the major framework / languages used to build the Protocol.

• Hardhat
• Typescript
• Solidity Coverage
• Etherscan

hardhat

npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat test
npx hardhat node
npx hardhat help
npx hardhat coverage
npx hardhat run scripts/deploy.ts
TS_NODE_FILES=true npx ts-node scripts/deploy.ts
npx eslint '**/*.{js,ts}'
npx eslint '**/*.{js,ts}' --fix
npx prettier '**/*.{json,sol,md}' --check
npx prettier '**/*.{json,sol,md}' --write
npx solhint 'contracts/**/*.sol'
npx solhint 'contracts/**/*.sol' --fix

Etherscan verification

To try out Etherscan verification, you first need to deploy a contract to an Ethereum network that's supported by Etherscan, such as Rinkeby.

In this project, copy the .env.example file to a file named .env, and then edit it to fill in the details. Enter your Etherscan API key, your Rinkeby node URL (eg from Alchemy), and the private key of the account which will send the deployment transaction. With a valid .env file in place, first deploy your contract:

hardhat run --network rinkeby scripts/sample-script.ts

Then, copy the deployment address and paste it in to replace DEPLOYED_CONTRACT_ADDRESS in this command:

npx hardhat verify --network rinkeby DEPLOYED_CONTRACT_ADDRESS "Hello, Hardhat!"

Performance optimizations

For faster runs of your tests and scripts, consider skipping ts-node's type checking by setting the environment variable TS_NODE_TRANSPILE_ONLY to 1 in hardhat's environment. For more details see the documentation.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install
  cp .env.example .env
  nano .env

• yarn

  yarn install
  cp .env.example .env
  nano .env

Testing

npx hardhat clean
npx hardhat test

(back to top)

Roadmap

See our public roadmap here: Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source and DeFi communities such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Bug bounties

If you notice any vulnerabilities, bugs, or even efficiency improvements please checkout our Bug Bounty program on Gitcoin

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

0xtuytuy.eth - @0xtuytuy - rt@alluo.com

Project Link: https://github.com/GetAlluo/alluo-exchange

(back to top)