Skip to content

Latest commit

 

History

History
86 lines (55 loc) · 5.58 KB

README.md

File metadata and controls

86 lines (55 loc) · 5.58 KB

UniswapX

Integration Tests Unit Tests

UniswapX is an ERC20 swap settlement protocol that provides swappers with a gasless experience, MEV protection, and access to arbitrary liquidity sources. Swappers generate signed orders which specify the specification of their swap, and fillers compete using arbitrary fill strategies to satisfy these orders.

UniswapX Protocol Architecture

Architecture

Reactors

Order Reactors settle UniswapX orders. They are responsible for validating orders of a specific type, resolving them into inputs and outputs, and executing them against the filler's strategy, and verifying that the order was successfully fulfilled.

Reactors process orders using the following steps:

  • Validate the order
  • Resolve the order into inputs and outputs
  • Pull input tokens from the swapper to the fillContract using permit2 permitWitnessTransferFrom with the order as witness
  • Call reactorCallback on the fillContract
  • Transfer output tokens from the fillContract to the output recipients

Reactors implement the IReactor interface which abstracts the specifics of the order specification. This allows for different reactor implementations with different order formats to be used with the same interface, allowing for shared infrastructure and easy extension by fillers.

Current reactor implementations:

Fill Contracts

Order fillContracts fill UniswapX orders. They specify the filler's strategy for fulfilling orders and are called by the reactor with reactorCallback when using executeWithCallback or executeBatchWithCallback.

Some sample fillContract implementations are provided in this repository:

  • SwapRouter02Executor: A fillContract that uses UniswapV2 and UniswapV3 via the SwapRouter02 router

Direct Fill

If a filler wants to simply fill orders using funds held by an address rather than using a fillContract strategy, they can do so gas efficiently by using execute or executeBatch. These functions cause the reactor to skip the reactorCallback and simply pull tokens from the filler using msg.sender.

Integrating with UniswapX

Jump to the docs for Creating a Filler Integration.

Deployment Addresses

Contract Address Source
Exclusive Dutch Order Reactor 0x6000da47483062A0D734Ba3dc7576Ce6A0B645C4 ExclusiveDutchOrderReactor
OrderQuoter 0x54539967a06Fc0E3C3ED0ee320Eb67362D13C5fF OrderQuoter
Permit2 0x000000000022D473030F116dDEE9F6B43aC78BA3 Permit2

Usage

# install dependencies
forge install

# compile contracts
forge build

# run unit tests
forge test

# run integration tests
FOUNDRY_PROFILE=integration forge test

Fee-on-Transfer Disclaimer

Note that UniswapX handles fee-on-transfer tokens by transferring the amount specified to the recipient. This means that the actual amount received by the recipient will be after fees.

Version Log

Version Number Commit Contract Address
1.0 597cf617dd6d32b3f181edbc37aed11bc5648d93 Contract no longer in use. Read more about the bug here.
1.1 cf53fc7dd48029a9189d26812d676a4ea9d08d6c 0x6000da47483062A0D734Ba3dc7576Ce6A0B645C4

Audit

This codebase was audited by ABDK and OpenZeppelin.

Bug Bounty

This repository is subject to the Uniswap Labs Bug Bounty program, per the terms defined here.