Swap is a smart contract that trustlessly transfers tokens between parties.

Swap Client

Add the @airswap/protocols package to your application.

$ yarn add @airswap/protocols

Import the Swap client.

import { Swap } from '@airswap/protocols'

constructor

Create a new Swap client.

public constructor(
  chainId = chainIds.RINKEBY,
  walletOrProvider?: ethers.Wallet | ethers.providers.Provider
)

Basic Example

Create a client for the Rinkeby Indexer using the default provider.

const swap = new Swap()

Custom Provider Example

Create a client for the Mainnet Indexer using an INFURA provider.

import { chainIds } from '@airswap/constants'
const provider = new ethers.providers.InfuraProvider(...)
const swap = new Swap(chainIds.MAINNET, provider);

See a list of available providers on the ethers.js documentation.

swap

Perform a swap given an order.

public async swap(order: Order, wallet?: ethers.Wallet): Promise<string>

Example Get an order from a local development Server and execute a swap.

// Create a new ethers wallet
const wallet = new ethers.Wallet('...')
​
// Construct a new Server
const server = new Server('http://localhost:3000')
​
// Get an order from the Server
const order = await server.getSenderSideOrder(
  senderAmount,
  signerToken,
  senderToken,
  wallet.address,
)
​
// Swap the order on the Rinkeby swap contract
const hash = await new Swap().swap(order, wallet)

Solidity

Swap is a trustless peer-to-peer trade settlement contract. View the code on GitHub.

Features

Authorizations are for peers that trade on behalf of others. These peers are authorized by an individual to send or sign orders for them. Peers can be wallets (people or programs) or smart contracts.

Affiliates are third-parties compensated for their part in bringing together the two parties of a trade and can be other traders or software applications that connect traders on the network.

Functions

constructor

Create a new Swap contract.

constructor() public

swap

An atomic token swap between a signer and a sender.

function swap(
  Types.Order calldata order
) external

A successful swap emits a Swap event.

event Swap(
  uint256 indexed nonce,
  uint256 timestamp,
  address indexed signerWallet,
  uint256 signerAmount,
  uint256 signerId,
  address signerToken,
  address indexed senderWallet,
  uint256 senderAmount,
  uint256 senderId,
  address senderToken,
  address affiliateWallet,
  uint256 affiliateAmount,
  uint256 affiliateId,
  address affiliateToken
);

cancel

Provide an array of nonces, unique by signer address, to mark one or more orders as cancelled.

function cancel(
  uint256[] memory nonces
) external

A successful cancel emits one Cancel event per nonce.

event Cancel(
  uint256 indexed nonce,
  address indexed signerWallet
);

cancelUpTo

Provide a minimum value to cancel all nonces below the value. This is not inclusive - the minimumNonce value is still considered valid.

function cancelUpTo(
  uint256 minimumNonce
) external

A successful cancelUpTo emits an CancelUpTo event.

event CancelUpTo(
  uint256 indexed nonce,
  address indexed signerWallet
);

authorizeSender

Authorize another account or contract send orders on behalf of the caller.

function authorizeSender(
  address authorizedSender
) external

A successful authorizeSender emits an AuthorizeSender event.

event AuthorizeSender(
  address indexed authorizerAddress,
  address indexed authorizedSender
);

authorizeSigner

Authorize another account or contract to:

• Sign an order OR

• Submit an order without a signature

  on behalf of the function caller. This means the function caller is no longer required to sign such orders.

function authorizeSigner(
  address authorizedSigner
) external

A successful authorizeSigner emits an AuthorizeSigner event.

event AuthorizeSigner(
  address indexed authorizerAddress,
  address indexed authorizedSigner
);

revokeSender

Revoke the sending authorization of a Delegate account or contract.

function revokeSender(
  address authorizedSender
) external

A successful revokeSender emits a RevokeSender event.

event RevokeSender(
  address indexed authorizerAddress,
  address indexed revokedSender,
);

revokeSigner

Revoke the signing authorization of a Delegate account or contract.

function revokeSigner(
  address authorizedSigner
) external

A successful revokeSigner emits a RevokeSigner event.

event RevokeSigner(
  address indexed authorizerAddress,
  address indexed revokedSigner,
);