0.0.1 • Published 2 years ago
candle-protocols v0.0.1
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
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 |
|---|---|---|
@candlelabs/swap |  | Atomic Token Swap |
@candlelabs/registry |  | Counterparty Discovery |
@candlelabs/staking |  | Staking for Members |
@candlelabs/pool |  | Rewards Pool for Members |
@candlelabs/converter |  | Converter for Fee Tokens |
JavaScript Libraries
| Package | Version | Description |
|---|---|---|
@candlelabs/libraries |  | Protocol Client Libraries |
@candlelabs/utils |  | Orders and Signatures |
@candlelabs/metadata |  | Token Metadata |
@candlelabs/constants |  | Helpful Constants |
@candlelabs/typescript |  | TypeScript Types |
@candlelabs/merkle |  | 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
0.0.1
2 years ago