The following APIs are implemented by peers on the network to make and take liquidity.

RFQ API

Orders

Orders are priced and executable swaps that specify all parties of a trade.

getSenderSideOrder

Given a signerAmount, senderWallet, and token pair, return a complete order. The senderAmount value is the amount the taker would send. The taker is buying from you.

getSenderSideOrder(
  signerAmount: string,
  signerToken: string,
  senderToken: string,
  senderWallet: string,
  swapContract: string,
  proxyingFor: string,
)

Depending on the swapContract, a successful getSenderSideOrder returns a signed Order or a Light Order that includes the requested senderAmount.

getSignerSideOrder

Given a senderAmount, senderWallet, and token pair, return a complete order. The signerAmount value is the amount you would send. The taker is selling to you.

getSignerSideOrder(
  senderAmount: string,
  signerToken: string,
  senderToken: string,
  senderWallet: string,
  swapContract: string,
  proxyingFor: string,
)

Depending on the value set as swapContract a successful getSignerSideOrder returns a signed Order or a Light Order including the requested signerAmount.

Quotes

Quotes indicate prices at which a peer is interested in trading.

getMaxQuote

Given a token pair, return a quote object with the maximum amounts a maker is willing to trade.

getMaxQuote(
  signerToken: string,
  senderToken: string
): Quote

A successful getMaxQuote returns a Quote object.

getSenderSideQuote

Given a signerAmount and token pair, return a complete quote. The senderAmount value is the amount the taker would send. The taker is buying from the maker.

getSenderSideQuote(
  signerAmount: string,
  signerToken: string,
  senderToken: string
): Quote

A successful getSenderSideQuote returns a Quote object including the requested senderAmount.

getSignerSideQuote

Given a senderAmount and token pair, return a complete quote. The signerAmount value is the amount the maker would send. The taker is selling to the maker.

getSignerSideQuote(
  senderAmount: string,
  senderToken: string,
  signerToken: string
): Quote

A successful getSignerSideQuote returns a Quote object including the requested signerAmount

Last Look API

Last look is to say that, after having emitted an indicative quote, a maker may accept or decline an order provided to it by a taker. Quotes are primarily served through the Quote API, but other methods to disseminate pricing information may exist, for example SetRule events on Delegate contracts.

provideOrder

Given an Order, assess its price, and conditionally perform a swap.

provideOrder((order: Order))