glitterblondie / airswap-protocols

Smart Contracts and Tools for Developers on the AirSwap Network

Home Page:https://www.airswap.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool



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.

Discord License lerna CircleCI 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 builds/contracts within the package.

Package Version Description
@airswap/swap npm Atomic Swap Between Tokens
@airswap/indexer npm Counterparty Discovery with Staking
@airswap/delegate npm Onchain Trading Delegate
@airswap/validator npm Validation and Pre-Swap Checks
@airswap/wrapper npm Use ether for WETH trades
@airswap/types npm Types and Hashes
@airswap/transfers npm Token Transfer Handlers
@airswap/tokens npm Ethereum Tokens

JavaScript Libraries

Package Version Description
@airswap/protocols npm Protocol Clients
@airswap/utils npm Orders and Signatures
@airswap/metadata npm Metadata Management
@airswap/constants npm Helpful Constants

Commands

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.

Deployments

To deploy, please follow this guide

About

Smart Contracts and Tools for Developers on the AirSwap Network

https://www.airswap.io

License:Other


Languages

Language:JavaScript 56.2%Language:Solidity 29.5%Language:TypeScript 13.6%Language:Python 0.6%Language:Shell 0.1%