@airswap/market v0.2.0

Market

:warning: This package is under active development. Do not use in production.

AirSwap is a peer-to-peer trading network for Ethereum tokens. This package contains source code and tests for a Market that represents a list of intents to trade.

Features

Sorting

Intents are sorted by their amount, with the largest amount at the beginning of the list. Currently the staking amount is indicated by an Indexer that owns the Market.

Definitions

Intent Struct

An "intent to trade" is represented by the following Intent struct.

struct Intent {
  address staker;
  uint256 amount;
  address locator;
}

Constructor

Create a new Market contract. Usually called within the context of an Indexer contract.

constructor(
  address _makerToken,
  address _takerToken
) public

Params

Set an Intent

Set an intent to trade in the Market.

function setIntent(
  address _staker,
  uint256 _amount,
  address _locator
) external onlyOwner

Params

Unset an Intent

Unset an intent to trade in the Market.

function unsetIntent(
  address _staker
) public onlyOwner returns (bool)

Params

Get an Intent

Gets the intent for a given staker address.

function getIntent(
  address _staker
) public view returns (Intent memory)

Params

Has an Intent

Determines whether the Market has an intent for a staker address.

function hasIntent(
  address _staker
) internal view returns (bool)

Params

Fetch Intents

Fetch up to a number of intents from the list.

function fetchIntents(
  uint256 _count
) public view returns (address[] memory result)

Params

Find an Intent (By Value)

Find an intent by value in the list.

function findPosition(
  uint256 amount
) internal view returns (Intent memory)

Params

Insert an Intent

Insert an intent before an existing intent in the list.

function insertIntent(
  Intent memory _newIntent,
  Intent memory _nextIntent
) internal returns (bool)

Params

Link Two Intents

Link two intents in the list.

function link(
  Intent memory _left,
  Intent memory _right
) internal

Params