GETTING_STARTED.md

Getting Started

Requirements

This project includes both frontend and contracts. To begin, install dependencies:

• Node.js v16.15.0 or latest stable. We recommend using nvm to install.
• PNPM v7.1.7 or latest stable
• Rust toolchain v0.16.0 or latest stable
• Forc v0.18.1
• Docker v0.8.2 or latest stable
• Docker Compose v2.6.0 or latest stable

Running Project Locally

📚 - Getting the Repository

1. Visit the SwaySwap repo and fork the project.
2. Then clone your forked copy to your local machine and get to work.

git clone https://github.com/FuelLabs/swayswap
cd swayswap

📦 - Install Dependencies

pnpm install

📒 - Run Local Node

In this step, we are going to;

• launch a local fuel-core node;
• launch a local faucet API;
• Setup swayswap-scripts;
• Build and deploy the SwaySwap contracts;
• Initialize token contract;
• Initialize pool with liquidity ETH <> DAI.

pnpm services:setup

💻 - Run Web App

Start a local development frontend. After running the below command you can open http://localhost:3000 in your browser to view the frontend.

pnpm dev

📗 Project Overview

This section has a brief description of each directory. More details can be found inside each package, by clicking on the links.

• packages/app Frontend SwaySwap application
• packages/contracts 🌴 Sway contracts
• packages/scripts SwaySwap scripts CLI
• packages/test-utils Test utilities for Jest
• packages/config Build configurations
• docker Network configurations

🧰 Useful Scripts

To make life easier we added as many useful scripts as possible to our package.json. These are some of the most used during development:

pnpm <command name>

Script	Description
dev	Run development server for the WebApp packages/app.
contracts	Build, generate types, deploy packages/contracts. It should be used when editing contracts.
contracts:build	Build and generate types packages/contracts.
contracts:deploy	Deploy the current binaries.
scripts:setup	Setup swayswap-scripts used to build and deploy contracts and generate types.
services:clean	Stop and remove all development containers that are running locally.
services:run	Run the local network with fuel-core and the faucet API.
services:setup	Run the local network, setup swayswap-scripts and build and deploy contracts normally used on the first run.

Other scripts can be found in package.json.

Running Tests

Please make sure you have done these steps first:

• 📚 - Getting the Repository
• 📦 - Install Dependencies
• 📒 - Run Local Node

Run Tests in Development Mode

To run all tests against the node and contract configured in packages/app/.env (or packages/app/.env.test if the file exists):

pnpm test

Run Tests on a Local Test Environment

With this command we are going to:

• launch a local test-specific fuel-core node.
• launch a local test-specific faucet API.
• Setup swayswap-scripts.
• Build and deploy the SwaySwap contracts to the test node.
• Initialize the token contract deployed on the test node.
• Create a packages/app/.env.test.
• Run all tests against the configs packages/app/.env.test.
• Delete the local test-specific fuel-core node.
• Delete the local test-specific faucet API.
• Delete packages/app/.env.test.

Note: .env.test is not deleted automatically. It must be deleted manually if desired.

pnpm ci:test