Table of Contents
An Automated Market Maker (AMM) is a decentralized financial protocol that facilitates the trading of digital assets on blockchain networks, such as Ethereum.
We built an AMM smart contract, that depends on constant product algorism (X * Y = K).
We used blockchain technology, the Ethereum network, and smart contract development technology to achieve our goal.
The smart contract is written in solidity, and we used JS/TS to test and interact with the contract.
The smart contract is built using hardhat framework, ethersjs, and some other packages and dependencies that speed up in development process.
This is an example of how to run the smart contract locally on your computer.
You need to check if nodejs and npm are installed on your computer first.
npm --versionnode --versionIf you don't have node, you can install it from there official website
Below is an example of how to start interacting with the smart contract locally.
- Clone the repo
git clone https://github.com/Al-Qa-qa/constant-product-amm.git
- Install NPM packages (remember to move to the directory
constant-product-ammfirst)npm install
- Code installed successfully, you can start testing it.
You can interact with the smart contract on the local network now.
npm run compileto compile the solidity codenpm run deployto deploy the contract on the hardhat networknpm run testto run the unit testing of the contract
This project is under the MIT License. See LICENSE for more information.
Al-Qa'qa' - @Al_Qa_qa - [email protected]
Project Link: https://github.com/Al-Qa-qa/constant-sum-amm
We used some web services, open-source projects, and packages that helped us in our development process, which will be listed below.
We would like to apologize if we used a free package or service and forgot to mention it.