Skip to content

Latest commit

 

History

History
51 lines (39 loc) · 4.53 KB

README.md

File metadata and controls

51 lines (39 loc) · 4.53 KB

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.

Discord License lerna Twitter Follow

Resources

Smart Contracts

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 build/contracts within the package.

Package Version Description
@airswap/swap npm Atomic Token Swap
@airswap/registry npm Counterparty Discovery
@airswap/staking npm Staking for Members
@airswap/pool npm Rewards Pool for Members
@airswap/converter npm Converter for Fee Tokens

JavaScript Libraries

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

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 hint Run a syntax linter for all Solidity code.
yarn lint Run a syntax linter for all JavaScript code.
yarn deps:check Run a dependency consistency check.

Deployments

To deploy, please follow this guide