0xandee / JediSwap

JediSwap

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JediSwap

Clone of Uniswap V2 to Cairo. AMM for StarkNet.

Testing and Development

We use Protostar for our testing and development purposes. Protostar is a StarkNet smart contract development toolchain, which helps you with dependencies management, compiling and testing cairo contracts.

Install Protostar

  1. Copy and run in a terminal the following command:
curl -L https://raw.githubusercontent.com/software-mansion/protostar/master/install.sh | bash
  1. Restart the terminal.
  2. Run protostar -v to check Protostar and cairo-lang version.

Note

Protostar requires version 2.28 or greater of Git.

Install Protostar Dependencies

protostar install

Compile Contracts

protostar build

Run Tests

protostar test

Run Scripts

Setup a local virtual env

python -m venv ./venv
source ./venv/bin/activate

Install dependencies

pip install -r requirements.txt

Find more info about the installed dependencies here:

Run Scripts

All scripts are placed in scripts folder. testnet config is not committed, please create your own in scripts/config

To run scripts on local system, you first need to run a devnet server:

starknet-devnet

Run script by specifying the path to the script file. Example:

python scripts/deploy.py local

About

JediSwap


Languages

Language:Cairo 93.9%Language:Python 6.1%