leppaludi / airswap-protocols

AirSwap Contracts and Tools

AirSwap is a peer-to-peer trading network for Ethereum tokens, initially built on the Swap Protocol. This repository contains smart contracts and JavaScript packages for use by developers and traders on the AirSwap network.

Resources

• About → https://about.airswap.io/
• Website → https://www.airswap.io/
• Twitter → https://twitter.com/airswap
• Chat → https://chat.airswap.io/

Smart Contracts

Package	Version	Description
@airswap/swap		Atomic Token Swap
@airswap/swap-erc20		Atomic Token Swap (ERC20)
@airswap/maker-registry		Maker Discovery
@airswap/indexer-registry		Indexer Discovery
@airswap/staking		Staking for Participants
@airswap/pool		Rewards Pool for Participants

JavaScript Libraries

Package	Version	Description
@airswap/libraries		Protocol Client Libraries
@airswap/utils		Orders and Signatures
@airswap/metadata		Token Metadata
@airswap/constants		Helpful Constants
@airswap/typescript		TypeScript Types

Repository Commands

Command	Description
yarn compile	Compile all contracts to build folders.
yarn clean	Delete all contract build folders.
yarn test	Run all contract tests in test folders.
yarn lint:fix	Run eslint for all JavaScript code.
yarn pretty:fix	Run prettier for all JavaScript code.

Deploying Contracts

Each package in source has commands yarn deploy and yarn verify. Each command takes a --network flag. For example:

yarn deploy --network goerli
yarn verify --network goerli

The account used to deploy and verify is derived from the MNEMONIC environment variable in .env in the repository root. The source of these scripts can be found in the scripts folder of each package.