Skip to content

Latest commit

 

History

History
61 lines (41 loc) · 1.77 KB

README.md

File metadata and controls

61 lines (41 loc) · 1.77 KB
Raw

meta_swapos

SwapOS

A trustless peer-to-peer swap protocol

SwapOS is a minimalistic peer-to-peer protocol enabling ERC20-token transfers cross-chain using Hyperlane. Currently, our implementation is a proof-of-concept to support EVM-based chains.

Going forward, SwapOS has the potential to expand beyond EVM's into (1) traditional finance / fiat transfers and (2) other chains (e.g. Bitcoin, Solana, and Gnosis). Swapping tokens cross-chains and without a middleman has never been easier.

Live on swapos.vercel.app

Demo

View the demo here

Team

  • Kenny Chung 👨‍🚀 (@kenny-gin1)
  • Madusha Prasanjith 👨‍💻 (@mprasanjith)
  • Erik Nilsson 👨‍🎨 (@eriknson)

Get started

To run SwapOS locally, install dependencies.

pnpm install

Copy & fill environments.

cp packages/frontend/.env.local.example packages/frontend/.env.local
cp packages/contracts/.env.example packages/contracts/.env

Generate contract-types, start local hardhat node, and start frontend with turborepo (from root-dir).

pnpm dev

Just start frontend (from root-dir).

pnpm frontend:dev

Tech stack

  • Package-Manager: pnpm
  • Monorepo Tooling: turborepo
  • Smart Contract Development: hardhat
    • Deploy & Address-Export: hardhat-deploy
    • Typescript-Types: typechain
  • Frontend: next
    • Contract Interactions: wagmi, rainbowkit
    • Styling: chakra, tailwindcss, twin.macro, emotion
  • Miscellaneous:
    • Linting & Formatting: eslint, prettier, husky, lint-staged