AirSwap is a peer-to-peer trading network for Ethereum tokens, initially built on the Swap Protocol. The AirSwap product family includes Explorer, DexIndex, AirSwap Instant, and AirSwap Trader. This repository contains smart contracts and JavaScript packages for use by developers and traders on the AirSwap network.
- Docs → https://docs.airswap.io/
- Website → https://www.airswap.io/
- Blog → https://blog.airswap.io/
- Support → https://support.airswap.io/
Packages are versioned based on deploys. Major versions e.g. 1.x.x
are mainnet deploys, while minor versions e.g. x.1.x
are rinkeby deploys. Packages that are not deployed increment patch versions e.g. x.x.1
. Each package that includes a deployment includes the ABI files for that deployed contract in builds/contracts
within the package.
Package | Version | Description |
---|---|---|
@airswap/swap |
Atomic Swap Between Tokens | |
@airswap/indexer |
Counterparty Discovery with Staking | |
@airswap/delegate |
Onchain Trading Delegate | |
@airswap/validator |
Validation and Pre-Swap Checks | |
@airswap/wrapper |
Use ether for WETH trades | |
@airswap/types |
Types and Hashes | |
@airswap/transfers |
Token Transfer Handlers | |
@airswap/tokens |
Ethereum Tokens |
Package | Version | Description |
---|---|---|
@airswap/protocols |
Protocol Clients | |
@airswap/utils |
Orders and Signatures | |
@airswap/metadata |
Metadata Management | |
@airswap/constants |
Helpful Constants |
Command | Description |
---|---|
yarn compile |
Compile all contracts to build folders. |
yarn clean |
Delete all contract build folders. |
yarn ganache |
Run a local ganache network on local host 8545. |
yarn test |
Run all contract tests in test folders. Run yarn ganache elsewhere first. |
yarn hint |
Run a syntax linter for all Solidity code. |
yarn lint |
Run a syntax linter for all JavaScript code. |
yarn deps |
Run a dependency consistency check. |
To deploy, please follow this guide